![]() |
Home | ![]() |
The QMailMessageMetaData class provides information about a message stored by QMF. More...
#include <QMailMessageMetaData>
This class is under development and is subject to change.
Inherits QMailMessageMetaDataFwd.
Inherited by QMailMessage.
QMailMessageMetaData () | |
QMailMessageMetaData ( const QMailMessageId & id ) | |
QMailMessageMetaData ( const QString & uid, const QMailAccountId & accountId ) | |
virtual ContentType | content () const |
virtual bool | contentAvailable () const |
virtual QString | contentIdentifier () const |
virtual QString | contentScheme () const |
virtual QString | copyServerUid () const |
QString | customField ( const QString & name ) const |
const QMap<QString, QString> & | customFields () const |
virtual QMailTimeStamp | date () const |
virtual QMailAddress | from () const |
virtual QMailMessageId | id () const |
virtual QMailMessageId | inResponseTo () const |
virtual uint | indicativeSize () const |
virtual QString | listId () const |
virtual MessageType | messageType () const |
virtual QMailAccountId | parentAccountId () const |
virtual QMailFolderId | parentFolderId () const |
virtual QMailThreadId | parentThreadId () const |
virtual bool | partialContentAvailable () const |
virtual QString | preview () const |
virtual QMailFolderId | previousParentFolderId () const |
virtual QMailTimeStamp | receivedDate () const |
virtual QList<QMailAddress> | recipients () const |
void | removeCustomField ( const QString & name ) |
virtual ResponseType | responseType () const |
virtual QMailFolderId | restoreFolderId () const |
virtual QString | rfcId () const |
virtual QString | serverUid () const |
virtual void | setContent ( ContentType type ) |
virtual bool | setContentIdentifier ( const QString & identifier ) |
virtual bool | setContentScheme ( const QString & scheme ) |
virtual void | setCopyServerUid ( const QString & serverUid ) |
void | setCustomField ( const QString & name, const QString & value ) |
virtual void | setDate ( const QMailTimeStamp & timeStamp ) |
virtual void | setFrom ( const QMailAddress & from ) |
virtual void | setId ( const QMailMessageId & id ) |
virtual void | setInResponseTo ( const QMailMessageId & id ) |
virtual void | setListId ( const QString & id ) |
virtual void | setMessageType ( MessageType type ) |
virtual void | setParentAccountId ( const QMailAccountId & id ) |
virtual void | setParentFolderId ( const QMailFolderId & id ) |
virtual void | setParentThreadId ( const QMailThreadId & id ) |
virtual void | setPreview ( const QString & s ) |
virtual void | setPreviousParentFolderId ( const QMailFolderId & id ) |
virtual void | setReceivedDate ( const QMailTimeStamp & timeStamp ) |
virtual void | setResponseType ( ResponseType type ) |
virtual void | setRestoreFolderId ( const QMailFolderId & id ) |
virtual void | setRfcId ( const QString & id ) |
virtual void | setServerUid ( const QString & server ) |
virtual void | setSize ( uint size ) |
virtual void | setStatus ( quint64 newStatus ) |
virtual void | setStatus ( quint64 mask, bool set ) |
virtual void | setSubject ( const QString & subject ) |
virtual uint | size () const |
virtual quint64 | status () const |
virtual QString | subject () const |
const quint64 & | ContentAvailable |
const quint64 & | Draft |
const quint64 & | Forwarded |
const quint64 & | HasAttachments |
const quint64 & | HasReferences |
const quint64 & | HasUnresolvedReferences |
const quint64 & | HighPriority |
const quint64 & | Important |
const quint64 & | ImportantElsewhere |
const quint64 & | Incoming |
const quint64 & | Junk |
const quint64 & | LocalOnly |
const quint64 & | LowPriority |
const quint64 & | New |
const quint64 & | Outbox |
const quint64 & | Outgoing |
const quint64 & | PartialContentAvailable |
const quint64 & | Read |
const quint64 & | ReadElsewhere |
const quint64 & | ReadReplyRequested |
const quint64 & | Removed |
const quint64 & | Replied |
const quint64 & | RepliedAll |
const quint64 & | Sent |
const quint64 & | Temporary |
const quint64 & | TransmitFromExternal |
const quint64 & | Trash |
const quint64 & | UnloadedData |
quint64 | statusMask ( const QString & flagName ) |
virtual void | setRecipients ( const QList<QMailAddress> & toList ) |
virtual void | setRecipients ( const QMailAddress & address ) |
The QMailMessageMetaData class provides information about a message stored by QMF.
The QMailMessageMetaData class provides information about messages stored in the Qt Extended system as QMailMessage objects. The meta data is more compact and more easily accessed and manipulated than the content of the message itself. Many messaging-related tasks can be accomplished by manipulating the message meta data, such as listing, filtering, and searching through sets of messages.
QMailMessageMetaData objects can be created as needed, specifying the identifier of the message whose meta data is required. The meta data of a message can be located by specifying the QMailMessageId identifier directly, or by specifying the account and server UID pair needed to locate the message.
The content of the message described by the meta data object can be accessed by creating a QMailMessage object specifying the identifier returned by QMailMessageMetaData::id().
See also QMailStore and QMailMessageId.
Constructs an empty message meta data object.
Constructs a message meta data object from data stored in the message store with QMailMessageId id.
Constructs a message meta data object from data stored in the message store with the unique identifier uid from the account with id accountId.
Returns the type of content contained within the message.
See also setContent().
Returns true if the entire content of this message is available; otherwise returns false.
Returns the identifer used to locate the content of this message.
See also setContentIdentifier().
Returns the scheme used to store the content of this message.
See also setContentScheme().
If this messsage is an unsynchronized copy, it will return the server identifier of the message it is a copy of. Otherwise an empty string is returned.
Most clients should probably not need to use this.
See also setCopyServerUid() and serverUid().
Returns the value recorded in the custom field named name.
See also setCustomField() and customFields().
Returns the map of custom fields stored in the message.
See also customField() and setCustomField().
Returns the timestamp contained in the origination date header field of the message, if present; otherwise returns an empty timestamp.
See also setDate().
Returns the originating address of the message.
See also setFrom().
Returns the Qt Extended unique QMailMessageId of the message.
See also setId().
Returns the identifier of the message that this message was created in response to.
See also setInResponseTo().
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 list identifier. This corresponds to "list-id-namespace" specified in RFC 2919. Returns an empty string if this message does not belong to a list.
See also setListId().
Returns the MessageType of the message.
See also setMessageType().
Returns the id of the originating account for the message.
See also setParentAccountId().
Return the QMailFolderId of the folder that contains the message.
See also setParentFolderId().
Returns the id of the thread this message belongs to.
See also setParentThreadId().
Returns true if some portion of the content of this message is available; otherwise returns false.
Returns the preview text of this message.
See also setPreview().
Return the QMailFolderId of the folder that contained the message before it was moved into the current parent folder.
See also setPreviousParentFolderId().
Returns the timestamp placed in the message during reception by the messageserver, if present; otherwise returns an empty timestamp.
See also setReceivedDate().
Returns the list of all recipients for the message.
See also setRecipients() and QMailAddress.
Removes the custom field named name.
See also customField() and customFields().
Returns the type of response that this message was created as.
See also setResponseType() and inResponseTo().
Return the folder in which this message should be moved to, if it were to be restored from trash. Returns an invalid QMailFolderId if this message is not in trash or require a move when restored.
See also setRestoreFolderId().
Returns the message-id identifier. This is taken from the message-id field of an RFC2822 message. Returns and empty string if not available.
See also setRfcId().
Returns the identifier for the message on the originating server.
See also setServerUid().
Sets the type of content contained within the message to type. It is the caller's responsibility to ensure that this value matches the actual content.
See also content().
Sets the identifer used to locate the content of this message to identifier, and returns true if successful. Once set, the identifier cannot be modified.
The identifier specified should be unique within the scheme returned by contentScheme().
See also contentIdentifier().
Sets the scheme used to store the content of this message to scheme, and returns true if successful. Once set, the scheme cannot be modified.
See also contentScheme().
Sets the server identifier to serverUid of which message this is an unsychronized copy of.
There is little reason for clients to use this.
See also copyServerUid().
Sets the value of the custom field named name to value.
See also customField() and customFields().
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 QMailMessageId of the message to id. id should be different for each message known to QMF.
See also id().
Sets the identifier of the message that this message was created in response to, to id.
See also inResponseTo().
Sets the list identifier to id
See also listId().
Sets the MessageType of the message to type.
See also messageType().
Sets the id of the originating account for the message to id.
See also parentAccountId().
Sets the QMailFolderId of the folder that contains the message to id.
See also parentFolderId().
Sets the id of the thread this message belongs to id. If this is left blank then the thread will be detected/generated.
See also parentThreadId().
Sets the preview text of this message to s.
See also preview().
Sets the QMailFolderId of the folder that contained the message before it was moved into the current parent folder to id.
See also previousParentFolderId().
Sets the timestamp indicating the time of message reception by the messageserver to timeStamp.
See also receivedDate().
Sets the list of recipients for the message to toList.
See also recipients().
Sets the list of primary recipients for the message to contain address.
Sets the type of response that this message was created as to type.
See also responseType() and setInResponseTo().
Sets the identifier for which folder this message should be restorable to id
See also restoreFolderId().
Sets the RfcId to id
See also rfcId().
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 value for the message to newStatus.
See also status() and statusMask().
Sets the status flags indicated in mask to set.
See also status() and statusMask().
Sets the subject of the message to subject.
See also subject().
Returns the complete size of the message as indicated on the originating server.
See also setSize().
Returns the status value for the message.
See also setStatus() and statusMask().
Returns the status bitmask needed to test the result of QMailMessageMetaData::status() against the QMailMessageMetaData status flag registered with the identifier flagName.
See also status() and QMailStore::messageStatusMask().
Returns the subject of the message, if present; otherwise returns an empty string.
See also setSubject().
The status mask needed for testing the value of the registered status flag named "ContentAvailable" against the result of QMailMessage::status().
This flag indicates that the entire content of the message has been retrieved from the originating server, excluding any sub-parts of the message.
See also QMailMessagePartContainer::contentAvailable().
The status mask needed for testing the value of the registered status flag named "Draft" against the result of QMailMessage::status().
This flag indicates that the message has been marked as a draft, and should be considered subject to further composition.
The status mask needed for testing the value of the registered status flag named "Forwarded" against the result of QMailMessage::status().
This flag indicates that a message forwarding the content of this message has been created.
The status mask needed for testing the value of the registered status flag named "HasAttachments" against the result of QMailMessage::status().
This flag indicates that the message contains at least one sub-part with 'Attachment' disposition, or a "X-MS-Has-Attach" headerfield with value yes.
See also QMailMessageContentDisposition.
The status mask needed for testing the value of the registered status flag named "HasReferences" against the result of QMailMessage::status().
This flag indicates that the message contains at least one sub-part which is a reference to an external message element.
See also QMailMessagePart::referenceType().
The status mask needed for testing the value of the registered status flag named "HasUnresolvedReferences" against the result of QMailMessage::status().
This flag indicates that the message contains at least one sub-part which is a reference, that has no corresponding resolution value.
See also QMailMessagePart::referenceType() and QMailMessagePart::referenceResolution().
The status mask needed for testing the value of the registered status flag named "HighPriority" against the result of QMailMessage::status().
This flag indicates that the message has a header field specifying that the message is high priority. This flag is set only during message parsing.
See also QMailMessage::fromRfc2822().
The status mask needed for testing the value of the registered status flag named "Important" against the result of QMailMessage::status().
This flag indicates that the message is marked as important.
The status mask needed for testing the value of the registered status flag named "ImportantElsewhere" against the result of QMailMessage::status().
This flag indicates that the message has been reported as having been marked as important by some other client.
The status mask needed for testing the value of the registered status flag named "Incoming" against the result of QMailMessage::status().
This flag indicates that the message has been sent from an external source to an account whose messages are retrieved to Qt Extended.
The status mask needed for testing the value of the registered status flag named "Junk" against the result of QMailMessage::status().
This flag indicates that the message has been marked as junk, and should be considered unsuitable for standard listings.
The status mask needed for testing the value of the registered status flag named "LocalOnly" against the result of QMailMessage::status().
This flag indicates that the message exists only on the local device, and has no representation on any external server.
The status mask needed for testing the value of the registered status flag named "LowPriority" against the result of QMailMessage::status().
This flag indicates that the message has a header field specifying that the message is low priority. This flag is set only during message parsing.
See also QMailMessage::fromRfc2822().
The status mask needed for testing the value of the registered status flag named "New" against the result of QMailMessage::status().
This flag indicates that the meta data of the message has not yet been displayed to the user.
The status mask needed for testing the value of the registered status flag named "Outbox" against the result of QMailMessage::status().
This flag indicates that the message has been marked as ready for transmission.
The status mask needed for testing the value of the registered status flag named "Outgoing" against the result of QMailMessage::status().
This flag indicates that the message originates within Qt Extended, for transmission to an external message sink.
The status mask needed for testing the value of the registered status flag named "PartialContentAvailable" against the result of QMailMessage::status().
This flag indicates that some portion of the content of the message has been retrieved from the originating server.
See also QMailMessagePartContainer::contentAvailable().
The status mask needed for testing the value of the registered status flag named "Read" against the result of QMailMessage::status().
This flag indicates that the content of this message has been displayed to the user.
The status mask needed for testing the value of the registered status flag named "ReadElsewhere" against the result of QMailMessage::status().
This flag indicates that the content of this message has been reported as having been displayed to the user by some other client.
The status mask needed for testing the value of the registered status flag named "ReadReplyRequested" against the result of QMailMessage::status().
This flag indicates that the message has requested that a read confirmation reply be returned to the sender.
The status mask needed for testing the value of the registered status flag named "Removed" against the result of QMailMessage::status().
This flag indicates that the message has been deleted from or moved on the originating server.
The status mask needed for testing the value of the registered status flag named "Replied" against the result of QMailMessage::status().
This flag indicates that a message replying to the source of this message has been created, in response to this message.
The status mask needed for testing the value of the registered status flag named "RepliedAll" against the result of QMailMessage::status().
This flag indicates that a message replying to the source of this message and all its recipients, has been created in response to this message.
The status mask needed for testing the value of the registered status flag named "Sent" against the result of QMailMessage::status().
This flag indicates that the message has been delivered to an external message sink.
The status mask needed for testing the value of the registered status flag named "Temporary" against the result of QMailMessage::status().
This flag indicates that the message will not exist permanently and should be removed at a later time.
The status mask needed for testing the value of the registered status flag named "TransmitFromExternal" against the result of QMailMessage::status().
This flag indicates that the message should be transmitted by reference to its external server location.
The status mask needed for testing the value of the registered status flag named "Trash" against the result of QMailMessage::status().
This flag indicates that the message has been marked as trash, and should be considered logically deleted.
The status mask needed for testing the value of the registered status flag named "UnloadedData" against the result of QMailMessage::status().
This flag indicates that the meta data of the message is not loaded in entirety.
Copyright © 2010 QtSoftware | Messaging Framework |