# MIMEDirAttachment

## Name

MIMEDirAttachment -- vCard/iCalendar attachment object

## Synopsis

    #include <mimedir/mimedir-attachment.h>

                        MIMEDirAttachment;

    MIMEDirAttachment*  mimedir_attachment_new              (void);
    MIMEDirAttachment*  mimedir_attachment_new_from_attribute
                                                            (MIMEDirAttribute *attribute,
                                                             GError **error);
    gboolean            mimedir_attachment_read_from_attribute
                                                            (MIMEDirAttachment *attachment,
                                                             MIMEDirAttribute *attribute,
                                                             GError **error);
    MIMEDirAttribute*   mimedir_attachment_write_to_attribute
                                                            (MIMEDirAttachment *attachment);

## Description

## Details

### MIMEDirAttachment

    typedef struct {
    	GObject parent;

    	MIMEDirAttachmentPriv *priv;
    } MIMEDirAttachment;

### mimedir_attachment_new ()

    MIMEDirAttachment*  mimedir_attachment_new              (void);

Creates a new iCal attachment object.

Returns : | a new attachment object

### mimedir_attachment_new_from_attribute ()

    MIMEDirAttachment*  mimedir_attachment_new_from_attribute
                                                            (MIMEDirAttribute *attribute,
                                                             GError **error);

Creates a new attachment object and initializes it with values read from the supplied attribute object.

`attribute` : | a MIMEDirAttribute object
`error` : | error storage location or `NULL`
Returns : | a new MIMEDirAttachment object or `NULL` on error

### mimedir_attachment_read_from_attribute ()

    gboolean            mimedir_attachment_read_from_attribute
                                                            (MIMEDirAttachment *attachment,
                                                             MIMEDirAttribute *attribute,
                                                             GError **error);

Initializes `attachment` with data read from `attribute`.

`attachment` : | a MIMEDirAttachment object
`attribute` : | a MIMEDirAttribute object
`error` : | error storage location or `NULL`
Returns : | success indicator

### mimedir_attachment_write_to_attribute ()

    MIMEDirAttribute*   mimedir_attachment_write_to_attribute
                                                            (MIMEDirAttachment *attachment);

Write `attachment` to a newly allocated MIMEDirAttribute object. The returned object should be freed with `g_object_unref()`.

`attachment` : | a MIMEDirAttachment object
Returns : | A newly allocated MIMEDirAttribute object