Collapse all Symbian^3 Product Developer Library

CESMRFsMailboxUtils Class Reference

class CESMRFsMailboxUtils : public CBase

Utility class for FS mailbox

Inherits from

CESMRFsMailboxUtils
- CBase

Public Member Functions
	~CESMRFsMailboxUtils()
IMPORT_C TBool	DefaultMailboxSupportCapabilityL(TMRMailboxCapability)
IMPORT_C TESMRMailPlugin	FSEmailPluginForEntryL(const CCalEntry &)
void	GetCalendarDatabaseIdL(TESMRMailPlugin, TCalFileId &)
IMPORT_C CESMRFsMailboxUtils *	NewL(CMRMailboxUtils &)
IMPORT_C TInt	SetPhoneOwnerL(CCalEntry &, TMsvId)
IMPORT_C TInt	SetPhoneOwnerL(CCalEntry &, CFSMailClient &, CFSMailMessage &)

Private Member Functions
	CESMRFsMailboxUtils(CMRMailboxUtils &)
void	ConstructL()
CFSMailBox *	DefaultMailboxL()
TBool	IsPhoneOwnerL(const CCalUser &, const RPointerArray< CFSMailBox > &, TInt &)
CFSMailClient &	MailClientL()
CCalUser *	PhoneOwnerL(const CCalEntry &, const RPointerArray< CFSMailBox > &, TInt &)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Public Member Enumerations
enum	TMRMailboxCapability { EMRCapabilityAttachment }

Private Attributes
CMRMailboxUtils &	iMRMailboxUtils
CFSMailClient *	iMailClient

Constructor & Destructor Documentation

CESMRFsMailboxUtils(CMRMailboxUtils &)

CESMRFsMailboxUtils

(

CMRMailboxUtils &

aMailboxUtils

)

[private, inline]

Parameters

CMRMailboxUtils & aMailboxUtils

~CESMRFsMailboxUtils()

IMPORT_C

~CESMRFsMailboxUtils

(

)

C++ Destructor.

Member Functions Documentation

ConstructL()

void

ConstructL

(

)

[private]

DefaultMailboxL()

CFSMailBox *

DefaultMailboxL

(

)

[private]

DefaultMailboxSupportCapabilityL(TMRMailboxCapability)

IMPORT_C TBool

DefaultMailboxSupportCapabilityL

(

TMRMailboxCapability

aCapability

)

Tests if default mailbox supports certain capability.

Parameters

TMRMailboxCapability aCapability

Capability to be tested

FSEmailPluginForEntryL(const CCalEntry &)

IMPORT_C TESMRMailPlugin

FSEmailPluginForEntryL

(

const CCalEntry &

aEntry

)

Resolves the plugin to be used to current calendar entry. Method retrieves phone owner from calendar entry and loops all FS Email mailboxes.

Parameters

const CCalEntry & aEntry

Reference to calendar entry.

GetCalendarDatabaseIdL(TESMRMailPlugin, TCalFileId &)

void	GetCalendarDatabaseIdL	(	TESMRMailPlugin	aPlugin,
			TCalFileId &	aDbId
		)

Gets the calendar database id used by mail plugin

Parameters

TESMRMailPlugin aPlugin	mail plugin in use
TCalFileId & aDbId	on return contains the database id or KNullFileId if plugin does not provide database id information.

IsPhoneOwnerL(const CCalUser &, const RPointerArray< CFSMailBox > &, TInt &)

TBool	IsPhoneOwnerL	(	const CCalUser &	aUser,
			const RPointerArray< CFSMailBox > &	aMailBoxes,
			TInt &	aMatchIndex
		)	[private]

Parameters

const CCalUser & aUser
const RPointerArray< CFSMailBox > & aMailBoxes
TInt & aMatchIndex

MailClientL()

CFSMailClient &

MailClientL

(

)

[private]

NewL(CMRMailboxUtils &)

IMPORT_C CESMRFsMailboxUtils *

NewL

(

CMRMailboxUtils &

aMailboxUtils

)

[static]

Constructs CESMRFsMailboxUtils object.

Parameters

CMRMailboxUtils & aMailboxUtils

Reference to S60 mailbox utils

PhoneOwnerL(const CCalEntry &, const RPointerArray< CFSMailBox > &, TInt &)

CCalUser *	PhoneOwnerL	(	const CCalEntry &	aCalEntry,
			const RPointerArray< CFSMailBox > &	aMailBoxes,
			TInt &	aMatchIndex
		)	[private]

Parameters

const CCalEntry & aCalEntry
const RPointerArray< CFSMailBox > & aMailBoxes
TInt & aMatchIndex

SetPhoneOwnerL(CCalEntry &, TMsvId)

IMPORT_C TInt	SetPhoneOwnerL	(	CCalEntry &	aCalEntry,
			TMsvId	aPrimaryBox = KMsvNullIndexEntryId
		)

If phone owner field hasn't been set so far, this method compares organizer field to the mailboxes in the device, and if no match was found compares each attendee to the mailboxes. If match was found, phone owner field is set, otherwise KErrNotFound is returned. If aPrimaryBox is given, then that is used in matching before any other mailbox. If not given, then default MR mailbox will have the highest presedence followed by other MR-capable mailboxes.

Parameters

CCalEntry & aCalEntry	entry to modify
TMsvId aPrimaryBox = KMsvNullIndexEntryId	primary mailbox for matching, if applicable

SetPhoneOwnerL(CCalEntry &, CFSMailClient &, CFSMailMessage &)

IMPORT_C TInt	SetPhoneOwnerL	(	CCalEntry &	aCalEntry,
			CFSMailClient &	aMailClient,
			CFSMailMessage &	aMailMessage
		)

If phone owner field hasn't been set so far, this method compares mailboxowner's email address to organizer field and if no match was found compares each attendee to the mailboxowner's email address. If match was found, phone owner field is set, otherwise KErrNotFound is returned.

Parameters

CCalEntry & aCalEntry	entry to modify
CFSMailClient & aMailClient
CFSMailMessage & aMailMessage

Member Enumerations Documentation

Enum TMRMailboxCapability

Enumeration for mailbox capabilities

Enumerators

EMRCapabilityAttachment

Member Data Documentation

CMRMailboxUtils & iMRMailboxUtils

CMRMailboxUtils &

iMRMailboxUtils

[private]

CFSMailClient * iMailClient

CFSMailClient *

iMailClient

[private]