![]() |
![]() |
![]() |
Camel Reference Manual | ![]() |
---|---|---|---|---|
struct CamelMimeMessage; #define CAMEL_RECIPIENT_TYPE_TO #define CAMEL_RECIPIENT_TYPE_CC #define CAMEL_RECIPIENT_TYPE_BCC #define CAMEL_RECIPIENT_TYPE_RESENT_TO #define CAMEL_RECIPIENT_TYPE_RESENT_CC #define CAMEL_RECIPIENT_TYPE_RESENT_BCC #define CAMEL_MESSAGE_DATE_CURRENT CamelMimeMessage* camel_mime_message_new (void); void camel_mime_message_set_date (CamelMimeMessage *message, time_t date, int offset); time_t camel_mime_message_get_date (CamelMimeMessage *message, int *offset); time_t camel_mime_message_get_date_received (CamelMimeMessage *message, int *offset); void camel_mime_message_set_message_id (CamelMimeMessage *message, const char *message_id); const char* camel_mime_message_get_message_id (CamelMimeMessage *message); void camel_mime_message_set_reply_to (CamelMimeMessage *message, const CamelInternetAddress *reply_to); const CamelInternetAddress* camel_mime_message_get_reply_to (CamelMimeMessage *message); void camel_mime_message_set_subject (CamelMimeMessage *message, const char *subject); const char* camel_mime_message_get_subject (CamelMimeMessage *message); void camel_mime_message_set_from (CamelMimeMessage *message, const CamelInternetAddress *from); const CamelInternetAddress* camel_mime_message_get_from (CamelMimeMessage *message); const CamelInternetAddress* camel_mime_message_get_recipients (CamelMimeMessage *message, const char *type); void camel_mime_message_set_recipients (CamelMimeMessage *message, const char *type, const CamelInternetAddress *recipients); void camel_mime_message_set_source (CamelMimeMessage *message, const char *identity); const char* camel_mime_message_get_source (CamelMimeMessage *message); gboolean camel_mime_message_has_8bit_parts (CamelMimeMessage *message); void camel_mime_message_set_best_encoding (CamelMimeMessage *message, CamelBestencRequired required, CamelBestencEncoding enctype); void camel_mime_message_encode_8bit_parts (CamelMimeMessage *message); CamelMimePart* camel_mime_message_get_part_by_content_id (CamelMimeMessage *message, const char *content_id); char* camel_mime_message_build_mbox_from (CamelMimeMessage *message); void camel_mime_message_dump (CamelMimeMessage *msg, int body);
struct CamelMimeMessage { CamelMimePart parent_object; /* header fields */ time_t date; int date_offset; /* GMT offset */ /* cached internal copy */ time_t date_received; int date_received_offset; /* GMT offset */ char *subject; char *message_id; CamelInternetAddress *reply_to; CamelInternetAddress *from; GHashTable *recipients; /* hash table of CamelInternetAddress's */ };
CamelMimeMessage* camel_mime_message_new (void);
Create a new CamelMimeMessage object.
Returns : |
a new CamelMimeMessage object |
void camel_mime_message_set_date (CamelMimeMessage *message, time_t date, int offset);
Set the date on a message.
|
a CamelMimeMessage object |
|
a time_t date |
|
an offset from GMT |
time_t camel_mime_message_get_date (CamelMimeMessage *message, int *offset);
Get the date and GMT offset of a message.
|
a CamelMimeMessage object |
|
output for the GMT offset |
Returns : |
the date of the message |
time_t camel_mime_message_get_date_received (CamelMimeMessage *message, int *offset);
Get the received date and GMT offset of a message.
|
a CamelMimeMessage object |
|
output for the GMT offset |
Returns : |
the received date of the message |
void camel_mime_message_set_message_id (CamelMimeMessage *message, const char *message_id);
Set the message-id on a message.
|
a CamelMimeMessage object |
|
id of the message |
const char* camel_mime_message_get_message_id (CamelMimeMessage *message);
Get the message-id of a message.
|
a CamelMimeMessage object |
Returns : |
the message-id of a message |
void camel_mime_message_set_reply_to (CamelMimeMessage *message, const CamelInternetAddress *reply_to);
Set the Reply-To of a message.
|
a CamelMimeMessage object |
|
a CamelInternetAddress object |
const CamelInternetAddress* camel_mime_message_get_reply_to (CamelMimeMessage *message);
Get the Reply-To of a message.
|
a CamelMimeMessage object |
Returns : |
the Reply-Toa ddress of the message |
void camel_mime_message_set_subject (CamelMimeMessage *message, const char *subject);
Set the subject text of a message.
|
a CamelMimeMessage object |
|
UTF-8 message subject |
const char* camel_mime_message_get_subject (CamelMimeMessage *message);
Get the UTF-8 subject text of a message.
|
a CamelMimeMessage object |
Returns : |
the message subject |
void camel_mime_message_set_from (CamelMimeMessage *message, const CamelInternetAddress *from);
Set the from address of a message.
|
a CamelMimeMessage object |
|
a CamelInternetAddress object |
const CamelInternetAddress* camel_mime_message_get_from (CamelMimeMessage *message);
Get the from address of a message.
|
a CamelMimeMessage object |
Returns : |
the from address of the message |
const CamelInternetAddress* camel_mime_message_get_recipients (CamelMimeMessage *message, const char *type);
Get the message recipients of a specified type.
|
a CamelMimeMessage object |
|
recipient type |
Returns : |
the requested recipients |
void camel_mime_message_set_recipients (CamelMimeMessage *message, const char *type, const CamelInternetAddress *recipients);
Set the recipients of a message.
|
a CamelMimeMessage object |
|
recipient type (one of CAMEL_RECIPIENT_TYPE_TO, CAMEL_RECIPIENT_TYPE_CC, or CAMEL_RECIPIENT_TYPE_BCC) |
|
a CamelInternetAddress with the recipient addresses set |
void camel_mime_message_set_source (CamelMimeMessage *message, const char *identity);
|
|
|
const char* camel_mime_message_get_source (CamelMimeMessage *message);
|
|
Returns : |
gboolean camel_mime_message_has_8bit_parts (CamelMimeMessage *message);
Find out if a message contains 8bit or binary encoded parts.
|
a CamelMimeMessage object |
Returns : |
TRUE if the message contains 8bit parts or FALSE otherwise
|
void camel_mime_message_set_best_encoding (CamelMimeMessage *message, CamelBestencRequired required, CamelBestencEncoding enctype);
Re-encode all message parts to conform with the required encoding rules.
If enctype
is CAMEL_BESTENC_7BIT, then all parts will be re-encoded into
one of the 7bit transfer encodings. If enctype
is CAMEL_BESTENC_8bit, all
parts will be re-encoded to either a 7bit encoding or, if the part is 8bit
text, allowed to stay 8bit. If enctype
is CAMEL_BESTENC_BINARY, then binary
parts will be encoded as binary and 8bit textual parts will be encoded as 8bit.
|
a CamelMimeMessage object |
|
a bitwise ORing of CAMEL_BESTENC_GET_ENCODING and CAMEL_BESTENC_GET_CHARSET |
|
an encoding to enforce |
void camel_mime_message_encode_8bit_parts (CamelMimeMessage *message);
Encode all message parts to a suitable transfer encoding for transport (7bit clean).
|
a CamelMimeMessage object |
CamelMimePart* camel_mime_message_get_part_by_content_id (CamelMimeMessage *message, const char *content_id);
Get a MIME part by id from a message.
|
a CamelMimeMessage object |
|
content-id to search for |
Returns : |
the MIME part with the requested id or NULL if not found
|
char* camel_mime_message_build_mbox_from (CamelMimeMessage *message);
Build an MBox from-line from message
.
|
a CamelMimeMessage object |
Returns : |
an MBox from-line suitable for use in an mbox file |
void camel_mime_message_dump (CamelMimeMessage *msg, int body);
Dump information about the mime message to stdout.
If body is TRUE, then dump body content of the message as well (currently unimplemented).
|
|
|