Symbian^3 Product Developer Library >

CFSMailFolderBase Class Reference

class CFSMailFolderBase : public CExtendableEmail

class for handling mailbox folder data

FSFWCommonLib

Inherits from

Public Member Functions
~CFSMailFolderBase()
IMPORT_C voidBlockCopyFromL(RArray< TFSFolderType >, TFSMailBoxStatus)
IMPORT_C voidBlockMoveFromL(RArray< TFSFolderType >, TFSMailBoxStatus)
IMPORT_C TFSMailMsgIdGetFolderId()
IMPORT_C TDesC &GetFolderName()
IMPORT_C TFSFolderTypeGetFolderType()
IMPORT_C TFSMailMsgIdGetMailBoxId()
IMPORT_C TUintGetMessageCount()
IMPORT_C TFSMailMsgIdGetParentFolderId()
IMPORT_C TUintGetSubFolderCount()
IMPORT_C TUintGetUnreadCount()
IMPORT_C TUintGetUnseenCount()
IMPORT_C CFSMailFolderBase *NewL(const TFSMailMsgId)
IMPORT_C CFSMailFolderBase *NewLC(const TFSMailMsgId)
IMPORT_C voidSetFolderName(const TDesC &)
IMPORT_C voidSetFolderType(const TFSFolderType)
IMPORT_C voidSetMailBoxId(const TFSMailMsgId)
IMPORT_C voidSetMessageCount(const TUint)
IMPORT_C voidSetParentFolderId(const TFSMailMsgId)
IMPORT_C voidSetSubFolderCount(const TUint)
IMPORT_C voidSetUnreadCount(const TUint)
IMPORT_C voidSetUnseenCount(const TUint)
Protected Member Functions
CFSMailFolderBase()
Private Member Functions
voidConstructL(const TFSMailMsgId)
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()
CExtendableEmail::ExtensionL(const TUid &)
CExtendableEmail::ReleaseExtension(CEmailExtension *)
Protected Attributes
RArray< TFSFolderType >iCopyOfflineBlocked
RArray< TFSFolderType >iCopyOnlineBlocked
TFSMailMsgId iFolderId
RArray< TFSFolderType >iMoveOfflineBlocked
RArray< TFSFolderType >iMoveOnlineBlocked
Private Attributes
HBufC *iFolderName
TFSFolderType iFolderType
TFSMailMsgId iMailBoxId
TUint iMessageCount
TFSMailMsgId iParentFolderId
TUint iSubFolderCount
TUint iUnreadMessageCount
TUint iUnseenCount
Inherited Attributes
CExtendableEmail::iExtensions

Constructor & Destructor Documentation

CFSMailFolderBase()

CFSMailFolderBase()[protected]

C++ default constructor.

~CFSMailFolderBase()

IMPORT_C~CFSMailFolderBase()[virtual]

Destructor.

Member Functions Documentation

BlockCopyFromL(RArray< TFSFolderType >, TFSMailBoxStatus)

IMPORT_C voidBlockCopyFromL(RArray< TFSFolderType >aFolderTypes,
TFSMailBoxStatusaMailBoxStatus
)

blocks copying to this folder from given folder types

Parameters

RArray< TFSFolderType > aFolderTypesblocked folder types
TFSMailBoxStatus aMailBoxStatusmailbox status (online / offline) when blocking is done

BlockMoveFromL(RArray< TFSFolderType >, TFSMailBoxStatus)

IMPORT_C voidBlockMoveFromL(RArray< TFSFolderType >aFolderTypes,
TFSMailBoxStatusaMailBoxStatus
)

blocks moving to this folder from given folder types

Parameters

RArray< TFSFolderType > aFolderTypesblocked folder types
TFSMailBoxStatus aMailBoxStatusmailbox status (online / offline) when blocking is done

ConstructL(const TFSMailMsgId)

voidConstructL(const TFSMailMsgIdaFolderId)[private]

Two-phased constructor

Parameters

const TFSMailMsgId aFolderId

GetFolderId()

IMPORT_C TFSMailMsgIdGetFolderId()const

folder id accessor

GetFolderName()

IMPORT_C TDesC &GetFolderName()const

folder name accessor

GetFolderType()

IMPORT_C TFSFolderTypeGetFolderType()const

folder type accessor

GetMailBoxId()

IMPORT_C TFSMailMsgIdGetMailBoxId()const

returns id of mailbox containing this folder

