TMsvEmailEntry Class Reference

#include <mw/miuthdr.h>

class TMsvEmailEntry : public TMsvEntry

Inherits from

Public Member Functions
TMsvEmailEntry()
TMsvEmailEntry(const TMsvEntry &)
TBool AnsweredIMAP4Flag()
TBool BodyTextComplete()
TBool DeletedIMAP4Flag()
IMPORT_C TImDisconnectedOperationTypeDisconnectedOperation()
TBool DraftIMAP4Flag()
TBool Encrypted()
TBool FlaggedIMAP4Flag()
IMPORT_C voidGetIMAP4Flags(TBool &, TBool &, TBool &, TBool &, TBool &, TBool &, TBool &)
TBool ICalendar()
TBool LocalSubscription()
TBool MHTMLEmail()
TBool Mailbox()
IMPORT_C TImEmailFolderTypeMessageFolderType()
TBool Orphan()
IMPORT_C TBoolPartialDownloaded()
TBool Receipt()
TBool RecentIMAP4Flag()
TInt RemoteFolderEntries()
TBool SeenIMAP4Flag()
voidSetAnsweredIMAP4Flag(TBool)
voidSetBodyTextComplete(TBool)
voidSetDeletedIMAP4Flag(TBool)
IMPORT_C voidSetDisconnectedOperation(TImDisconnectedOperationType)
voidSetDraftIMAP4Flag(TBool)
voidSetEncrypted(TBool)
voidSetFlaggedIMAP4Flag(TBool)
voidSetICalendar(TBool)
IMPORT_C voidSetIMAP4Flags(TBool, TBool, TBool, TBool, TBool, TBool, TBool)
voidSetLocalSubscription(TBool)
voidSetMHTMLEmail(TBool)
voidSetMailbox(TBool)
IMPORT_C voidSetMessageFolderType(TImEmailFolderType)
voidSetOrphan(TBool)
IMPORT_C voidSetPartialDownloaded(TBool)
voidSetReceipt(TBool)
voidSetRecentIMAP4Flag(TBool)
voidSetRemoteFolderEntries(TInt)
voidSetSeenIMAP4Flag(TBool)
voidSetSigned(TBool)
voidSetSubscribed(TBool)
voidSetUID(TUint32)
voidSetUnreadIMAP4Flag(TBool)
voidSetVCalendar(TBool)
voidSetVCard(TBool)
voidSetValidUID(TBool)
TBool Signed()
TBool Subscribed()
TUint32 UID()
TBool UnreadIMAP4Flag()
TBool VCalendar()
TBool VCard()
TBool ValidUID()
IMPORT_C TBooloperator==(const TMsvEntry &)
IMPORT_C TBooloperator==(const TMsvEmailEntry &)
Inherited Attributes
TMsvEntry::iBioType
TMsvEntry::iDate
TMsvEntry::iDescription
TMsvEntry::iDetails
TMsvEntry::iError
TMsvEntry::iMtm
TMsvEntry::iMtmData1
TMsvEntry::iMtmData2
TMsvEntry::iMtmData3
TMsvEntry::iRelatedId
TMsvEntry::iServiceId
TMsvEntry::iSize
TMsvEntry::iType
Inherited Functions
TMsvEntry::Attachment()const
TMsvEntry::Complete()const
TMsvEntry::Connected()const
TMsvEntry::DecPcSyncCount()
TMsvEntry::DeleteProtected()const
TMsvEntry::Deleted()const
TMsvEntry::ExternalizeL(RWriteStream &)const
TMsvEntry::Failed()const
TMsvEntry::Forwarded()const
TMsvEntry::Id()const
TMsvEntry::InPreparation()const
TMsvEntry::IncPcSyncCount()
TMsvEntry::InternalizeL(RReadStream &)
TMsvEntry::LocallyDeleted()const
TMsvEntry::MtmData1()const
TMsvEntry::MtmData2()const
TMsvEntry::MtmData3()const
TMsvEntry::MultipleRecipients()const
TMsvEntry::New()const
TMsvEntry::OffPeak()const
TMsvEntry::Operation()const
TMsvEntry::Owner()const
TMsvEntry::Parent()const
TMsvEntry::PcSyncCount()const
TMsvEntry::PendingConditions()const
TMsvEntry::PendingDelete()const
TMsvEntry::PermanentDataUnchanged(const TMsvEntry &)const
TMsvEntry::PersistedFlags()const
TMsvEntry::Priority()const
TMsvEntry::ReadOnly()const
TMsvEntry::Scheduled()const
TMsvEntry::SendingState()const
TMsvEntry::SetAttachment(TBool)
TMsvEntry::SetComplete(TBool)
TMsvEntry::SetConnected(TBool)
TMsvEntry::SetDeleteProtected(TBool)
TMsvEntry::SetDeleted(TBool)
TMsvEntry::SetFailed(TBool)
TMsvEntry::SetForwarded(TBool)
TMsvEntry::SetId(TMsvId)
TMsvEntry::SetInPreparation(TBool)
TMsvEntry::SetLocallyDeleted(TBool)
TMsvEntry::SetMtmData1(TInt32)
TMsvEntry::SetMtmData2(TInt32)
TMsvEntry::SetMtmData3(TInt32)
TMsvEntry::SetMultipleRecipients(TBool)
TMsvEntry::SetNew(TBool)
TMsvEntry::SetOffPeak(TBool)
TMsvEntry::SetOperation(TBool)
TMsvEntry::SetOwner(TBool)
TMsvEntry::SetParent(TMsvId)
TMsvEntry::SetPendingConditions(TBool)
TMsvEntry::SetPendingDelete(TBool)
TMsvEntry::SetPriority(TMsvPriority)
TMsvEntry::SetReadOnly(TBool)
TMsvEntry::SetScheduled(TBool)
TMsvEntry::SetSendingState(TUint)
TMsvEntry::SetStandardFolder(TBool)
TMsvEntry::SetUnread(TBool)
TMsvEntry::SetVisible(TBool)
TMsvEntry::SetVisibleFolderFlag(TBool)
TMsvEntry::StandardFolder()const
TMsvEntry::TMsvEntry()
TMsvEntry::TMsvEntry(const TMsvEntry &)
TMsvEntry::TemporaryFlags()const
TMsvEntry::Unread()const
TMsvEntry::Visible()const
TMsvEntry::VisibleFolderFlag()const
TMsvEntry::operator=(const TMsvEntry &)

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

