| Camel Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | ||||
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);gint offsettime_t camel_mime_message_get_date (CamelMimeMessage *message,);gint *offsettime_t camel_mime_message_get_date_received (CamelMimeMessage *message,);gint *offsetvoid camel_mime_message_set_message_id (CamelMimeMessage *message,const); constgchar *message_idgchar * camel_mime_message_get_message_id (CamelMimeMessage *message);void camel_mime_message_set_reply_to (CamelMimeMessage *message,CamelInternetAddress *reply_to); CamelInternetAddress * camel_mime_message_get_reply_to (CamelMimeMessage *message);void camel_mime_message_set_subject (CamelMimeMessage *message,const); constgchar *subjectgchar * camel_mime_message_get_subject (CamelMimeMessage *message);void camel_mime_message_set_from (CamelMimeMessage *message,CamelInternetAddress *from); CamelInternetAddress * camel_mime_message_get_from (CamelMimeMessage *message); CamelInternetAddress * camel_mime_message_get_recipients (CamelMimeMessage *message,const);gchar *typevoid camel_mime_message_set_recipients (CamelMimeMessage *message,const,gchar *typeCamelInternetAddress *recipients);void camel_mime_message_set_source (CamelMimeMessage *message,const); constgchar *source_uidgchar * 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);gchar *content_idgchar * camel_mime_message_build_mbox_from (CamelMimeMessage *message);gboolean camel_mime_message_has_attachment (CamelMimeMessage *message);void camel_mime_message_dump (CamelMimeMessage *message,);gint bodygboolean camel_mime_message_build_preview (CamelMimePart *mime_part,CamelMessageInfo *info);
GObject +----CamelObject +----CamelDataWrapper +----CamelMedium +----CamelMimePart +----CamelMimeMessage
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);gint 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,);gint *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,);gint *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);gchar *message_id
Set the message-id on a message.
|
a CamelMimeMessage object |
|
id of the message |
constgchar * 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,CamelInternetAddress *reply_to);
Set the Reply-To of a message.
|
a CamelMimeMessage object |
|
a CamelInternetAddress object |
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);gchar *subject
Set the subject text of a message.
|
a CamelMimeMessage object |
|
UTF-8 message subject |
constgchar * 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,CamelInternetAddress *from);
Set the from address of a message.
|
a CamelMimeMessage object |
|
a CamelInternetAddress object |
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 |
CamelInternetAddress * camel_mime_message_get_recipients (CamelMimeMessage *message,const);gchar *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,gchar *typeCamelInternetAddress *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);gchar *source_uid
constgchar * camel_mime_message_get_source (CamelMimeMessage *message);
gboolean camel_mime_message_has_8bit_parts (CamelMimeMessage *message);
Find out if a message contains 8bit or binary encoded parts.
|
a CamelMimeMessage object |
Returns : |
TRUEFALSE |
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 enctype is enctype is
|
a CamelMimeMessage object |
|
a bitwise ORing of |
|
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);gchar *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 |
gchar * 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 |
gboolean camel_mime_message_has_attachment (CamelMimeMessage *message);
|
a CamelMimeMessage object |
Returns : |
whether message contains at least one attachment part. |
Since 2.28
void camel_mime_message_dump (CamelMimeMessage *message,);gint body
Dump information about the mime message to stdout.
If body is TRUE, then dump body content of the message as well (currently unimplemented).
gboolean camel_mime_message_build_preview (CamelMimePart *mime_part,CamelMessageInfo *info);
This function blocks like crazy.
Since 2.28