Collapse all Symbian^3 Application Developer Library

MImumInMailboxUtilities Class Reference

class MImumInMailboxUtilities

Public Member Functions
TMsvId	DefaultMailboxId (const TBool )
const TUid &	GetMailboxEntriesL (const TMsvId , RMsvEntryArray &, const TBool )
TMsvEntry	GetMailboxEntryL (const TMsvId , const TImumInMboxRequest &, const TBool )
TBool	HasSubscribedFoldersL (const TMsvId )
TBool	HasWlanConnectionL (const TMsvId )
TBool	IsInbox (const TMsvEntry &)
TBool	IsMailMtm (const TUid &, const TBool &)
TBool	IsMailbox (const TMsvId )
TBool	IsMailbox (const TMsvEntry &)
void	NextAlwaysOnlineIntervalL (const TMsvId , TInt64 &, TTimeIntervalSeconds &)
void	QueryAlwaysOnlineStateL (const TMsvId , TInt64 &)

Public Member Enumerations
enum	TImumInMboxAlwaysOnlineState { EFlagTurnedOn = 0x01, EFlagWaitingToConnect = 0x02 }
enum	TImumInMboxRequest { ERequestCurrent = 0, ERequestSending , ERequestReceiving }

Public Member Type Definitions
typedef	RArray < TMsvEntry > RMsvEntryArray

Member Functions Documentation

DefaultMailboxId(const TBool)

TMsvId

DefaultMailboxId

(

const TBool

aForceGet = EFalse

)

const [pure virtual]

Parameters

const TBool aForceGet = EFalse

GetMailboxEntriesL(const TMsvId, RMsvEntryArray &, const TBool)

const TUid &	GetMailboxEntriesL	(	const TMsvId	aMailboxId,
			RMsvEntryArray &	aEntries,
			const TBool	aResetArray = ETrue
		)	const [pure virtual]

Parameters

const TMsvId aMailboxId
RMsvEntryArray & aEntries
const TBool aResetArray = ETrue

GetMailboxEntryL(const TMsvId, const TImumInMboxRequest &, const TBool)

TMsvEntry	GetMailboxEntryL	(	const TMsvId	aMailboxId,
			const TImumInMboxRequest &	aType = ERequestCurrent,
			const TBool	aServiceCheck = EFalse
		)	const [pure virtual]

Parameters

const TMsvId aMailboxId
const TImumInMboxRequest & aType = ERequestCurrent
const TBool aServiceCheck = EFalse

HasSubscribedFoldersL(const TMsvId)

TBool

HasSubscribedFoldersL

(

const TMsvId

aMailboxId

)

const [pure virtual]

Parameters

const TMsvId aMailboxId

HasWlanConnectionL(const TMsvId)

TBool

HasWlanConnectionL

(

const TMsvId

aMailboxId

)

const [pure virtual]

Parameters

const TMsvId aMailboxId

IsInbox(const TMsvEntry &)

TBool

IsInbox

(

const TMsvEntry &

aFolderEntry

)

const [pure virtual]

Parameters

const TMsvEntry & aFolderEntry

IsMailMtm(const TUid &, const TBool &)

TBool	IsMailMtm	(	const TUid &	aMtm,
			const TBool &	aAllowExtended = EFalse
		)	const [pure virtual]

Parameters

const TUid & aMtm
const TBool & aAllowExtended = EFalse

IsMailbox(const TMsvId)

TBool

IsMailbox

(

const TMsvId

aMailboxId

)

const [pure virtual]

Parameters

const TMsvId aMailboxId

IsMailbox(const TMsvEntry &)

TBool

IsMailbox

(

const TMsvEntry &

aMailbox

)

const [pure virtual]

Parameters

const TMsvEntry & aMailbox

NextAlwaysOnlineIntervalL(const TMsvId, TInt64 &, TTimeIntervalSeconds &)

void	NextAlwaysOnlineIntervalL	(	const TMsvId	aMailboxId,
			TInt64 &	aAlwaysOnlineStatus,
			TTimeIntervalSeconds &	aSeconds
		)	const [pure virtual]

Parameters

const TMsvId aMailboxId
TInt64 & aAlwaysOnlineStatus
TTimeIntervalSeconds & aSeconds

QueryAlwaysOnlineStateL(const TMsvId, TInt64 &)

void	QueryAlwaysOnlineStateL	(	const TMsvId	aMailboxId,
			TInt64 &	aAlwaysOnlineStatus
		)	const [pure virtual]

Parameters

const TMsvId aMailboxId
TInt64 & aAlwaysOnlineStatus

Member Enumerations Documentation

Enum TImumInMboxAlwaysOnlineState

Enumerators

EFlagTurnedOn = 0x01	Always Online is active
EFlagWaitingToConnect = 0x02	Always Online is waiting for connecting

Enum TImumInMboxRequest

Enumerators

ERequestCurrent = 0
ERequestSending
ERequestReceiving

Member Type Definitions Documentation

Typedef RMsvEntryArray

typedef RArray < TMsvEntry >

RMsvEntryArray