See also: CImap4ClientMtm

Constructor & Destructor Documentation

TMsvEmailEntry ( )

IMPORT_CTMsvEmailEntry()

TMsvEmailEntry ( const TMsvEntry & )

IMPORT_CTMsvEmailEntry(const TMsvEntry &aGenericEntry)

Member Function Documentation

AnsweredIMAP4Flag ( )

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.

Return Value
\Answered IMAP4 flag

BodyTextComplete ( )

TBool BodyTextComplete()const [inline]

Tests if body text is complete.

Return Value
True if body text is complete.

DeletedIMAP4Flag ( )

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.

Return Value
\Deleted IMAP4 flag

DisconnectedOperation ( )

IMPORT_C TImDisconnectedOperationTypeDisconnectedOperation()const

DraftIMAP4Flag ( )

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.

Return Value
\Draft IMAP4 flag

Encrypted ( )

TBool Encrypted()const [inline]

Tests whether encryption is used.

Not currently used.

Return Value
True if encryption is used

FlaggedIMAP4Flag ( )

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.

Return Value
\Flagged IMAP4 flag

GetIMAP4Flags ( TBool &, TBool &, TBool &, TBool &, TBool &, TBool &, TBool & )

IMPORT_C voidGetIMAP4Flags(TBool &rUnread,
TBool &rSeen,
TBool &rAnswered,
TBool &rFlagged,
TBool &rDeleted,
TBool &rDraft,
TBool &rRecent
)

