Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: MIUTHDR.H
Link against: imcm.lib

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:

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:

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

Members

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

See also:


Construction and destruction


TMsvEmailEntry()

IMPORT_C TMsvEmailEntry();

Description

Default constructor.


TMsvEmailEntry()

IMPORT_C TMsvEmailEntry(const TMsvEntry &aGenericEntry);

Description

Copy constructor using a TMsvEntry object.

Parameters

const TMsvEntry &aGenericEntry

Object to copy

[Top]


Member functions


operator==()

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

Description

Equality operator for comparison to a TMsvEntry.

Parameters

const TMsvEntry &aEntry

Object to compare against

Return value

TBool

True if equal


operator==()

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

Description

Equality operator for comparison to a TMsvEmailEntry.

Parameters

const TMsvEmailEntry &aEntry

Object to compare against

Return value

TBool

True if equal


GetIMAP4Flags()

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

TBool &rUnread

Unread flag

TBool &rSeen

Seen flag

TBool &rAnswered

Answered flag

TBool &rFlagged

Flagged flag

TBool &rDeleted

Deleted flag

TBool &rDraft

Draft flag

TBool &rRecent

Recent flag


SetIMAP4Flags()

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

TBool aUnread

Unread flag

TBool aSeen

Seen flag

TBool aAnswered

Answered flag

TBool aFlagged

Flagged flag

TBool aDeleted

Deleted flag

TBool aDraft

Draft flag

TBool aRecent

Recent flag


SetMessageFolderType()

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

TImEmailFolderType aFolderType

Folder type


MessageFolderType()

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

TImEmailFolderType

Folder type


SetDisconnectedOperation()

IMPORT_C void SetDisconnectedOperation(TImDisconnectedOperationType aDisconnectedOperationType);

Description

Sets the disconnected operation type.

Parameters

TImDisconnectedOperationType aDisconnectedOperationType

Disconnected operation type


DisconnectedOperation()

IMPORT_C TImDisconnectedOperationType DisconnectedOperation() const;

Description

Gets the disconnected operation type.

Return value

TImDisconnectedOperationType

Disconnected operation type


SetPartialDownloaded()

IMPORT_C void SetPartialDownloaded(TBool aPartialDownloaded);

Description

Sets if the body text is partially downloaded.

Parameters

TBool aPartialDownloaded

True if body text is partially downloaded.


PartialDownloaded()

IMPORT_C TBool PartialDownloaded() const;

Description

Tests if body text is partially downloaded.

Return value

TBool

True if body text is partially downloaded.


SetEncrypted()

inline void SetEncrypted(TBool aEncrypt);

Description

Sets whether encryption is used.

Not currently used.

Parameters

TBool aEncrypt

True if encryption is used


Encrypted()

inline TBool Encrypted() const;

Description

Tests whether encryption is used.

Not currently used.

Return value

TBool

True if encryption is used


SetSigned()

inline void SetSigned(TBool aSignature);

Description

Sets whether signing is used.

Not currently used.

Parameters

TBool aSignature

True if signing is used


Signed()

inline TBool Signed() const;

Description

Tests whether signing is used.

Not currently used.

Return value

TBool

True if signing is used


VCard()

inline TBool VCard() const;

Description

Tests if the message contains a VCard attachment.

Return value

TBool

True if the message contains a VCard attachment


SetVCard()

inline void SetVCard(TBool aVCard);

Description

Sets a flag that the message contains a VCard attachment.

Parameters

TBool aVCard

True if the message contains a VCard attachment


VCalendar()

inline TBool VCalendar() const;

Description

Tests if the message contains a VCal attachment.

Return value

TBool

True if the message contains a VCal attachment


SetVCalendar()

inline void SetVCalendar(TBool aVCal);

Description

Sets a flag that the message contains a VCal attachment.

Parameters

TBool aVCal

True if the message contains a VCal attachment


ICalendar()

inline TBool ICalendar() const;

Description

Tests if the message contains an iCalendar attachment.

Return value

TBool

True if the message contains an iCalendar attachment


SetICalendar()

inline void SetICalendar(TBool aICal);

Description

Sets a flag that the message contains an iCalendar attachment.

Parameters

TBool aICal

True if the message contains an iCalendar attachment


Receipt()

inline TBool Receipt() const;

Description

Tests if the email message requests a receipt.

Return value

TBool

True if the email message requests a receipt


SetReceipt()

inline void SetReceipt(TBool aReceipt);

Description

Sets a flag that the email message requests a receipt.

Parameters

TBool aReceipt

True if the email message requests a receipt


MHTMLEmail()

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

TBool

True if the message has an HTML body part

See also:


SetMHTMLEmail()

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

TBool aMhtml

True if the message has an HTML body part

See also:


