Class TMsvEmailEntry

class TMsvEmailEntry : public TMsvEntry;

Description

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)

  • TMsvEmailEntry::GetIMAP4Flags(TBool &,TBool &,TBool &,TBool &,TBool &,TBool &,TBool &) and TMsvEmailEntry::SetIMAP4Flags(TBool,TBool,TBool,TBool,TBool,TBool,TBool) handle all the flags as a group

  • \Seen flag: TMsvEmailEntry::SetSeenIMAP4Flag(TBool), TMsvEmailEntry::SeenIMAP4Flag()const.

  • \Answered flag: TMsvEmailEntry::SetAnsweredIMAP4Flag(TBool), TMsvEmailEntry::AnsweredIMAP4Flag()const

  • \Flagged flag: TMsvEmailEntry::SetFlaggedIMAP4Flag(TBool), TMsvEmailEntry::FlaggedIMAP4Flag()const

  • \Deleted flag: TMsvEmailEntry::SetDeletedIMAP4Flag(TBool), TMsvEmailEntry::DeletedIMAP4Flag()const

  • \Draft flag: TMsvEmailEntry::SetDraftIMAP4Flag(TBool), TMsvEmailEntry::DraftIMAP4Flag()const

  • \Recent flag: TMsvEmailEntry::SetRecentIMAP4Flag(TBool), TMsvEmailEntry::RecentIMAP4Flag()const

• Folder subscriptions and other folder-related flags:

  • TMsvEmailEntry::SetMailbox(TBool), TMsvEmailEntry::Mailbox()const,

  • TMsvEmailEntry::SetSubscribed(TBool), TMsvEmailEntry::Subscribed()const,

  • TMsvEmailEntry::SetLocalSubscription(TBool), TMsvEmailEntry::LocalSubscription()const

  • TMsvEmailEntry::SetRemoteFolderEntries(TInt), TMsvEmailEntry::RemoteFolderEntries()const

• Disconnected operation information:

  • TMsvEmailEntry::SetDisconnectedOperation(TImDisconnectedOperationType), TMsvEmailEntry::DisconnectedOperation()const.

• Partial download flags: these flags allow a client to test if a message or its body has been partially downloaded (see TImImap4GetPartialMailInfo)

  • TMsvEmailEntry::SetPartialDownloaded(TBool), TMsvEmailEntry::PartialDownloaded()const

  • TMsvEmailEntry::SetBodyTextComplete(TBool), TMsvEmailEntry::BodyTextComplete()const

• UID information: IMAP messages have a unique identifier number (see RFC3501, 2.3.1.1. Unique Identifier (UID) Message Attribute)

  • TMsvEmailEntry::SetValidUID(TBool), TMsvEmailEntry::ValidUID()const

  • TMsvEmailEntry::SetUID(TUint32), TMsvEmailEntry::UID()const.

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.

• TMsvEmailEntry::VCard()const, TMsvEmailEntry::SetVCard(TBool)

• TMsvEmailEntry::VCalendar()const, TMsvEmailEntry::SetVCalendar(TBool)

• TMsvEmailEntry::ICalendar()const, TMsvEmailEntry::SetICalendar(TBool)

The following flags apply to all email protocols:

• Receipt requested: TMsvEmailEntry::Receipt()const, TMsvEmailEntry::SetReceipt(TBool)

• MHTML content: TMsvEmailEntry::MHTMLEmail()const, TMsvEmailEntry::SetMHTMLEmail(TBool)

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.

Derivation

• TMsvEntry - Represents an entry in the Message Server index.

• TMsvEmailEntry - Provides storage for and access to extra email specific information for a messag...

Members

Defined in TMsvEmailEntry:

