![]() |
![]() |
![]() |
Camel Reference Manual | ![]() |
---|---|---|---|---|
struct CamelMultipart; CamelMultipart* camel_multipart_new (void); void camel_multipart_add_part (CamelMultipart *multipart, CamelMimePart *part); void camel_multipart_add_part_at (CamelMultipart *multipart, CamelMimePart *part, guint index); void camel_multipart_remove_part (CamelMultipart *multipart, CamelMimePart *part); CamelMimePart* camel_multipart_remove_part_at (CamelMultipart *multipart, guint index); CamelMimePart* camel_multipart_get_part (CamelMultipart *multipart, guint index); guint camel_multipart_get_number (CamelMultipart *multipart); void camel_multipart_set_boundary (CamelMultipart *multipart, const char *boundary); const char* camel_multipart_get_boundary (CamelMultipart *multipart); void camel_multipart_set_preface (CamelMultipart *multipart, const char *preface); void camel_multipart_set_postface (CamelMultipart *multipart, const char *postface); int camel_multipart_construct_from_parser (CamelMultipart *multipart, struct _CamelMimeParser *parser);
struct CamelMultipart { CamelDataWrapper parent_object; GList *parts; gchar *preface; gchar *postface; };
CamelMultipart* camel_multipart_new (void);
Create a new CamelMultipart object.
Returns : |
a new CamelMultipart object |
void camel_multipart_add_part (CamelMultipart *multipart, CamelMimePart *part);
Appends the part to the multipart object.
|
a CamelMultipart object |
|
a CamelMimePart to add |
void camel_multipart_add_part_at (CamelMultipart *multipart, CamelMimePart *part, guint index);
Adds the part to the multipart object after the index
'th
element. If index
is greater than the number of parts, it is
equivalent to camel_multipart_add_part.
|
a CamelMultipart object |
|
a CamelMimePart to add |
|
index to add the multipart at |
void camel_multipart_remove_part (CamelMultipart *multipart, CamelMimePart *part);
Removes part
from multipart
.
|
a CamelMultipart object |
|
a CamelMimePart to remove |
CamelMimePart* camel_multipart_remove_part_at (CamelMultipart *multipart, guint index);
Remove the indicated part from the multipart object.
|
a CamelMultipart object |
|
a zero-based index indicating the part to remove |
Returns : |
the removed part. Note that it is camel_object_unref'ed before being returned, which may cause it to be destroyed. |
CamelMimePart* camel_multipart_get_part (CamelMultipart *multipart, guint index);
|
a CamelMultipart object |
|
a zero-based index indicating the part to get |
Returns : |
the indicated subpart, or NULL
|
guint camel_multipart_get_number (CamelMultipart *multipart);
|
a CamelMultipart object |
Returns : |
the number of subparts in multipart
|
void camel_multipart_set_boundary (CamelMultipart *multipart, const char *boundary);
Sets the message boundary for multipart
to boundary
. This should
be a string which does not occur anywhere in any of multipart
's
subparts. If boundary
is NULL
, a randomly-generated boundary will
be used.
|
a CamelMultipart object |
|
the message boundary, or NULL
|
const char* camel_multipart_get_boundary (CamelMultipart *multipart);
|
a CamelMultipart object |
Returns : |
the boundary |
void camel_multipart_set_preface (CamelMultipart *multipart, const char *preface);
Set the preface text for this multipart. Will be written out infront of the multipart. This text should only include US-ASCII strings, and be relatively short, and will be ignored by any MIME mail client.
|
a CamelMultipart object |
|
the multipart preface |
void camel_multipart_set_postface (CamelMultipart *multipart, const char *postface);
Set the postfix text for this multipart. Will be written out after the last boundary of the multipart, and ignored by any MIME mail client.
Generally postface texts should not be sent with multipart messages.
|
a CamelMultipart object |
|
multipat postface |
int camel_multipart_construct_from_parser (CamelMultipart *multipart, struct _CamelMimeParser *parser);
Construct a multipart from a parser.
|
a CamelMultipart object |
|
a CamelMimeParser object |
Returns : |
0 on success or -1 on fail
|