|
Home · All Namespaces · All Classes · Grouped Classes · Modules · Functions | |
The QMailMessage class provides a convenient interface for working with messages. More...
#include <QMailMessage>
This class is under development and is subject to change.
Inherits QMailMessageMetaData and QMailMessagePartContainer.
The QMailMessage class provides a convenient interface for working with messages.
QMailMessage supports a number of types. These include telephony types such as SMS and MMS, and internet email messages as defined in RFC 2822 (Internet Message Format), and RFC 2045 (Format of Internet Message Bodies) through RFC 2049 (Conformance Criteria and Examples).
The most common way to use QMailMessage is to initialize it from raw data using QMailMessage::fromRfc2822().
A QMailMessage can also be constructed piece by piece using functions such as setMessageType(), setFrom(), setTo(), setSubject(), and setBody() or appendPart(). Convenience functions such as from()/setFrom() and date()/setDate() accept and return wrapper types, to simplify the exchange of correctly-formatted data. In some cases, however, it may be simpler for clients to get and set the content of header fields directly, using the headerField() and setHeaderField() functions inherited from QMailMessagePartContainer.
Messages can be added to the QMailStore, or retrieved from the store via their QMailMessageId identifier. The QMailMessage object also provides acces to any relevant meta data describing the message, using the functions inherited from QMailMessageMetaData.
A message may be serialized to a QDataStream, or returned as a QByteArray using toRfc2822().
See also QMailMessageMetaData, QMailMessagePart, QMailMessageBody, QMailStore, and QMailMessageId.
This enum type is used to describe the action that should be performed on each message attachment.
| Constant | Value | Description |
|---|---|---|
| QMailMessage::LinkToAttachments | 0 | Add a part to the message containing a link to the supplied attachment. If the document is removed, the message will no longer have access to the data. |
| QMailMessage::CopyAttachments | 1 | Add a part to the message containing a copy of the data in the supplied attachment. If the document is removed, the message will still contain the data. |
| QMailMessage::CopyAndDeleteAttachments | 2 | Add a part to the message containing a copy of the data in the supplied attachment, then delete the document from which the data was copied. |
This enum type is used to describe the format in which a message should be serialized.
| Constant | Value | Description |
|---|---|---|
| QMailMessage::HeaderOnlyFormat | 1 | Only the header portion of the message is serialized, to RFC 2822 form. |
| QMailMessage::StorageFormat | 2 | The message is serialized to RFC 2822 form, without attachments. |
| QMailMessage::TransmissionFormat | 3 | The entire message is serialized to RFC 2822 form, with additional header fields added if necessary, and 'bcc' header field omitted. |
| QMailMessage::IdentityFormat | 4 | The entire message is serialized to RFC 2822 form, with only Content-Type and Content-Transfer-Encoding headers added where required. |
Constructs an empty message object.
Constructs a message object from data stored in the message store with QMailMessageId id.
Constructs a message object from data stored in the message store with the unique identifier uid from the account with id accountId.
Returns a list of all the bcc (blind carbon copy) recipients specified for the message.
See also setBcc(), to(), cc(), and QMailAddress.
Returns a list of all the cc (carbon copy) recipients specified for the message.
See also setCc(), to(), bcc(), and QMailAddress.
Constructs a mail message from the RFC 2822 data contained in byteArray.
Constructs a mail message from the RFC 2822 data contained in the file fileName.
Returns true if there are any recipients (either To, CC or BCC addresses) defined for this message; otherwise returns false.
Returns the message ID specified by the RFC 2822 'In-Reply-To' field for the message, if present.
See also setInReplyTo().
Returns a list of all the recipients specified for the message, either as To, CC, or BCC addresses.
See also to(), cc(), bcc(), and hasRecipients().
Returns the address specified by the RFC 2822 'Reply-To' field for the message, if present.
See also setReplyTo().
Set the list of bcc (blind carbon copy) recipients for the message to bccList.
See also bcc(), setTo(), and setCc().
Set the list of cc (carbon copy) recipients for the message to ccList.
See also setTo() and setBcc().
Sets the RFC 2822 'In-Reply-To' field for the message to messageId.
See also inReplyTo().
Sets the RFC 2822 'Reply-To' address of the message to address.
See also replyTo().
Returns the message in RFC 2822 format. The encoded content will vary depending on the value of format.
This is an overloaded member function, provided for convenience.
Writes the message to the output stream out, in RFC 2822 format. The encoded content will vary depending on the value of format.
| Copyright © 2009 Trolltech | Trademarks | Qt Extended 4.4.3 |