ICalendar ( )

TBool ICalendar()const [inline]

Tests if the message contains an iCalendar attachment.

Return Value
True if the message contains an iCalendar attachment

LocalSubscription ( )

TBool LocalSubscription()const [inline]

Gets the IMAP4 local subscription state for the specified folder.

Return Value
IMAP4 local subscription state

MHTMLEmail ( )

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.

See also: CImEmailMessage

Return Value
True if the message has an HTML body part

Mailbox ( )

TBool Mailbox()const [inline]

Tests if the specified folder is the IMAP4 Mailbox.

Return Value
True if the specified folder is the Mailbox

MessageFolderType ( )

IMPORT_C TImEmailFolderTypeMessageFolderType()const

Orphan ( )

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.

Return Value
True if the specified entry is orphaned

PartialDownloaded ( )

IMPORT_C TBoolPartialDownloaded()const

Receipt ( )

TBool Receipt()const [inline]

Tests if the email message requests a receipt.

Return Value
True if the email message requests a receipt

RecentIMAP4Flag ( )

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.

Return Value
\Recent IMAP4 flag

RemoteFolderEntries ( )

TInt RemoteFolderEntries()const [inline]

Gets the number of messages stored in the remote folder.

Return Value
Number of messages

SeenIMAP4Flag ( )

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.

See also: CImImap4Settings::UpdatingSeenFlags()

Return Value
\Seen IMAP4 flag

SetAnsweredIMAP4Flag ( TBool )

voidSetAnsweredIMAP4Flag(TBoolaAnswered)[inline]

Sets the state of the \Answered IMAP4 flag.

Parameters
aAnswered\Answered IMAP4 flag

SetBodyTextComplete ( TBool )

voidSetBodyTextComplete(TBoolaFlag)[inline]

Sets if body text is complete.

Parameters
aFlagTrue if body text is complete.

SetDeletedIMAP4Flag ( TBool )

voidSetDeletedIMAP4Flag(TBoolaDeleted)[inline]

Sets the state of the \Deleted IMAP4 flag.

Parameters
aDeleted\Deleted IMAP4 flag

SetDisconnectedOperation ( TImDisconnectedOperationType )

IMPORT_C voidSetDisconnectedOperation(TImDisconnectedOperationTypeaDisconnectedOperationType)

SetDraftIMAP4Flag ( TBool )

voidSetDraftIMAP4Flag(TBoolaDraft)[inline]

Sets the state of the \Draft IMAP4 flag.

Parameters
aDraft\Draft IMAP4 flag

SetEncrypted ( TBool )

voidSetEncrypted(TBoolaEncrypt)[inline]

Sets whether encryption is used.

Not currently used.

Parameters
aEncryptTrue if encryption is used

SetFlaggedIMAP4Flag ( TBool )

voidSetFlaggedIMAP4Flag(TBoolaFlagged)[inline]

Sets the state of the \Flagged IMAP4 flag.

Parameters
aFlagged\Flagged IMAP4 flag

SetICalendar ( TBool )

voidSetICalendar(TBoolaICal)[inline]

Sets a flag that the message contains an iCalendar attachment.

Parameters
aICalTrue if the message contains an iCalendar attachment

SetIMAP4Flags ( TBool, TBool, TBool, TBool, TBool, TBool, TBool )

IMPORT_C voidSetIMAP4Flags(TBoolaUnread,
TBoolaSeen,
TBoolaAnswered,
TBoolaFlagged,
TBoolaDeleted,
TBoolaDraft,
TBoolaRecent
)

SetLocalSubscription ( TBool )