• AnsweredIMAP4Flag()constGets the state of the \Answered IMAP4 flag.
• BodyTextComplete()constTests if body text is complete.
• DeletedIMAP4Flag()constGets the state of the \Deleted IMAP4 flag.
• DisconnectedOperation()constGets the disconnected operation type.
• DraftIMAP4Flag()constGets the state of the \Draft IMAP4 flag.
• Encrypted()constTests whether encryption is used.
• FlaggedIMAP4Flag()constGets the state of the \Flagged IMAP4 flag.
• GetIMAP4Flags(TBool &,TBool &,TBool &,TBool &,TBool &,TBool &,TBool &)Gets IMAP4-specific flags from the email entry: Unread, Seen, Answered, Flagged,...
• ICalendar()constTests if the message contains an iCalendar attachment.
• LocalSubscription()constGets the IMAP4 local subscription state for the specified folder.
• MHTMLEmail()constReturns the flag indicating if the message has an HTML body part.
• Mailbox()constTests if the specified folder is the IMAP4 Mailbox.
• MessageFolderType()constGets a flag on an IMAP MTM folder entry indicating that it stores a multipart bo...
• Orphan()constGets the IMAP4 orphaned state for the specified message/folder.
• PartialDownloaded()constTests if body text is partially downloaded.
• Receipt()constTests if the email message requests a receipt.
• RecentIMAP4Flag()constGets the state of the \Recent IMAP4 flag.
• RemoteFolderEntries()constGets the number of messages stored in the remote folder.
• SeenIMAP4Flag()constGets the state of the \Seen IMAP4 flag.
• SetAnsweredIMAP4Flag(TBool)Sets the state of the \Answered IMAP4 flag.
• SetBodyTextComplete(TBool)Sets if body text is complete.
• SetDeletedIMAP4Flag(TBool)Sets the state of the \Deleted IMAP4 flag.
• SetDisconnectedOperation(TImDisconnectedOperationType)Sets the disconnected operation type.
• SetDraftIMAP4Flag(TBool)Sets the state of the \Draft IMAP4 flag.
• SetEncrypted(TBool)Sets whether encryption is used.
• SetFlaggedIMAP4Flag(TBool)Sets the state of the \Flagged IMAP4 flag.
• SetICalendar(TBool)Sets a flag that the message contains an iCalendar attachment.
• SetIMAP4Flags(TBool,TBool,TBool,TBool,TBool,TBool,TBool)Sets IMAP4-specific flags from the email entry: Unread, Seen, Answered, Flagged,...
• SetLocalSubscription(TBool)Sets the IMAP4 local subscription state for the specified folder.
• SetMHTMLEmail(TBool)Sets the flag indicating if the message has an HTML body part.
• SetMailbox(TBool)Sets if the specified folder is the IMAP4 Mailbox.
• SetMessageFolderType(TImEmailFolderType)Sets a flag on an IMAP MTM folder entry indicating that it stores a multipart bo...
• SetOrphan(TBool)Sets the IMAP4 orphaned state for the specified message/folder.
• SetPartialDownloaded(TBool)Sets if the body text is partially downloaded.
• SetReceipt(TBool)Sets a flag that the email message requests a receipt.
• SetRecentIMAP4Flag(TBool)Sets the state of the \Recent IMAP4 flag.
• SetRemoteFolderEntries(TInt)Sets the number of messages stored in the remote folder.
• SetSeenIMAP4Flag(TBool)Sets the state of the \Seen IMAP4 flag.
• SetSigned(TBool)Sets whether signing is used.
• SetSubscribed(TBool)Sets the IMAP4 subscription state for the specified folder.
• SetUID(TUint32)Sets the IMAP4 UID (unique identifier) for the specified message/folder.
• SetUnreadIMAP4Flag(TBool)Sets the state of the unread messages IMAP4 flag.
• SetVCalendar(TBool)Sets a flag that the message contains a VCal attachment.
• SetVCard(TBool)Sets a flag that the message contains a VCard attachment.
• SetValidUID(TBool)Sets the IMAP4 UID (unique identifier) validity for the specified folder.
• Signed()constTests whether signing is used.
• Subscribed()constGets the IMAP4 subscription state for the specified folder.
• TMsvEmailEntry()Default constructor.
• TMsvEmailEntry(const TMsvEntry &)Copy constructor using a TMsvEntry object.
• UID()constGets the IMAP4 UID (unique identifier) for the specified message/folder.
• UnreadIMAP4Flag()constGets the state of the unread messages IMAP4 flag.
• VCalendar()constTests if the message contains a VCal attachment.
• VCard()constTests if the message contains a VCard attachment.
• ValidUID()constGets the IMAP4 UID (unique identifier) validity for the specified folder.
• operator==(const TMsvEmailEntry &)constEquality operator for comparison to a TMsvEmailEntry.
• operator==(const TMsvEntry &)constEquality operator for comparison to a TMsvEntry.

