Symbian^3 Application Developer Library >

CFSMailFolderBase Class Reference

class CFSMailFolderBase : public CExtendableEmail

class for handling mailbox folder data

FSFWCommonLib

Inherits from

Public Member Functions
~CFSMailFolderBase ()
IMPORT_C void BlockCopyFromL ( RArray < TFSFolderType >, TFSMailBoxStatus )
IMPORT_C void BlockMoveFromL ( RArray < TFSFolderType >, TFSMailBoxStatus )
IMPORT_C TFSMailMsgId GetFolderId ()
IMPORT_C TDesC & GetFolderName ()
IMPORT_C TFSFolderType GetFolderType ()
IMPORT_C TFSMailMsgId GetMailBoxId ()
IMPORT_C TUint GetMessageCount ()
IMPORT_C TFSMailMsgId GetParentFolderId ()
IMPORT_C TUint GetSubFolderCount ()
IMPORT_C TUint GetUnreadCount ()
IMPORT_C TUint GetUnseenCount ()
IMPORT_C CFSMailFolderBase * NewL (const TFSMailMsgId )
IMPORT_C CFSMailFolderBase * NewLC (const TFSMailMsgId )
IMPORT_C void SetFolderName (const TDesC &)
IMPORT_C void SetFolderType (const TFSFolderType )
IMPORT_C void SetMailBoxId (const TFSMailMsgId )
IMPORT_C void SetMessageCount (const TUint )
IMPORT_C void SetParentFolderId (const TFSMailMsgId )
IMPORT_C void SetSubFolderCount (const TUint )
IMPORT_C void SetUnreadCount (const TUint )
IMPORT_C void SetUnseenCount (const TUint )
Protected Member Functions
CFSMailFolderBase ()
Private Member Functions
void ConstructL (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 void BlockCopyFromL ( RArray < TFSFolderType > aFolderTypes,
TFSMailBoxStatus aMailBoxStatus
)

blocks copying to this folder from given folder types

Parameters

RArray < TFSFolderType > aFolderTypes blocked folder types
TFSMailBoxStatus aMailBoxStatus mailbox status (online / offline) when blocking is done

BlockMoveFromL(RArray< TFSFolderType >, TFSMailBoxStatus)

IMPORT_C void BlockMoveFromL ( RArray < TFSFolderType > aFolderTypes,
TFSMailBoxStatus aMailBoxStatus
)

blocks moving to this folder from given folder types

Parameters

RArray < TFSFolderType > aFolderTypes blocked folder types
TFSMailBoxStatus aMailBoxStatus mailbox status (online / offline) when blocking is done

ConstructL(const TFSMailMsgId)

void ConstructL ( const TFSMailMsgId aFolderId ) [private]

Two-phased constructor

Parameters

const TFSMailMsgId aFolderId

GetFolderId()

IMPORT_C TFSMailMsgId GetFolderId ( ) const

folder id accessor

GetFolderName()

IMPORT_C TDesC & GetFolderName ( ) const

folder name accessor

GetFolderType()

IMPORT_C TFSFolderType GetFolderType ( ) const

folder type accessor

GetMailBoxId()

IMPORT_C TFSMailMsgId GetMailBoxId ( ) const

returns id of mailbox containing this folder

GetMessageCount()

IMPORT_C TUint GetMessageCount ( ) const

returns message count contained by this folder

GetParentFolderId()

IMPORT_C TFSMailMsgId GetParentFolderId ( ) const

parent folder id accessor

GetSubFolderCount()

IMPORT_C TUint GetSubFolderCount ( ) const

returns subfolder count contained by this folder

GetUnreadCount()

IMPORT_C TUint GetUnreadCount ( ) const

returns unread message count contained by this folder

GetUnseenCount()

IMPORT_C TUint GetUnseenCount ( ) const

returns unseen message count contained by this folder

NewL(const TFSMailMsgId)

IMPORT_C CFSMailFolderBase * NewL ( const TFSMailMsgId aFolderId ) [static]

Two-phased constructor.

Parameters

const TFSMailMsgId aFolderId folder id in plugin containing folder

NewLC(const TFSMailMsgId)

IMPORT_C CFSMailFolderBase * NewLC ( const TFSMailMsgId aFolderId ) [static]

Two-phased constructor.

Parameters

const TFSMailMsgId aFolderId folder id in plugin containing folder

SetFolderName(const TDesC &)

IMPORT_C void SetFolderName ( 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 & aFolderName folder name to be set

SetFolderType(const TFSFolderType)

IMPORT_C void SetFolderType ( const TFSFolderType aFolderType )

folder type mutator

Parameters

const TFSFolderType aFolderType folder type to be set

SetMailBoxId(const TFSMailMsgId)

IMPORT_C void SetMailBoxId ( const TFSMailMsgId aMailBoxId )

folder mailbox id mutator

Parameters

const TFSMailMsgId aMailBoxId mailbox id to be set

SetMessageCount(const TUint)

IMPORT_C void SetMessageCount ( const TUint aMessageCount )

set message count contained by this folder

Parameters

const TUint aMessageCount message count

SetParentFolderId(const TFSMailMsgId)

IMPORT_C void SetParentFolderId ( const TFSMailMsgId aFolderId )

parent folder id mutator

Parameters

const TFSMailMsgId aFolderId parent folder id to be set

SetSubFolderCount(const TUint)

IMPORT_C void SetSubFolderCount ( const TUint aMessageCount )

set subfolder count contained by this folder

Parameters

const TUint aMessageCount

SetUnreadCount(const TUint)

IMPORT_C void SetUnreadCount ( const TUint aMessageCount )

set unread message count contained by this folder

Parameters

const TUint aMessageCount unread message count

SetUnseenCount(const TUint)

IMPORT_C void SetUnseenCount ( const TUint aMessageCount )

set unseen message count contained by this folder

Parameters

const TUint aMessageCount unseen 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.