MImumDaMailboxUtilities Class Reference

class MImumDaMailboxUtilities

Utility class for mailboxes.

This class provides methods to do minor tasks with mailboxes and their properties.

imumda.lib
Since
S60 v3.2
from ImumDaErrorCodes.h enum TImumDaErrorCode for error codes

Member Functions Documentation

DefaultMailboxId()

TMsvId DefaultMailboxId ( ) const [pure virtual]

Retrieves the id (sending) of the default mailbox in the system.

Since
S60 v3.2

GetMailboxEntriesL(const TMsvId, RMsvEntryArray &, const TBool)

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

Gets all the entries related to mailbox.

Since
S60 v3.2

Parameters

const TMsvId aMailboxId
RMsvEntryArray & aEntries
const TBool aResetArray = ETrue

GetMailboxEntryL(const TMsvId, const TImumDaMboxRequestType &)

TMsvEntry GetMailboxEntryL ( const TMsvId aMailboxId,
const TImumDaMboxRequestType & aType = EValueRequestCurrent
) const [pure virtual]

Gets the entry of the id and and checks that it is mailbox entry.

Since
S60 v3.2
leave
EEntryNotFound, if entry does not exist.
leave
EEntryNotMailbox, if the entry does not belong to mailbox.

Parameters

const TMsvId aMailboxId
const TImumDaMboxRequestType & aType = EValueRequestCurrent

GetMailboxesL(const TInt64)

RMailboxIdArray GetMailboxesL ( const TInt64 aFlags ) const [pure virtual]

Returns an array of availble mailboxes in the system. *** NOTE: Client is responsible to clean the array after usage! ***

Since
S60 v3.2

Parameters

const TInt64 aFlags

IsMailMtm(const TUid &, const TBool &)

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

Checks if the provided mtm belongs to supported email mtm.

Since
S60 v3.2

Parameters

const TUid & aMtm
const TBool & aAllowExtended = EFalse

IsMailbox(const TMsvId)

TBool IsMailbox ( const TMsvId aMailboxId ) const [pure virtual]

Checks if the provided id/entry is mailbox.

Since
S60 v3.2

Parameters

const TMsvId aMailboxId

IsMailbox(const TMsvEntry &)

TBool IsMailbox ( const TMsvEntry & aMailbox ) const [pure virtual]

Parameters

const TMsvEntry & aMailbox

IsMailboxHealthy(const TMsvId)

TBool IsMailboxHealthy ( const TMsvId aMailboxId ) const [pure virtual]

Checks, if the mailbox of specific id is functional.

Since
S60 v3.2

Parameters

const TMsvId aMailboxId

Member Enumerations Documentation

Enum TImumDaMailboxFlags

Flags to control mailboxes to be retrieved

Enumerators

EFlagImap4 = 0x01
EFlagPop3 = 0x02
EFlagSmtp = 0x04
EFlagSyncMl = 0x08
EFlagSetDefault = 0x0B
EFlagSetImapPop = 0x03

Enum TImumDaMboxRequestType

Request types of the mailbox entry

Enumerators

EValueRequestCurrent = 0
EValueRequestSending
EValueRequestReceiving

Member Type Definitions Documentation

Typedef RMailboxIdArray

typedef RArray < TMsvId > RMailboxIdArray

Array of mailbox id's.

Typedef RMsvEntryArray

typedef RArray < TMsvEntry > RMsvEntryArray

Array of mailbox entries