Inherited from TMsvEntry:

• Attachment()constGets the value of the attachment flag.
• Complete()constGets the value of the message complete flag.
• Connected()constGets the value of the remote server connection flag.
• DecPcSyncCount()Decrements the PC synchronisation field.
• DeleteProtected()constreturns the delete protected state
• Deleted()constGets the value of the deleted flag.
• ExternalizeL(RWriteStream &)constWrites the object into the stream specified.
• Failed()constGets the value of the message send failed flag.
• Forwarded()constreturns the forwarded state
• Id()constGets the value of the entry ID.
• InPreparation()constGets the value of the in preparation flag.
• IncPcSyncCount()Increments the PC synchronisation field.
• InternalizeL(RReadStream &)Reads an externalised object from the specified stream.
• LocallyDeleted()constreturns the locally deleted state
• MtmData1()constGets the integer value of iMtmData1
• MtmData2()constGets the integer value of iMtmData2
• MtmData3()constGets the integer value of iMtmData3
• MultipleRecipients()constGets the value of the multiple recipients flag.
• New()constGets the value of the new message flag.
• OffPeak()constGets the off-peak flag.
• Operation()constGets the value of the disconnected operation queued flag.
• Owner()constGets the value of the owner flag.
• Parent()constGets the value of the parent ID.
• PcSyncCount()constGets the value of the PC synchronisation field.
• PendingConditions()constGets the pending conditions flag.
• PendingDelete()const
• PermanentDataUnchanged(const TMsvEntry &)constCompares if the flag settings in two index entries are the same. The Connected a...
• PersistedFlags()const
• Priority()constGets the value of the message priority field.
• ReadOnly()constGets the value of the read-only flag.
• Scheduled()constGets the scheduled flag.
• SendingState()constGets the sending state.
• SetAttachment(TBool)Sets the attachment flag.
• SetComplete(TBool)Sets the message complete flag.
• SetConnected(TBool)Sets the remote server connection flag.
• SetDeleteProtected(TBool)This method sets bit 24 of iMtmData1, if you are using this bit elsewhere don't ...
• SetDeleted(TBool)
• SetFailed(TBool)Sets the message send failed flag.
• SetForwarded(TBool)This method sets bit 31 of iMtmData1, if you are using this bit elsewhere don't ...
• SetId(TMsvId)
• SetInPreparation(TBool)Sets the in-preparation flag.
• SetLocallyDeleted(TBool)This method sets bit 32 of iMtmData1, if you are using this bit elsewhere don't ...
• SetMultipleRecipients(TBool)Sets the multiple recipients flag.
• SetNew(TBool)Sets the message new flag.
• SetOffPeak(TBool)Sets the off-peak flag.
• SetOperation(TBool)Sets the disconnected operation queued flag.
• SetOwner(TBool)
• SetParent(TMsvId)
• SetPendingConditions(TBool)Sets the pending conditions flag.
• SetPendingDelete(TBool)
• SetPriority(TMsvPriority)Sets the message priority.
• SetReadOnly(TBool)Sets the read-only flag.
• SetScheduled(TBool)Sets the scheduled flag.
• SetSendingState(TUint)Sets the sending state.
• SetStandardFolder(TBool)
• SetUnread(TBool)Sets the message unread flag.
• SetVisible(TBool)Sets the entry visible flag.
• StandardFolder()constGets the value of the standard folder flag.
• TMsvEntry(const TMsvEntry &)Copy constructor.
• TemporaryFlags()const
• Unread()constGets the value of the message unread flag.
• Visible()constGets the value of the entry visible flag.
• iBioTypeBIO message type
• iDate Time
• iDescriptionDescription
• iDetailsDetails
• iErrorError
• iMtmMTM
• iMtmData1MTM data 1: this can be used for any purpose by an MTM. This member must only be...
• iMtmData2MTM data 2: this can be used for any purpose by an MTM. This member must only be...
• iMtmData3MTM data 3: this can be used for any purpose by an MTM. This member must only be...
• iRelatedIdRelated folder ID.
• iServiceIdService ID.
• iSizeSize
• iTypeEntry type
• operator=(const TMsvEntry &)Overloaded assignment operator.

