![[Index]](../../../../a_stock/btn_index_wt.gif){kind=small}
![[Spacer]](../../../../a_stock/btn_spacer.gif){kind=small}
![[Previous]](../../../../a_stock/btn_prev_wt.gif){kind=small}
![[Next]](../../../../a_stock/btn_next_wt.gif){kind=small}
|
|
|
|
|
|
||
Location:
MIUTHDR.H
Link against: imcm.lib
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:
IMAP-specific flags, as defined by the IMAP protocol (see RFC3501, 2.3.2. Flags Message Attribute)
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()
Folder subscriptions and other folder-related flags:
Disconnected operation information:
Partial download flags: these flags allow a client to test if a message or its body has been partially downloaded (see TImImap4GetPartialMailInfo)
UID information: IMAP messages have a unique identifier number (see RFC3501, 2.3.1.1. Unique Identifier (UID) Message Attribute)
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.
TMsvEntry - Represents an entry in the Message Server index
TMsvEmailEntry - Provides storage for and access to extra email specific information for a message
Defined in TMsvEmailEntry:
AnsweredIMAP4Flag(), BodyTextComplete(), DeletedIMAP4Flag(), DisconnectedOperation(), DraftIMAP4Flag(), Encrypted(), FlaggedIMAP4Flag(), GetIMAP4Flags(), ICalendar(), LocalSubscription(), MHTMLEmail(), Mailbox(), MessageFolderType(), Orphan(), PartialDownloaded(), Receipt(), RecentIMAP4Flag(), RemoteFolderEntries(), SeenIMAP4Flag(), SetAnsweredIMAP4Flag(), SetBodyTextComplete(), SetDeletedIMAP4Flag(), SetDisconnectedOperation(), SetDraftIMAP4Flag(), SetEncrypted(), SetFlaggedIMAP4Flag(), SetICalendar(), SetIMAP4Flags(), SetLocalSubscription(), SetMHTMLEmail(), SetMailbox(), SetMessageFolderType(), SetOrphan(), SetPartialDownloaded(), SetReceipt(), SetRecentIMAP4Flag(), SetRemoteFolderEntries(), SetSeenIMAP4Flag(), SetSigned(), SetSubscribed(), SetUID(), SetUnreadIMAP4Flag(), SetVCalendar(), SetVCard(), SetValidUID(), Signed(), Subscribed(), TMsvEmailEntry(), TMsvEmailEntry(), UID(), UnreadIMAP4Flag(), VCalendar(), VCard(), ValidUID(), operator==(), operator==()
Inherited from TMsvEntry:
Attachment(),
Complete(),
Connected(),
DecPcSyncCount(),
DeleteProtected(),
Deleted(),
ExternalizeL(),
Failed(),
Forwarded(),
Id(),
InPreparation(),
IncPcSyncCount(),
InternalizeL(),
LocallyDeleted(),
MtmData1(),
MtmData2(),
MtmData3(),
MultipleRecipients(),
New(),
OffPeak(),
Operation(),
Owner(),
Parent(),
PcSyncCount(),
PendingConditions(),
PendingDelete(),
PermanentDataUnchanged(),
PersistedFlags(),
Priority(),
ReadOnly(),
Scheduled(),
SendingState(),
SetAttachment(),
SetComplete(),
SetConnected(),
SetDeleteProtected(),
SetDeleted(),
SetFailed(),
SetForwarded(),
SetId(),
SetInPreparation(),
SetLocallyDeleted(),
SetMultipleRecipients(),
SetNew(),
SetOffPeak(),
SetOperation(),
SetOwner(),
SetParent(),
SetPendingConditions(),
SetPendingDelete(),
SetPriority(),
SetReadOnly(),
SetScheduled(),
SetSendingState(),
SetStandardFolder(),
SetUnread(),
SetVisible(),
StandardFolder(),
TemporaryFlags(),
Unread(),
Visible(),
iBioType,
iDate,
iDescription,
iDetails,
iError,
iMtm,
iMtmData1,
iMtmData2,
iMtmData3,
iRelatedId,
iServiceId,
iSize,
iType,
operator=()
IMPORT_C TMsvEmailEntry(const TMsvEntry &aGenericEntry);
Copy constructor using a TMsvEntry object.
|
|
|
IMPORT_C TBool operator==(const TMsvEntry &aEntry) const;
Equality operator for comparison to a TMsvEntry.
|
|
IMPORT_C TBool operator==(const TMsvEmailEntry &aEntry) const;
Equality operator for comparison to a TMsvEmailEntry.
|
|
IMPORT_C void GetIMAP4Flags(TBool &rUnread, TBool &rSeen, TBool &rAnswered, TBool &rFlagged, TBool &rDeleted, TBool &rDraft,
TBool &rRecent);
Gets IMAP4-specific flags from the email entry: Unread, Seen, Answered, Flagged, Deleted, Draft and Recent.
|
IMPORT_C void SetIMAP4Flags(TBool aUnread, TBool aSeen, TBool aAnswered, TBool aFlagged, TBool aDeleted, TBool aDraft, TBool
aRecent);
Sets IMAP4-specific flags from the email entry: Unread, Seen, Answered, Flagged, Deleted, Draft and Recent.
|
IMPORT_C void SetMessageFolderType(TImEmailFolderType aFolderType);
Sets a flag on an IMAP MTM folder entry indicating that it stores a multipart body structure.
Multipart body structure parts are represented in the message store by a folder entry with this flag set to the appropriate multipart type string.
|
IMPORT_C TImEmailFolderType MessageFolderType() const;
Gets a flag on an IMAP MTM folder entry indicating that it stores a multipart body structure.
Multipart body structure parts are represented in the message store by a folder entry with this flag set to the appropriate multipart type string.
|
IMPORT_C void SetDisconnectedOperation(TImDisconnectedOperationType aDisconnectedOperationType);
Sets the disconnected operation type.
|
IMPORT_C TImDisconnectedOperationType DisconnectedOperation() const;
Gets the disconnected operation type.
|
IMPORT_C void SetPartialDownloaded(TBool aPartialDownloaded);
Sets if the body text is partially downloaded.
|
IMPORT_C TBool PartialDownloaded() const;
Tests if body text is partially downloaded.
|
inline void SetEncrypted(TBool aEncrypt);
Sets whether encryption is used.
Not currently used.
|
inline TBool Encrypted() const;
Tests whether encryption is used.
Not currently used.
|
inline void SetSigned(TBool aSignature);
Sets whether signing is used.
Not currently used.
|
inline TBool Signed() const;
Tests whether signing is used.
Not currently used.
|
inline TBool VCard() const;
Tests if the message contains a VCard attachment.
|
inline void SetVCard(TBool aVCard);
Sets a flag that the message contains a VCard attachment.
|
inline TBool VCalendar() const;
Tests if the message contains a VCal attachment.
|
inline void SetVCalendar(TBool aVCal);
Sets a flag that the message contains a VCal attachment.
|
inline TBool ICalendar() const;
Tests if the message contains an iCalendar attachment.
|
inline void SetICalendar(TBool aICal);
Sets a flag that the message contains an iCalendar attachment.
|
inline TBool Receipt() const;
Tests if the email message requests a receipt.
|
inline void SetReceipt(TBool aReceipt);
Sets a flag that the email message requests a receipt.
|
inline TBool MHTMLEmail() const;
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.
|
inline void SetMHTMLEmail(TBool aMhtml);
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.
|
inline TBool BodyTextComplete() const;
Tests if body text is complete.
|
inline void SetBodyTextComplete(TBool aFlag);
Sets if body text is complete.
|
inline void SetUnreadIMAP4Flag(TBool aUnread);
Sets the state of the unread messages IMAP4 flag.
|
inline TBool UnreadIMAP4Flag() const;
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.
|
inline void SetSeenIMAP4Flag(TBool aSeen);
Sets the state of the \Seen IMAP4 flag.
|
inline TBool SeenIMAP4Flag() const;
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.
|
inline void SetAnsweredIMAP4Flag(TBool aAnswered);
Sets the state of the \Answered IMAP4 flag.
|
inline TBool AnsweredIMAP4Flag() const;
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.
|
inline void SetFlaggedIMAP4Flag(TBool aFlagged);
Sets the state of the \Flagged IMAP4 flag.
|
inline TBool FlaggedIMAP4Flag() const;
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.
|
inline void SetDeletedIMAP4Flag(TBool aDeleted);
Sets the state of the \Deleted IMAP4 flag.
|
inline TBool DeletedIMAP4Flag() const;
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.
|
inline void SetDraftIMAP4Flag(TBool aDraft);
Sets the state of the \Draft IMAP4 flag.
|
inline TBool DraftIMAP4Flag() const;
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.
|
inline void SetRecentIMAP4Flag(TBool aRecent);
Sets the state of the \Recent IMAP4 flag.
|
inline TBool RecentIMAP4Flag() const;
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.
|
inline void SetMailbox(TBool aMailbox);
Sets if the specified folder is the IMAP4 Mailbox.
|
inline TBool Mailbox() const;
Tests if the specified folder is the IMAP4 Mailbox.
|
inline TBool Orphan() const;
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.
|
inline void SetOrphan(TBool aOrphan);
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.
|
inline void SetValidUID(TBool aValid);
Sets the IMAP4 UID (unique identifier) validity for the specified folder.
|
inline TBool ValidUID() const;
Gets the IMAP4 UID (unique identifier) validity for the specified folder.
|
inline void SetSubscribed(TBool aSubscribed);
Sets the IMAP4 subscription state for the specified folder.
|
inline TBool Subscribed() const;
Gets the IMAP4 subscription state for the specified folder.
|
inline void SetLocalSubscription(TBool aLocal);
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.
|
inline TBool LocalSubscription() const;
Gets the IMAP4 local subscription state for the specified folder.
|
inline void SetUID(TUint32 aUid);
Sets the IMAP4 UID (unique identifier) for the specified message/folder.
|
inline TUint32 UID() const;
Gets the IMAP4 UID (unique identifier) for the specified message/folder.
|
inline TInt RemoteFolderEntries() const;
Gets the number of messages stored in the remote folder.
|
inline void SetRemoteFolderEntries(TInt aEntries);
Sets the number of messages stored in the remote folder.
|
|
Copyright ©2008 Symbian Software Ltd. |
|
![[Top]](../../../../a_stock/arrow_up_2.gif){kind=icon}
![[Previous]](../../../../a_stock/btn_prev.gif){kind=small}
![[Top]](../../../../a_stock/btn_top.gif)
![[Next]](../../../../a_stock/btn_next.gif){kind=small}