GetMessageCount()

IMPORT_C TUintGetMessageCount()const

returns message count contained by this folder

GetParentFolderId()

IMPORT_C TFSMailMsgIdGetParentFolderId()const

parent folder id accessor

GetSubFolderCount()

IMPORT_C TUintGetSubFolderCount()const

returns subfolder count contained by this folder

GetUnreadCount()

IMPORT_C TUintGetUnreadCount()const

returns unread message count contained by this folder

GetUnseenCount()

IMPORT_C TUintGetUnseenCount()const

returns unseen message count contained by this folder

NewL(const TFSMailMsgId)

IMPORT_C CFSMailFolderBase *NewL(const TFSMailMsgIdaFolderId)[static]

Two-phased constructor.

Parameters

const TFSMailMsgId aFolderIdfolder id in plugin containing folder

NewLC(const TFSMailMsgId)

IMPORT_C CFSMailFolderBase *NewLC(const TFSMailMsgIdaFolderId)[static]

Two-phased constructor.

Parameters

const TFSMailMsgId aFolderIdfolder id in plugin containing folder

SetFolderName(const TDesC &)

IMPORT_C voidSetFolderName(const TDesC &aFolderName)

Folder name mutator. Note ! Some clients may ignore names set for standard folders (TFSFolderType being EFSInbox, EFSOutbox, EFSDraftsFolder, EFSSentFolder, or EFSDeleted) and display own localized names for them. E.g. Email UI behaves this way.

Parameters

const TDesC & aFolderNamefolder name to be set

SetFolderType(const TFSFolderType)

IMPORT_C voidSetFolderType(const TFSFolderTypeaFolderType)

folder type mutator

Parameters

const TFSFolderType aFolderTypefolder type to be set

SetMailBoxId(const TFSMailMsgId)

IMPORT_C voidSetMailBoxId(const TFSMailMsgIdaMailBoxId)

folder mailbox id mutator

Parameters

const TFSMailMsgId aMailBoxIdmailbox id to be set

SetMessageCount(const TUint)

IMPORT_C voidSetMessageCount(const TUintaMessageCount)

set message count contained by this folder

Parameters

const TUint aMessageCountmessage count

SetParentFolderId(const TFSMailMsgId)

IMPORT_C voidSetParentFolderId(const TFSMailMsgIdaFolderId)

parent folder id mutator

Parameters

const TFSMailMsgId aFolderIdparent folder id to be set

SetSubFolderCount(const TUint)

IMPORT_C voidSetSubFolderCount(const TUintaMessageCount)

set subfolder count contained by this folder

Parameters

const TUint aMessageCount

SetUnreadCount(const TUint)

IMPORT_C voidSetUnreadCount(const TUintaMessageCount)

set unread message count contained by this folder

Parameters

const TUint aMessageCountunread message count

SetUnseenCount(const TUint)

IMPORT_C voidSetUnseenCount(const TUintaMessageCount)

set unseen message count contained by this folder

Parameters

const TUint aMessageCountunseen message count

Member Data Documentation

RArray< TFSFolderType > iCopyOfflineBlocked

RArray< TFSFolderType >iCopyOfflineBlocked[protected]

blocked folders in copying

RArray< TFSFolderType > iCopyOnlineBlocked

RArray< TFSFolderType >iCopyOnlineBlocked[protected]

TFSMailMsgId iFolderId

TFSMailMsgId iFolderId[protected]

folder id

HBufC * iFolderName

HBufC *iFolderName[private]

folder name

TFSFolderType iFolderType

TFSFolderType iFolderType[private]

folder type

TFSMailMsgId iMailBoxId

TFSMailMsgId iMailBoxId[private]

mailbox id

TUint iMessageCount

TUint iMessageCount[private]

folder total message count

RArray< TFSFolderType > iMoveOfflineBlocked

RArray< TFSFolderType >iMoveOfflineBlocked[protected]

blocked folders in moving

RArray< TFSFolderType > iMoveOnlineBlocked

RArray< TFSFolderType >iMoveOnlineBlocked[protected]

TFSMailMsgId iParentFolderId

TFSMailMsgId iParentFolderId[private]

parent folder id

TUint iSubFolderCount

TUint iSubFolderCount[private]

subfolder count

TUint iUnreadMessageCount

TUint iUnreadMessageCount[private]

folder unread message count

TUint iUnseenCount

TUint iUnseenCount[private]

folder unseen message count

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.