EmailInterface::MMailboxData Class Reference

#include <app/memailmailboxdata.h>

class EmailInterface::MMailboxData
Public Member Functions
pure virtual const TDesC &BrandingIcon()
pure virtual TBool IsOutboxEmpty()
pure virtual const RPointerArray< MMessageData > &LatestMessagesL()
pure virtual MEmailLaunchParameters &LaunchParameters()
pure virtual TUint MailboxId()
pure virtual TInt MessageCount()
pure virtual const TDesC &Name()
pure virtual TBool Unseen()

Detailed Description

Container interface for mailbox related info

Member Function Documentation

BrandingIcon ( )

const TDesC &BrandingIcon()const [pure virtual]

Accessor for mailbox branding icon specifier

Returns: path descriptor to branding icon e.g. "mif(z:\\resource\\apps\\myemailplugin.mif N1 N2)", where N1 is integer specifying the icon number in the mif file, and N2 is the number of the respective icon mask

IsOutboxEmpty ( )

TBool IsOutboxEmpty()const [pure virtual]

Is mailbox's outbox empty or not

Returns: boolean

LatestMessagesL ( )

const RPointerArray< MMessageData > &LatestMessagesL()const [pure virtual]

Accessor for mailbox's messages. If there are more messages in the array than fits the widget, only the newest will be published. Assumption: array must be ordered based on timestamp (i.e. newest in index 0) Assumption: plugin does not have to upkeep more than 2 latest messages

Returns: array of messages

LaunchParameters ( )

MEmailLaunchParameters &LaunchParameters()const [pure virtual]

Accessor for launching parameters These parameters specify what application is launched when widget is pressed

Returns: interface to launch parameters

MailboxId ( )

TUint MailboxId()const [pure virtual]

Accessor for mailbox id

Returns: mailbox identifier

MessageCount ( )

TInt MessageCount()const [pure virtual]

Accessor for total count of messages in inbox

Returns: total message count

Name ( )

const TDesC &Name()const [pure virtual]

Accessor for mailbox name

Returns: mailbox name

Unseen ( )

TBool Unseen()const [pure virtual]

Accessor for seen/unseen status i.e. whether user has been to inbox after last message has been received

Returns: boolean