| class TMsvEmailEntry : public TMsvEntry |
Provides storage for and access to extra email specific information for a message.
To get a TMsvEmailEntry, get the entry's TMsvEntry, e.g. using CMsvEntry::Entry(), and use the constructor that takes a TMsvEntry parameter.
Many of the flags are only used by IMAP4 entries. These can be grouped as follows:
GetIMAP4Flags() and SetIMAP4Flags() handle all the flags as a group
\Seen flag: SetSeenIMAP4Flag(), SeenIMAP4Flag().
\Answered flag: SetAnsweredIMAP4Flag(), AnsweredIMAP4Flag()
\Flagged flag: SetFlaggedIMAP4Flag(), FlaggedIMAP4Flag()
\Deleted flag: SetDeletedIMAP4Flag(), DeletedIMAP4Flag()
\Draft flag: SetDraftIMAP4Flag(), DraftIMAP4Flag()
\Recent flag: SetRecentIMAP4Flag(), RecentIMAP4Flag()
The following flags are set only by the IMAP MTM. They indicate if the message contains a vCard, vCalendar (http://www.imc.org), or iCalendar (RFC 2445) attachment.
The following flags apply to all email protocols:
Receipt requested: Receipt(), SetReceipt()
MHTML content: MHTMLEmail(), SetMHTMLEmail()
Note that the email specific data is stored in the reserved data members iMtmData1, iMtmData2 and iMtmData3 of the TMsvEntry base class. These public data members must not be directly altered by clients.
CImap4ClientMtm
| IMPORT_C | TMsvEmailEntry | ( | const TMsvEntry & | aGenericEntry | ) |
| const TMsvEntry & aGenericEntry |
| TBool | AnsweredIMAP4Flag | ( | ) | const [inline] |
Gets the state of the \Answered IMAP4 flag.
This indicates if the message has been answered. It is described in RFC3501, 2.3.2. Flags Message Attribute.
\Answered IMAP4 flag
| TBool | BodyTextComplete | ( | ) | const [inline] |
Tests if body text is complete. True if body text is complete.
| TBool | DeletedIMAP4Flag | ( | ) | const [inline] |
Gets the state of the \Deleted IMAP4 flag.
This indicates if the message is marked as deleted for removal later. It is described in RFC3501, 2.3.2. Flags Message Attribute.
\Deleted IMAP4 flag
| TBool | DraftIMAP4Flag | ( | ) | const [inline] |
Gets the state of the \Draft IMAP4 flag.
This indicates if the message has not completed composition. It is described in RFC3501, 2.3.2. Flags Message Attribute.
\Draft IMAP4 flag
| TBool | Encrypted | ( | ) | const [inline] |
Tests whether encryption is used.
Not currently used.
True if encryption is used
| TBool | FlaggedIMAP4Flag | ( | ) | const [inline] |
Gets the state of the \Flagged IMAP4 flag.
This indicates if the message is flagged for urgent/special attention. It is described in RFC3501, 2.3.2. Flags Message Attribute.
\Flagged IMAP4 flag
| IMPORT_C void | GetIMAP4Flags | ( | TBool & | rUnread, |
| TBool & | rSeen, | |||
| TBool & | rAnswered, | |||
| TBool & | rFlagged, | |||
| TBool & | rDeleted, | |||
| TBool & | rDraft, | |||
| TBool & | rRecent | |||
| ) | ||||
| TBool | ICalendar | ( | ) | const [inline] |
Tests if the message contains an iCalendar attachment.
True if the message contains an iCalendar attachment
| TBool | LocalSubscription | ( | ) | const [inline] |
Gets the IMAP4 local subscription state for the specified folder.
IMAP4 local subscription state
| TBool | MHTMLEmail | ( | ) | const [inline] |
Returns the flag indicating if the message has an HTML body part.
Note: the flag is for HTML and not only MHTML.
Use CImEmailMessage to retrieve the HTML body part.
True if the message has an HTML body part
| TBool | Mailbox | ( | ) | const [inline] |
Tests if the specified folder is the IMAP4 Mailbox. True if the specified folder is the Mailbox
| TBool | Orphan | ( | ) | const [inline] |
Gets the IMAP4 orphaned state for the specified message/folder.
The concept of an orphan is no longer used, so this function should not be used.
True if the specified entry is orphaned
| TBool | Receipt | ( | ) | const [inline] |
Tests if the email message requests a receipt. True if the email message requests a receipt
| TBool | RecentIMAP4Flag | ( | ) | const [inline] |
Gets the state of the \Recent IMAP4 flag.
This indicates if the message is "recently" arrived in this mailbox. This session is the first session to have been notified about this message. For more details, see see RFC3501, 2.3.2. Flags Message Attribute.
\Recent IMAP4 flag
| TInt | RemoteFolderEntries | ( | ) | const [inline] |
Gets the number of messages stored in the remote folder. Number of messages
| TBool | SeenIMAP4Flag | ( | ) | const [inline] |
Gets the state of the \Seen IMAP4 flag.
This indicates if the message has been read. It is described in RFC3501, 2.3.2. Flags Message Attribute.
Note that the server MTM creates messages with the TMsvEntry::Unread() flag set. If on synchronisation a folder contains new messages, the Unread flag will also be set on the folder.
\Seen IMAP4 flag
| void | SetAnsweredIMAP4Flag | ( | TBool | aAnswered | ) | [inline] |
Sets the state of the \Answered IMAP4 flag.
| TBool aAnswered | \Answered IMAP4 flag |
| void | SetBodyTextComplete | ( | TBool | aFlag | ) | [inline] |
Sets if body text is complete.
| TBool aFlag | True if body text is complete. |
| void | SetDeletedIMAP4Flag | ( | TBool | aDeleted | ) | [inline] |
Sets the state of the \Deleted IMAP4 flag.
| TBool aDeleted | \Deleted IMAP4 flag |
| IMPORT_C void | SetDisconnectedOperation | ( | TImDisconnectedOperationType | aDisconnectedOperationType | ) |
| TImDisconnectedOperationType aDisconnectedOperationType |
| void | SetDraftIMAP4Flag | ( | TBool | aDraft | ) | [inline] |
Sets the state of the \Draft IMAP4 flag.
| TBool aDraft | \Draft IMAP4 flag |
| void | SetEncrypted | ( | TBool | aEncrypt | ) | [inline] |
Sets whether encryption is used.
Not currently used.
| TBool aEncrypt | True if encryption is used |
| void | SetFlaggedIMAP4Flag | ( | TBool | aFlagged | ) | [inline] |
Sets the state of the \Flagged IMAP4 flag.
| TBool aFlagged | \Flagged IMAP4 flag |
| void | SetICalendar | ( | TBool | aICal | ) | [inline] |
Sets a flag that the message contains an iCalendar attachment.
| TBool aICal | True if the message contains an iCalendar attachment |
| IMPORT_C void | SetIMAP4Flags | ( | TBool | aUnread, |
| TBool | aSeen, | |||
| TBool | aAnswered, | |||
| TBool | aFlagged, | |||
| TBool | aDeleted, | |||
| TBool | aDraft, | |||
| TBool | aRecent | |||
| ) | ||||
| void | SetLocalSubscription | ( | TBool | aLocal | ) | [inline] |
Sets the IMAP4 local subscription state for the specified folder.
Depending on other settings, setting a folder to be locally subscribed can mean:
that the folder is synchronised as part of synchronisation operations (depending on the value of CImImap4Settings::Synchronise())
that the folder will be set as subscribed on the remote server (depending on the value of CImImap4Settings::SetSuscribe())
Note that clients can use the KIMAP4MTMLocalSubscribe command to set this flag and save the change to the entry.
| TBool aLocal | IMAP4 local subscription state |
| void | SetMHTMLEmail | ( | TBool | aMhtml | ) | [inline] |
Sets the flag indicating if the message has an HTML body part.
Note: the flag is for HTML and not only MHTML.
Use CImEmailMessage to retrieve the HTML body part.
| TBool aMhtml | True if the message has an HTML body part |
| void | SetMailbox | ( | TBool | aMailbox | ) | [inline] |
Sets if the specified folder is the IMAP4 Mailbox.
| TBool aMailbox | True if the specified folder is the Mailbox |
| IMPORT_C void | SetMessageFolderType | ( | TImEmailFolderType | aFolderType | ) |
| TImEmailFolderType aFolderType |
| void | SetOrphan | ( | TBool | aOrphan | ) | [inline] |
Sets the IMAP4 orphaned state for the specified message/folder.
The concept of an orphan is no longer used, so this function should not be used.
| TBool aOrphan | True if the specified entry is orphaned |
| IMPORT_C void | SetPartialDownloaded | ( | TBool | aPartialDownloaded | ) |
| TBool aPartialDownloaded |
| void | SetReceipt | ( | TBool | aReceipt | ) | [inline] |
Sets a flag that the email message requests a receipt.
| TBool aReceipt | True if the email message requests a receipt |
| void | SetRecentIMAP4Flag | ( | TBool | aRecent | ) | [inline] |
Sets the state of the \Recent IMAP4 flag.
| TBool aRecent | \Recent IMAP4 flag |
| void | SetRemoteFolderEntries | ( | TInt | aEntries | ) | [inline] |
Sets the number of messages stored in the remote folder.
| TInt aEntries | Number of messages |
| void | SetSeenIMAP4Flag | ( | TBool | aSeen | ) | [inline] |
Sets the state of the \Seen IMAP4 flag.
| TBool aSeen | \Seen IMAP4 flag |
| void | SetSigned | ( | TBool | aSignature | ) | [inline] |
Sets whether signing is used.
Not currently used.
| TBool aSignature | True if signing is used |
| void | SetSubscribed | ( | TBool | aSubscribed | ) | [inline] |
Sets the IMAP4 subscription state for the specified folder.
| TBool aSubscribed | IMAP4 subscription state |
| void | SetUID | ( | TUint32 | aUid | ) | [inline] |
Sets the IMAP4 UID (unique identifier) for the specified message/folder.
| TUint32 aUid | IMAP4 UID |
| void | SetUnreadIMAP4Flag | ( | TBool | aUnread | ) | [inline] |
Sets the state of the unread messages IMAP4 flag.
| TBool aUnread | Unread messages IMAP4 flag |
| void | SetVCalendar | ( | TBool | aVCal | ) | [inline] |
Sets a flag that the message contains a VCal attachment.
| TBool aVCal | True if the message contains a VCal attachment |
| void | SetVCard | ( | TBool | aVCard | ) | [inline] |
Sets a flag that the message contains a VCard attachment.
| TBool aVCard | True if the message contains a VCard attachment |
| void | SetValidUID | ( | TBool | aValid | ) | [inline] |
Sets the IMAP4 UID (unique identifier) validity for the specified folder.
| TBool aValid | True if IMAP4 UID validity is set |
| TBool | Signed | ( | ) | const [inline] |
Tests whether signing is used.
Not currently used.
True if signing is used
| TBool | Subscribed | ( | ) | const [inline] |
Gets the IMAP4 subscription state for the specified folder. IMAP4 subscription state
| TUint32 | UID | ( | ) | const [inline] |
Gets the IMAP4 UID (unique identifier) for the specified message/folder. IMAP4 UID
| TBool | UnreadIMAP4Flag | ( | ) | const [inline] |
Gets the state of the unread messages IMAP4 flag.
This flag is set on a folder if the folder contains any messages with the IMAP \Seen flag set.
Unread messages IMAP4 flag
| TBool | VCalendar | ( | ) | const [inline] |
Tests if the message contains a VCal attachment. True if the message contains a VCal attachment
| TBool | VCard | ( | ) | const [inline] |
Tests if the message contains a VCard attachment. True if the message contains a VCard attachment
| TBool | ValidUID | ( | ) | const [inline] |
Gets the IMAP4 UID (unique identifier) validity for the specified folder. True if IMAP4 UID validity is set
| IMPORT_C TBool | operator== | ( | const TMsvEntry & | aEntry | ) | const |
| const TMsvEntry & aEntry |
| IMPORT_C TBool | operator== | ( | const TMsvEmailEntry & | aEntry | ) | const |
| const TMsvEmailEntry & aEntry |
| KMsvEmailEntryClearFlag = 0x00 | |
| KMsvEmailEntryEncryptedFlag = 0x00000001 | |
| KMsvEmailEntrySignedFlag = 0x00000002 | |
| KMsvEmailEntryReceiptFlag = 0x00000004 | |
| KMsvEmailEntryOrphanFlag = 0x00000008 | |
| KMsvEmailEntryVCardFlag = 0x00000010 | |
| KMsvEmailEntryVCalendarFlag = 0x00000020 | |
| KMsvEmailEntryMHTMLFlag = 0x00000040 | |
| KMsvEmailEntryBodyTextCompleteFlag = 0x00000080 | |
| KMsvEmailEntryNoDisconnectedOperations = 0x00000000 | |
| KMsvEmailEntryDisconnectedCreateOperation = 0x00000100 | |
| KMsvEmailEntryDisconnectedDeleteOperation = 0x00000200 | |
| KMsvEmailEntryDisconnectedChangeOperation = 0x00000300 | |
| KMsvEmailEntryDisconnectedCopyToOperation = 0x00000400 | |
| KMsvEmailEntryDisconnectedCopyFromOperation = 0x00000500 | |
| KMsvEmailEntryDisconnectedCopyWithinServiceOperation = 0x00000600 | |
| KMsvEmailEntryDisconnectedMoveToOperation = 0x00000700 | |
| KMsvEmailEntryDisconnectedMoveFromOperation = 0x00000800 | |
| KMsvEmailEntryDisconnectedMoveWithinServiceOperation = 0x00000900 | |
| KMsvEmailEntryDisconnectedSpecialOperation = 0x00000A00 | |
| KMsvEmailEntryDisconnectedUnknownOperation = 0x00000B00 | |
| KMsvEmailEntryDisconnectedMultipleOperation = 0x00000C00 | |
| KMsvEmailEntryDisconnectedOperation = 0x00000F00 | |
| KMsvEmailEntryIMAP4SubscribedFlag = 0x00001000 | |
| KMsvEmailEntryIMAP4UnreadFlag = 0x00002000 | |
| KMsvEmailEntryIMAP4SeenFlag = 0x00004000 | |
| KMsvEmailEntryIMAP4AnsweredFlag = 0x00008000 | |
| KMsvEmailEntryIMAP4FlaggedFlag = 0x00010000 | |
| KMsvEmailEntryIMAP4DeletedFlag = 0x00020000 | |
| KMsvEmailEntryIMAP4DraftFlag = 0x00040000 | |
| KMsvEmailEntryIMAP4RecentFlag = 0x00080000 | |
| KMsvEmailEntryIMAP4ValidUIDFlag = 0x00100000 | |
| KMsvEmailEntryIMAP4MailboxFlag = 0x00200000 | |
| KMsvEmailEntryIMAP4LocalSubFlag = 0x00400000 | |
| KMsvMimeFolderUnknownMask = 0x00000000 | |
| KMsvMimeFolderRelatedMask = 0x01000000 | |
| KMsvMimeFolderMixedMask = 0x02000000 | |
| KMsvMimeFolderAlternativeMask = 0x03000000 | |
| KMsvMimeFolderParallelMask = 0x04000000 | |
| KMsvMimeFolderDigestMask = 0x05000000 | |
| KMsvMimeFolderRFC822Mask = 0x06000000 | |
| KMsvMimeFolderPartialMask = 0x07000000 | |
| KMsvMimeFolderDirectoryMask = 0x08000000 | |
| KMsvMimeFolderExternalMask = 0x09000000 | |
| KMsvMimeFolderMask = 0x0F000000 | |
| KMsvEmailEntryPartialDownloadFlag = 0x10000000 | |
| KMsvEmailEntryICalendarFlag = 0x20000000 |