Message

A MIME Message object.

class Message : ObjectWrap {}

Constructors

this
this(void* ptr, Flag!"Take" take)
this
this(bool prettyHeaders)

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).

Members

Functions

addMailbox
void addMailbox(gmime.types.AddressType type, string name, string addr)

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

foreach_
void foreach_(gmime.types.ObjectForeachFunc callback)

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

getAddresses
gmime.internet_address_list.InternetAddressList getAddresses(gmime.types.AddressType type)

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

getAllRecipients
gmime.internet_address_list.InternetAddressList getAllRecipients()

Gets the complete list of recipients for message.

getAutocryptGossipHeaders
gmime.autocrypt_header_list.AutocryptHeaderList getAutocryptGossipHeaders(glib.date_time.DateTime now, gmime.types.DecryptFlags flags, string sessionKey)

Creates a new #GMimeAutocryptHeaderList of relevant headers of the given type based on the recipient(s) of an e-mail message.

getAutocryptGossipHeadersFromInnerPart
gmime.autocrypt_header_list.AutocryptHeaderList getAutocryptGossipHeadersFromInnerPart(glib.date_time.DateTime now, gmime.object.ObjectWrap innerPart)

Creates a new #GMimeAutocryptHeaderList of relevant headers of the given type based on the recipient(s) of an e-mail message.

getAutocryptHeader
gmime.autocrypt_header.AutocryptHeader getAutocryptHeader(glib.date_time.DateTime now)

Creates a new #GMimeAutocryptHeader based on the relevant Autocrypt header associated with the sender of an e-mail message.

getBcc
gmime.internet_address_list.InternetAddressList getBcc()

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

getBody
gmime.object.ObjectWrap getBody()

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

getCc
gmime.internet_address_list.InternetAddressList getCc()

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

getDate
glib.date_time.DateTime getDate()

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

getFrom
gmime.internet_address_list.InternetAddressList getFrom()

Gets the parsed list of addresses in the From header.

getMessageId
string getMessageId()

Gets the Message-Id header of message.

getMimePart
gmime.object.ObjectWrap getMimePart()

Gets the toplevel MIME part contained within message.

getReplyTo
gmime.internet_address_list.InternetAddressList getReplyTo()

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

getSender
gmime.internet_address_list.InternetAddressList getSender()

Gets the parsed list of addresses in the Sender header.

getSubject
string getSubject()

Gets the subject of the message.

getTo
gmime.internet_address_list.InternetAddressList getTo()

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

partialSplitMessage
gmime.message.Message[] partialSplitMessage(size_t maxSize)

Splits message into an array of #GMimeMessage objects each containing a single #GMimeMessagePartial object containing max_size bytes or fewer. nparts is set to the number of #GMimeMessagePartial objects created.

self
Message self()

Returns this, for use in with statements.

setDate
void setDate(glib.date_time.DateTime date)

Sets the Date header on a MIME Message.

setMessageId
void setMessageId(string messageId)

Set the Message-Id on a message.

setMimePart
void setMimePart(gmime.object.ObjectWrap mimePart)

Set the root-level MIME part of the message.

setSubject
void setSubject(string subject, string charset)

Set the subject of a message.

Properties

_gType
GType _gType [@property getter]

Static functions

_getGType
GType _getGType()
builder
MessageGidBuilder builder()

Get builder for gmime.message.Message

Inherited Members

From ObjectWrap

_getGType
GType _getGType()
_gType
GType _gType [@property getter]
self
ObjectWrap self()

Returns this, for use in with statements.

builder
ObjectWrapGidBuilder builder()

Get builder for gmime.object.ObjectWrap

newType
gmime.object.ObjectWrap newType(gmime.parser_options.ParserOptions options, string type, string subtype)

Performs a lookup of registered #GMimeObject subclasses, registered using gmime.object.ObjectWrap.registerType, to find an appropriate class capable of handling MIME parts of type type/subtype. If no class has been registered to handle that type, it looks for a registered class that can handle type. If that also fails, then it will use the generic part class, #GMimePart.

registerType
void registerType(string type, string subtype, gobject.types.GType objectType)

Registers the object type object_type for use with the gmime.object.ObjectWrap.newType convenience function.

typeRegistryInit
void typeRegistryInit()
typeRegistryShutdown
void typeRegistryShutdown()
appendHeader
void appendHeader(string header, string value, string charset)

Appends a new header to the header list.

encode
void encode(gmime.types.EncodingConstraint constraint)

Calculates and sets the most efficient Content-Transfer-Encoding for this #GMimeObject and all child parts based on the constraint provided.

getAutocryptHeaders
gmime.autocrypt_header_list.AutocryptHeaderList getAutocryptHeaders(glib.date_time.DateTime effectiveDate, string matchheader, gmime.internet_address_list.InternetAddressList addresses, bool keepIncomplete)

Creates a new #GMimeAutocryptHeaderList of relevant headers of the given type based on the addresses of an mime_part.

getContentDisposition
gmime.content_disposition.ContentDisposition getContentDisposition()

Gets the #GMimeContentDisposition for the specified MIME object.

getContentDispositionParameter
string getContentDispositionParameter(string name)

Gets the value of the Content-Disposition parameter specified by name, or null if the parameter does not exist.

getContentId
string getContentId()

Gets the Content-Id of the MIME object or NULL if one is not set.

getContentType
gmime.content_type.ContentType getContentType()

Gets the #GMimeContentType object for the given MIME object or null on fail.

getContentTypeParameter
string getContentTypeParameter(string name)

Gets the value of the content-type param name set on the MIME part object.

getDisposition
string getDisposition()

Gets the MIME object's disposition if set or null otherwise.

getHeader
string getHeader(string header)

Gets the value of the first header with the specified name.

getHeaderList
gmime.header_list.HeaderList getHeaderList()

Get the header list for object.

getHeaders
string getHeaders(gmime.format_options.FormatOptions options)

Allocates a string buffer containing all of the MIME object's raw headers.

prependHeader
void prependHeader(string header, string value, string charset)

Prepends a new header to the header list.

removeHeader
bool removeHeader(string header)

Removed the specified header if it exists.

setContentDisposition
void setContentDisposition(gmime.content_disposition.ContentDisposition disposition)

Set the content disposition for the specified mime part and then serializes it to the Content-Disposition header field.

setContentDispositionParameter
void setContentDispositionParameter(string name, string value)

Add a content-disposition parameter to the specified mime part.

setContentId
void setContentId(string contentId)

Sets the Content-Id of the MIME object.

setContentType
void setContentType(gmime.content_type.ContentType contentType)

Sets the content-type for the specified MIME object and then serializes it to the Content-Type header field.

setContentTypeParameter
void setContentTypeParameter(string name, string value)

Sets the content-type param name to the value value.

setDisposition
void setDisposition(string disposition)

Sets the disposition to disposition which may be one of #GMIME_DISPOSITION_ATTACHMENT or #GMIME_DISPOSITION_INLINE or, by your choice, any other string which would indicate how the MIME part should be displayed by the MUA.

setHeader
void setHeader(string header, string value, string charset)

Sets a header to the specified value.

toString_
string toString_(gmime.format_options.FormatOptions options)

Allocates a string buffer containing the contents of object.

writeContentToStream
ptrdiff_t writeContentToStream(gmime.format_options.FormatOptions options, gmime.stream.Stream stream)

Write only the content of the MIME object to stream.

writeToStream
ptrdiff_t writeToStream(gmime.format_options.FormatOptions options, gmime.stream.Stream stream)

Write the headers and content of the MIME object to stream.