|
Home · All Classes · Grouped Classes · Annotated · 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 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.
A message may be serialized to a QDataStream, or returned as a QByteArray using toRfc2822().
Messages can be added to the QMailStore, or retrieved from the store via their QMailId identifier.
See also QMailMessagePart, QMailMessageBody, QMailStore, and QMailId.
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. |
| QMailMessage::SerializationFormat | 5 | The entire message is serialized to RFC 2822 form for internal use only. |
This enum type is used to describe the data to be loaded from the message store when constructing a QMailMessage.
| Constant | Value | Description |
|---|---|---|
| QMailMessage::Header | 0 | Load the message header data only. |
| QMailMessage::HeaderAndBody | 1 | Load the message header data and body data. |
This enum type is used to describe the state and type of a message.
| Constant | Value | Description |
|---|---|---|
| QMailMessage::Incoming | 0x0001 | The message is in incoming message retrieved from the network. |
| QMailMessage::Outgoing | 0x0002 | The message is an outgoing message intended to be delivered over the network. |
| QMailMessage::Sent | 0x0004 | The message has been delivered over the network. |
| QMailMessage::Replied | 0x0008 | A message replying to the author of this message has been created. |
| QMailMessage::RepliedAll | 0x0010 | A new message replying to the author and all the recipients of the message other than the user has been created. |
| QMailMessage::Forwarded | 0x0020 | A forwarded version of the message has been created. |
| QMailMessage::Downloaded | 0x0040 | The message is completed, it is not a partial message where some data has not been retrieved from the originating server. |
| QMailMessage::Read | 0x0080 | The message has been marked as read by the user. |
| QMailMessage::Removed | 0x0100 | The message has been deleted from or moved on the originating server. |
| QMailMessage::ReadElsewhere | 0x0200 | The message is not new, since the server has already reported its existence to some client. |
The Status type is a typedef for QFlags<MessageStatusFlag>. It stores an OR combination of MessageStatusFlag values.
This enum type is used to describe the type of a message.
| Constant | Value | Description |
|---|---|---|
| QMailMessage::Mms | 0x1 | The message is an MMS. |
| QMailMessage::Sms | 0x4 | The message is an SMS. |
| QMailMessage::Email | 0x8 | The message is an Email. |
| QMailMessage::System | 0x10 | The message is a system report. |
| QMailMessage::None | 0 | Indicates no message type. |
| QMailMessage::AnyType | Mms | Sms | Email | System | Indicates any type of message. |
Constructs an empty message object.
Constructs a message object from data stored in the message store with QMailId id, and mail data selection defined by selection.
Constructs a message object from data stored in the message store with the unique identifier uid from the account account, and mail data selection defined by selection.
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.
Returns the timestamp contained in the origination date header field of the message, if present; otherwise returns an empty string.
See also setDate().
Returns the originating address of the message.
See also setFrom().
Returns the name of the originating account for the message.
See also setFromAccount().
Returns the name of the originating mailbox for the message.
See also setFromMailbox().
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 Qtopia unique QMailId of the message.
See also setId().
Returns the message ID specified by the RFC 2822 'In-Reply-To' field for the message, if present.
See also setInReplyTo().
Returns an indication of the size of the message. This measure should be used only in comparing the relative size of messages with respect to transmission.
Returns the MessageType of the message.
See also setMessageType().
Return the QMailId of the parent of the folder that contains the message.
See also setParentFolderId().
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().
Returns the identifier for the message on the originating server.
See also setServerUid().
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 origination date header field specifying the timestamp of the message to timeStamp.
See also date().
Sets the from address, that is the originating address of the message to from.
See also from().
Sets the name of the originating account for the message to account.
See also fromAccount().
Sets the name of the originating mailbox for the message to mailBox.
See also fromMailbox().
Sets the QMailId of the message to id. id should be different for each message known to Qtopia.
See also id().
Sets the RFC 2822 'In-Reply-To' field for the message to messageId.
See also inReplyTo().
Sets the MessageType of the message to type.
See also messageType().
Sets the QMailId of the parent of the folder that contains the message to id.
See also parentFolderId().
Sets the RFC 2822 'Reply-To' address of the message to address.
See also replyTo().
Sets the originating server identifier for the message to server. The identifier specified should be unique.
See also serverUid().
Sets the complete size of the message as found on the server to size.
See also size().
Sets the status flags for the message to the given flags.
See also status().
This is an overloaded member function, provided for convenience.
If set is true, sets the individual status flag; otherwise the flag is cleared.
Sets the subject of the message to subject.
See also subject().
Sets the list of primary recipients for the message to toList.
See also to(), setCc(), and setBcc().
This is an overloaded member function, provided for convenience.
Sets the list of primary recipients for the message to contain address.
See also setCc() and setBcc().
Returns the complete size of the message as indicated on the originating server.
See also setSize().
Returns the status flags for the message.
See also setStatus().
Returns the subject of the message, if present; otherwise returns an empty string.
See also setSubject().
Returns the list of primary recipients for the message.
See also setTo(), cc(), bcc(), and QMailAddress.
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 © 2008 Nokia | Trademarks | Qtopia 4.3.3 |