See also:

• CImap4ClientMtmIMAP4 client MTM interface, providing access to the email services using the IMA...

IMPORT_C TMsvEmailEntry();

Description

Default constructor.

IMPORT_C TMsvEmailEntry(const TMsvEntry &aGenericEntry);

Description

Copy constructor using a TMsvEntry object.

Parameters

IMPORT_C TBool operator==(const TMsvEntry &aEntry) const;

Description

Equality operator for comparison to a TMsvEntry.

Parameters

Return value

IMPORT_C TBool operator==(const TMsvEmailEntry &aEntry) const;

Description

Equality operator for comparison to a TMsvEmailEntry.

Parameters

Return value

IMPORT_C void GetIMAP4Flags(TBool &rUnread, TBool &rSeen, TBool &rAnswered, TBool &rFlagged, TBool &rDeleted, TBool &rDraft, TBool &rRecent);

Description

Gets IMAP4-specific flags from the email entry: Unread, Seen, Answered, Flagged, Deleted, Draft and Recent.

Parameters

IMPORT_C void SetIMAP4Flags(TBool aUnread, TBool aSeen, TBool aAnswered, TBool aFlagged, TBool aDeleted, TBool aDraft, TBool aRecent);

Description

Sets IMAP4-specific flags from the email entry: Unread, Seen, Answered, Flagged, Deleted, Draft and Recent.

Parameters

IMPORT_C void SetMessageFolderType(TImEmailFolderType aFolderType);

Description

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.

Parameters

IMPORT_C TImEmailFolderType MessageFolderType() const;

Description

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.

Return value

IMPORT_C void SetDisconnectedOperation(TImDisconnectedOperationType aDisconnectedOperationType);

Description

Sets the disconnected operation type.

Parameters

IMPORT_C TImDisconnectedOperationType DisconnectedOperation() const;

Description

Gets the disconnected operation type.

Return value

IMPORT_C void SetPartialDownloaded(TBool aPartialDownloaded);

Description

Sets if the body text is partially downloaded.

Parameters

IMPORT_C TBool PartialDownloaded() const;

Description

Tests if body text is partially downloaded.

Return value

inline void SetEncrypted(TBool aEncrypt);

Description

Sets whether encryption is used.

Not currently used.

Parameters

inline TBool Encrypted() const;

Description

Tests whether encryption is used.

Not currently used.

Return value

inline void SetSigned(TBool aSignature);

Description

Sets whether signing is used.

Not currently used.

Parameters

inline TBool Signed() const;

Description

Tests whether signing is used.

Not currently used.

Return value

inline TBool VCard() const;

Description

Tests if the message contains a VCard attachment.

Return value

inline void SetVCard(TBool aVCard);

Description

Sets a flag that the message contains a VCard attachment.

Parameters

inline TBool VCalendar() const;

Description

Tests if the message contains a VCal attachment.

Return value

inline void SetVCalendar(TBool aVCal);

Description

Sets a flag that the message contains a VCal attachment.

Parameters

inline TBool ICalendar() const;

Description

Tests if the message contains an iCalendar attachment.

Return value

inline void SetICalendar(TBool aICal);

Description

Sets a flag that the message contains an iCalendar attachment.

Parameters

inline TBool Receipt() const;

Description

Tests if the email message requests a receipt.

Return value

inline void SetReceipt(TBool aReceipt);

Description

Sets a flag that the email message requests a receipt.

Parameters

