Symbian^3 Product Developer Library >

CFSMailFolder Class Reference

class CFSMailFolder : public CFSMailFolderBase

class for handling mailbox folder data

FSFWCommonLib
Since
S60 S60 v3.1

Inherits from

Public Member Functions
~CFSMailFolder()
IMPORT_C CEmailExtension *ExtensionL(const TUid &)
IMPORT_C TIntFetchMessagesL(const RArray< TFSMailMsgId > &, TFSMailDetails, MFSMailRequestObserver &)
IMPORT_C voidGetSubFoldersL(RPointerArray< CFSMailFolder > &)
IMPORT_C MFSMailIterator *ListMessagesL(const TFSMailDetails, const RArray< TFSMailSortCriteria > &)
IMPORT_C CFSMailFolder *NewL(TFSMailMsgId)
IMPORT_C CFSMailFolder *NewLC(TFSMailMsgId)
IMPORT_C voidReleaseExtension(CEmailExtension *)
IMPORT_C voidRemoveDownLoadedAttachmentsL()
IMPORT_C voidRemoveMessageL(const TFSMailMsgId)
IMPORT_C TBoolSupportsCopyFromL(TFSFolderType)
IMPORT_C TBoolSupportsMoveFromL(TFSFolderType)
Protected Member Functions
CFSMailFolder()
Private Member Functions
voidConstructL(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()
CFSMailFolderBase::BlockCopyFromL(RArray< TFSFolderType >,TFSMailBoxStatus)
CFSMailFolderBase::BlockMoveFromL(RArray< TFSFolderType >,TFSMailBoxStatus)
CFSMailFolderBase::CFSMailFolderBase()
CFSMailFolderBase::GetFolderId()const
CFSMailFolderBase::GetFolderName()const
CFSMailFolderBase::GetFolderType()const
CFSMailFolderBase::GetMailBoxId()const
CFSMailFolderBase::GetMessageCount()const
CFSMailFolderBase::GetParentFolderId()const
CFSMailFolderBase::GetSubFolderCount()const
CFSMailFolderBase::GetUnreadCount()const
CFSMailFolderBase::GetUnseenCount()const
CFSMailFolderBase::SetFolderName(const TDesC &)
CFSMailFolderBase::SetFolderType(const TFSFolderType)
CFSMailFolderBase::SetMailBoxId(const TFSMailMsgId)
CFSMailFolderBase::SetMessageCount(const TUint)
CFSMailFolderBase::SetParentFolderId(const TFSMailMsgId)
CFSMailFolderBase::SetSubFolderCount(const TUint)
CFSMailFolderBase::SetUnreadCount(const TUint)
CFSMailFolderBase::SetUnseenCount(const TUint)
CFSMailFolderBase::~CFSMailFolderBase()
Private Attributes
CFSMailRequestHandler *iRequestHandler
Inherited Attributes
CExtendableEmail::iExtensions
CFSMailFolderBase::iCopyOfflineBlocked
CFSMailFolderBase::iCopyOnlineBlocked
CFSMailFolderBase::iFolderId
CFSMailFolderBase::iMoveOfflineBlocked
CFSMailFolderBase::iMoveOnlineBlocked

Constructor & Destructor Documentation

CFSMailFolder()

CFSMailFolder()[protected]

C++ default constructor.

~CFSMailFolder()

IMPORT_C~CFSMailFolder()

Destructor.

Member Functions Documentation

ConstructL(TFSMailMsgId)

voidConstructL(TFSMailMsgIdaFolderId)[private]

Two-phased constructor

Parameters

TFSMailMsgId aFolderId

ExtensionL(const TUid &)

IMPORT_C CEmailExtension *ExtensionL(const TUid &aInterfaceUid)[virtual]

CExtendableEmail::ExtensionL

Parameters

const TUid & aInterfaceUid

FetchMessagesL(const RArray< TFSMailMsgId > &, TFSMailDetails, MFSMailRequestObserver &)

IMPORT_C TIntFetchMessagesL(const RArray< TFSMailMsgId > &aMessageIds,
TFSMailDetailsaDetails,
MFSMailRequestObserver &aObserver
)

method launches fetching of messages given by user from server

Parameters

const RArray< TFSMailMsgId > & aMessageIdsids of messages to be fetched
TFSMailDetails aDetailsdefines which details each message contains
MFSMailRequestObserver & aObserverrequest observer for conveying fetching progress events to user

GetSubFoldersL(RPointerArray< CFSMailFolder > &)

IMPORT_C voidGetSubFoldersL(RPointerArray< CFSMailFolder > &aSubFolders)

lists subfolders contained by this folder

Parameters

RPointerArray< CFSMailFolder > & aSubFolders

ListMessagesL(const TFSMailDetails, const RArray< TFSMailSortCriteria > &)

IMPORT_C MFSMailIterator *ListMessagesL(const TFSMailDetailsaDetails,
const RArray< TFSMailSortCriteria > &aSorting
)

List folder messages. Function returns iterator, which user can use to scroll up/down message list.

Parameters

const TFSMailDetails aDetailsdescribes which details each CFSMailMessage contains
const RArray< TFSMailSortCriteria > & aSortingdescribes requested sort criteria. First item in array is primary sort criteria.

NewL(TFSMailMsgId)

IMPORT_C CFSMailFolder *NewL(TFSMailMsgIdaFolderId)[static]

Two-phased constructor.

Parameters

TFSMailMsgId aFolderIdfolder id in plugin containing folder

NewLC(TFSMailMsgId)

IMPORT_C CFSMailFolder *NewLC(TFSMailMsgIdaFolderId)[static]

Two-phased constructor.

Parameters

TFSMailMsgId aFolderIdfolder id in plugin containing folder

ReleaseExtension(CEmailExtension *)

IMPORT_C voidReleaseExtension(CEmailExtension *aExtension)[virtual]

CExtendableEmail::ReleaseExtension

Parameters

CEmailExtension * aExtension

RemoveDownLoadedAttachmentsL()

IMPORT_C voidRemoveDownLoadedAttachmentsL()

removes downloaded attachments from local/terminal memory

RemoveMessageL(const TFSMailMsgId)

IMPORT_C voidRemoveMessageL(const TFSMailMsgIdaMessageId)

removes given message from folder

Parameters

const TFSMailMsgId aMessageIdid of message to be removed

SupportsCopyFromL(TFSFolderType)

IMPORT_C TBoolSupportsCopyFromL(TFSFolderTypeaFolderType)

method to check if this folder allows copying from given folder type

Parameters

TFSFolderType aFolderTypefolder type

SupportsMoveFromL(TFSFolderType)

IMPORT_C TBoolSupportsMoveFromL(TFSFolderTypeaFolderType)

method to check if this folder allows moving from given folder type

Parameters

TFSFolderType aFolderTypefolder type

Member Data Documentation

CFSMailRequestHandler * iRequestHandler

CFSMailRequestHandler *iRequestHandler[private]

request handler for plugin requests

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.