voidSetLocalSubscription(TBoolaLocal)[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.

Parameters
aLocalIMAP4 local subscription state

SetMHTMLEmail ( TBool )

voidSetMHTMLEmail(TBoolaMhtml)[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.

See also: CImEmailMessage

Parameters
aMhtmlTrue if the message has an HTML body part

SetMailbox ( TBool )

voidSetMailbox(TBoolaMailbox)[inline]

Sets if the specified folder is the IMAP4 Mailbox.

Parameters
aMailboxTrue if the specified folder is the Mailbox

SetMessageFolderType ( TImEmailFolderType )

IMPORT_C voidSetMessageFolderType(TImEmailFolderTypeaFolderType)

SetOrphan ( TBool )

voidSetOrphan(TBoolaOrphan)[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.

Parameters
aOrphanTrue if the specified entry is orphaned

SetPartialDownloaded ( TBool )

IMPORT_C voidSetPartialDownloaded(TBoolaPartialDownloaded)

SetReceipt ( TBool )

voidSetReceipt(TBoolaReceipt)[inline]

Sets a flag that the email message requests a receipt.

Parameters
aReceiptTrue if the email message requests a receipt

SetRecentIMAP4Flag ( TBool )

voidSetRecentIMAP4Flag(TBoolaRecent)[inline]

Sets the state of the \Recent IMAP4 flag.

Parameters
aRecent\Recent IMAP4 flag

SetRemoteFolderEntries ( TInt )

voidSetRemoteFolderEntries(TIntaEntries)[inline]

Sets the number of messages stored in the remote folder.

Parameters
aEntriesNumber of messages

SetSeenIMAP4Flag ( TBool )

voidSetSeenIMAP4Flag(TBoolaSeen)[inline]

Sets the state of the \Seen IMAP4 flag.

Parameters
aSeen\Seen IMAP4 flag

SetSigned ( TBool )

voidSetSigned(TBoolaSignature)[inline]

Sets whether signing is used.

Not currently used.

Parameters
aSignatureTrue if signing is used

SetSubscribed ( TBool )

voidSetSubscribed(TBoolaSubscribed)[inline]

Sets the IMAP4 subscription state for the specified folder.

Parameters
aSubscribedIMAP4 subscription state

SetUID ( TUint32 )

voidSetUID(TUint32aUid)[inline]

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

Parameters
aUidIMAP4 UID

SetUnreadIMAP4Flag ( TBool )

voidSetUnreadIMAP4Flag(TBoolaUnread)[inline]

Sets the state of the unread messages IMAP4 flag.

Parameters
aUnreadUnread messages IMAP4 flag

SetVCalendar ( TBool )

voidSetVCalendar(TBoolaVCal)[inline]

Sets a flag that the message contains a VCal attachment.

Parameters
aVCalTrue if the message contains a VCal attachment

SetVCard ( TBool )

voidSetVCard(TBoolaVCard)[inline]

Sets a flag that the message contains a VCard attachment.

Parameters
aVCardTrue if the message contains a VCard attachment

SetValidUID ( TBool )

voidSetValidUID(TBoolaValid)[inline]

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

Parameters
aValidTrue if IMAP4 UID validity is set

Signed ( )

TBool Signed()const [inline]

Tests whether signing is used.

Not currently used.

Return Value
True if signing is used

Subscribed ( )

TBool Subscribed()const [inline]

Gets the IMAP4 subscription state for the specified folder.

Return Value
IMAP4 subscription state

UID ( )

TUint32 UID()const [inline]

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

Return Value
IMAP4 UID

UnreadIMAP4Flag ( )

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.

See also: TMsvEmailEntry::SeenIMAP4Flag()

Return Value
Unread messages IMAP4 flag

VCalendar ( )

TBool VCalendar()const [inline]

Tests if the message contains a VCal attachment.

Return Value
True if the message contains a VCal attachment

VCard ( )

TBool VCard()const [inline]

Tests if the message contains a VCard attachment.

Return Value
True if the message contains a VCard attachment

ValidUID ( )

TBool ValidUID()const [inline]

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

Return Value
True if IMAP4 UID validity is set

operator== ( const TMsvEntry & )

IMPORT_C TBooloperator==(const TMsvEntry &aEntry)const

operator== ( const TMsvEmailEntry & )

IMPORT_C TBooloperator==(const TMsvEmailEntry &aEntry)const
© Nokia 2005.