inline TBool MHTMLEmail() const;

Description

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.

Return value

See also:

• CImEmailMessageThis class can be used to manipulate new emails that have been created using CIm...

inline void SetMHTMLEmail(TBool aMhtml);

Description

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.

Parameters

See also:

• CImEmailMessageThis class can be used to manipulate new emails that have been created using CIm...

inline TBool BodyTextComplete() const;

Description

Tests if body text is complete.

Return value

inline void SetBodyTextComplete(TBool aFlag);

Description

Sets if body text is complete.

Parameters

inline void SetUnreadIMAP4Flag(TBool aUnread);

Description

Sets the state of the unread messages IMAP4 flag.

Parameters

inline TBool UnreadIMAP4Flag() const;

Description

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.

Return value

See also:

• TMsvEmailEntry::SeenIMAP4Flag()constGets the state of the \Seen IMAP4 flag.

inline void SetSeenIMAP4Flag(TBool aSeen);

Description

Sets the state of the \Seen IMAP4 flag.

Parameters

inline TBool SeenIMAP4Flag() const;

Description

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()const flag set. If on synchronisation a folder contains new messages, the Unread flag will also be set on the folder.

Return value

See also:

• CImImap4Settings::UpdatingSeenFlags()constRetrieves whether the IMAP4 seen flag of new messages will be set on the server ...

inline void SetAnsweredIMAP4Flag(TBool aAnswered);

Description

Sets the state of the \Answered IMAP4 flag.

Parameters

inline TBool AnsweredIMAP4Flag() const;

Description

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.

Return value

inline void SetFlaggedIMAP4Flag(TBool aFlagged);

Description

Sets the state of the \Flagged IMAP4 flag.

Parameters

inline TBool FlaggedIMAP4Flag() const;

Description

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.

Return value

inline void SetDeletedIMAP4Flag(TBool aDeleted);

Description

Sets the state of the \Deleted IMAP4 flag.

Parameters

inline TBool DeletedIMAP4Flag() const;

Description

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.

Return value

inline void SetDraftIMAP4Flag(TBool aDraft);

Description

Sets the state of the \Draft IMAP4 flag.

Parameters

inline TBool DraftIMAP4Flag() const;

Description

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.

Return value

inline void SetRecentIMAP4Flag(TBool aRecent);

Description

Sets the state of the \Recent IMAP4 flag.

Parameters

inline TBool RecentIMAP4Flag() const;

Description

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.

Return value

inline void SetMailbox(TBool aMailbox);

Description

Sets if the specified folder is the IMAP4 Mailbox.

Parameters

inline TBool Mailbox() const;

Description

Tests if the specified folder is the IMAP4 Mailbox.

Return value

inline TBool Orphan() const;

Description

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.

Return value

inline void SetOrphan(TBool aOrphan);

Description

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.

Parameters

inline void SetValidUID(TBool aValid);

Description

Sets the IMAP4 UID (unique identifier) validity for the specified folder.

Parameters

inline TBool ValidUID() const;

Description

Gets the IMAP4 UID (unique identifier) validity for the specified folder.

Return value

inline void SetSubscribed(TBool aSubscribed);

Description

Sets the IMAP4 subscription state for the specified folder.

Parameters

inline TBool Subscribed() const;

Description

Gets the IMAP4 subscription state for the specified folder.

Return value

inline void SetLocalSubscription(TBool aLocal);

Description

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()const)

• 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.

Parameters

inline TBool LocalSubscription() const;

Description

Gets the IMAP4 local subscription state for the specified folder.

Return value

inline void SetUID(TUint32 aUid);

Description

Sets the IMAP4 UID (unique identifier) for the specified message/folder.

Parameters

inline TUint32 UID() const;

Description

Gets the IMAP4 UID (unique identifier) for the specified message/folder.

Return value

inline TInt RemoteFolderEntries() const;

Description

Gets the number of messages stored in the remote folder.

Return value

inline void SetRemoteFolderEntries(TInt aEntries);

Description

Sets the number of messages stored in the remote folder.

Parameters