GMimeMessage

GMimeMessage — Messages

Functions

Types and Values

Object Hierarchy

    GObject
    ╰── GMimeObject
        ╰── GMimeMessage

Description

A GMimeMessage represents an rfc822 message.

Functions

g_mime_message_new ()

GMimeMessage *
g_mime_message_new (gboolean pretty_headers);

If pretty_headers is TRUE, then the standard rfc822 headers are initialized so as to put headers in a nice friendly order. This is strictly a cosmetic thing, so if you are unsure, it is safe to say no (FALSE).

Parameters

pretty_headers

make pretty headers

 

Returns

an empty GMimeMessage object.


g_mime_message_get_sender ()

InternetAddressList *
g_mime_message_get_sender (GMimeMessage *message);

Gets the parsed list of addresses in the Sender header.

Parameters

message

A GMimeMessage

 

Returns

the parsed list of addresses in the Sender header.

[transfer none]


g_mime_message_get_from ()

InternetAddressList *
g_mime_message_get_from (GMimeMessage *message);

Gets the parsed list of addresses in the From header.

Parameters

message

A GMimeMessage

 

Returns

the parsed list of addresses in the From header.

[transfer none]


g_mime_message_get_reply_to ()

InternetAddressList *
g_mime_message_get_reply_to (GMimeMessage *message);

Gets the parsed list of addresses in the Reply-To header.

Parameters

message

A GMimeMessage

 

Returns

the parsed list of addresses in the Reply-To header.

[transfer none]


g_mime_message_get_to ()

InternetAddressList *
g_mime_message_get_to (GMimeMessage *message);

Gets combined list of parsed addresses in the To header(s).

Parameters

message

A GMimeMessage

 

Returns

the parsed list of addresses in the To header(s).

[transfer none]


g_mime_message_get_cc ()

InternetAddressList *
g_mime_message_get_cc (GMimeMessage *message);

Gets combined list of parsed addresses in the Cc header(s).

Parameters

message

A GMimeMessage

 

Returns

the parsed list of addresses in the Cc header(s).

[transfer none]


g_mime_message_get_bcc ()

InternetAddressList *
g_mime_message_get_bcc (GMimeMessage *message);

Gets combined list of parsed addresses in the Bcc header(s).

Parameters

message

A GMimeMessage

 

Returns

the parsed list of addresses in the Bcc header(s).

[transfer none]


g_mime_message_add_mailbox ()

void
g_mime_message_add_mailbox (GMimeMessage *message,
                            GMimeAddressType type,
                            const char *name,
                            const char *addr);

Add a mailbox of a chosen type to the MIME message.

Note: The name (and addr ) strings should be in UTF-8.

Parameters

message

A GMimeMessage

 

type

A GMimeAddressType

 

name

The name of the mailbox (or NULL)

 

addr

The address of the mailbox

 

g_mime_message_get_addresses ()

InternetAddressList *
g_mime_message_get_addresses (GMimeMessage *message,
                              GMimeAddressType type);

Gets a list of addresses of the specified type from the message .

Parameters

message

A GMimeMessage

 

type

A GMimeAddressType

 

Returns

a list of addresses of the specified type from the message .

[transfer none]


g_mime_message_get_all_recipients ()

InternetAddressList *
g_mime_message_get_all_recipients (GMimeMessage *message);

Gets the complete list of recipients for message .

Parameters

message

A GMimeMessage

 

Returns

a newly allocated InternetAddressList containing all recipients of the message or NULL if no recipients are set.

[transfer full]


g_mime_message_set_subject ()

void
g_mime_message_set_subject (GMimeMessage *message,
                            const char *subject,
                            const char *charset);

Set the subject of a message .

Note: The subject string should be in UTF-8.

Parameters

message

A GMimeMessage

 

subject

Subject string

 

charset

The charset to use for encoding the subject or NULL to use the default

 

g_mime_message_get_subject ()

const char *
g_mime_message_get_subject (GMimeMessage *message);

Gets the subject of the message .

Parameters

message

A GMimeMessage

 

Returns

the subject of the message in a form suitable for display or NULL if no subject is set. If not NULL, the returned string will be in UTF-8.


g_mime_message_set_date ()

void
g_mime_message_set_date (GMimeMessage *message,
                         GDateTime *date);

Sets the Date header on a MIME Message.

Parameters

message

A GMimeMessage

 

date

a date to be used in the Date header

 

g_mime_message_get_date ()

GDateTime *
g_mime_message_get_date (GMimeMessage *message);

Gets the parsed date and time value from the Date header.

Parameters

message

A GMimeMessage

 

Returns

a GDateTime on success or NULL if the date could not be parsed.


g_mime_message_set_message_id ()

void
g_mime_message_set_message_id (GMimeMessage *message,
                               const char *message_id);

Set the Message-Id on a message.

Parameters

message

A GMimeMessage

 

message_id

message-id (addr-spec portion)

 

g_mime_message_get_message_id ()

const char *
g_mime_message_get_message_id (GMimeMessage *message);

Gets the Message-Id header of message .

Parameters

message

A GMimeMessage

 

Returns

the Message-Id of a message.


g_mime_message_set_mime_part ()

void
g_mime_message_set_mime_part (GMimeMessage *message,
                              GMimeObject *mime_part);

Set the root-level MIME part of the message.

Parameters

message

A GMimeMessage

 

mime_part

The root-level MIME Part

 

g_mime_message_get_mime_part ()

GMimeObject *
g_mime_message_get_mime_part (GMimeMessage *message);

Gets the toplevel MIME part contained within message .

Parameters

message

A GMimeMessage

 

Returns

the toplevel MIME part of message .

[transfer none]


g_mime_message_foreach ()

void
g_mime_message_foreach (GMimeMessage *message,
                        GMimeObjectForeachFunc callback,
                        gpointer user_data);

Recursively calls callback on each of the mime parts in the mime message.

Parameters

message

A GMimeMessage

 

callback

function to call on each of the mime parts contained by the mime message.

[scope call]

user_data

user-supplied callback data

 

g_mime_message_get_body ()

GMimeObject *
g_mime_message_get_body (GMimeMessage *message);

Attempts to identify the MIME part containing the body of the message.

Parameters

message

A GMimeMessage

 

Returns

a GMimeObject containing the textual content that appears to be the main body of the message.

Note: This function is NOT guaranteed to always work as it makes some assumptions that are not necessarily true. It is recommended that you traverse the MIME structure yourself.

[transfer none]

Types and Values

enum GMimeAddressType

An address type.

Members

GMIME_ADDRESS_TYPE_SENDER

Represents the addresses in the Sender header.

 

GMIME_ADDRESS_TYPE_FROM

Represents the addresses in the From header.

 

GMIME_ADDRESS_TYPE_REPLY_TO

Represents the addresses in the Reply-To header.

 

GMIME_ADDRESS_TYPE_TO

Represents the recipients in the To header.

 

GMIME_ADDRESS_TYPE_CC

Represents the recipients in the Cc header.

 

GMIME_ADDRESS_TYPE_BCC

Represents the recipients in the Bcc header.

 

struct GMimeMessage

struct GMimeMessage;

A MIME Message object.

Members