BodyTextComplete()

inline TBool BodyTextComplete() const;

Description

Tests if body text is complete.

Return value

TBool

True if body text is complete.


SetBodyTextComplete()

inline void SetBodyTextComplete(TBool aFlag);

Description

Sets if body text is complete.

Parameters

TBool aFlag

True if body text is complete.


SetUnreadIMAP4Flag()

inline void SetUnreadIMAP4Flag(TBool aUnread);

Description

Sets the state of the unread messages IMAP4 flag.

Parameters

TBool aUnread

Unread messages IMAP4 flag


UnreadIMAP4Flag()

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

TBool

Unread messages IMAP4 flag

See also:


SetSeenIMAP4Flag()

inline void SetSeenIMAP4Flag(TBool aSeen);

Description

Sets the state of the \Seen IMAP4 flag.

Parameters

TBool aSeen

\Seen IMAP4 flag


SeenIMAP4Flag()

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

Return value

TBool

\Seen IMAP4 flag

See also:


SetAnsweredIMAP4Flag()

inline void SetAnsweredIMAP4Flag(TBool aAnswered);

Description

Sets the state of the \Answered IMAP4 flag.

Parameters

TBool aAnswered

\Answered IMAP4 flag


AnsweredIMAP4Flag()

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

TBool

\Answered IMAP4 flag


SetFlaggedIMAP4Flag()

inline void SetFlaggedIMAP4Flag(TBool aFlagged);

Description

Sets the state of the \Flagged IMAP4 flag.

Parameters

TBool aFlagged

\Flagged IMAP4 flag


FlaggedIMAP4Flag()

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

TBool

\Flagged IMAP4 flag


SetDeletedIMAP4Flag()

inline void SetDeletedIMAP4Flag(TBool aDeleted);

Description

Sets the state of the \Deleted IMAP4 flag.

Parameters

TBool aDeleted

\Deleted IMAP4 flag


DeletedIMAP4Flag()

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

TBool

\Deleted IMAP4 flag


SetDraftIMAP4Flag()

inline void SetDraftIMAP4Flag(TBool aDraft);

Description

Sets the state of the \Draft IMAP4 flag.

Parameters

TBool aDraft

\Draft IMAP4 flag


DraftIMAP4Flag()

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

TBool

\Draft IMAP4 flag


SetRecentIMAP4Flag()

inline void SetRecentIMAP4Flag(TBool aRecent);

Description

Sets the state of the \Recent IMAP4 flag.

Parameters

TBool aRecent

\Recent IMAP4 flag


RecentIMAP4Flag()

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

TBool

\Recent IMAP4 flag


SetMailbox()

inline void SetMailbox(TBool aMailbox);

Description

Sets if the specified folder is the IMAP4 Mailbox.

Parameters

TBool aMailbox

True if the specified folder is the Mailbox


Mailbox()

inline TBool Mailbox() const;

Description

Tests if the specified folder is the IMAP4 Mailbox.

Return value

TBool

True if the specified folder is the Mailbox


Orphan()

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

TBool

True if the specified entry is orphaned


SetOrphan()

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

TBool aOrphan

True if the specified entry is orphaned


SetValidUID()

inline void SetValidUID(TBool aValid);

Description

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

Parameters

TBool aValid

True if IMAP4 UID validity is set


ValidUID()

inline TBool ValidUID() const;

Description

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

Return value

TBool

True if IMAP4 UID validity is set


SetSubscribed()

inline void SetSubscribed(TBool aSubscribed);

Description

Sets the IMAP4 subscription state for the specified folder.

Parameters

TBool aSubscribed

IMAP4 subscription state


Subscribed()

inline TBool Subscribed() const;

Description

Gets the IMAP4 subscription state for the specified folder.

Return value

TBool

IMAP4 subscription state


SetLocalSubscription()

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:

Note that clients can use the KIMAP4MTMLocalSubscribe command to set this flag and save the change to the entry.

Parameters

TBool aLocal

IMAP4 local subscription state


LocalSubscription()

inline TBool LocalSubscription() const;

Description

Gets the IMAP4 local subscription state for the specified folder.

Return value

TBool

IMAP4 local subscription state


SetUID()

inline void SetUID(TUint32 aUid);

Description

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

Parameters

TUint32 aUid

IMAP4 UID


UID()

inline TUint32 UID() const;

Description

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

Return value

TUint32

IMAP4 UID


RemoteFolderEntries()

inline TInt RemoteFolderEntries() const;

Description

Gets the number of messages stored in the remote folder.

Return value

TInt

Number of messages


SetRemoteFolderEntries()

inline void SetRemoteFolderEntries(TInt aEntries);

Description

Sets the number of messages stored in the remote folder.

Parameters

TInt aEntries

Number of messages