Collapse all Symbian^3 Application Developer Library

CFSMailFolder Class Reference

class CFSMailFolder : public CFSMailFolderBase

class for handling mailbox folder data

FSFWCommonLib

Since: S60 S60 v3.1

Inherits from

CFSMailFolder
- CFSMailFolderBase
  - CExtendableEmail
    - CBase

Public Member Functions
	~CFSMailFolder ()
IMPORT_C CEmailExtension *	ExtensionL (const TUid &)
IMPORT_C TInt	FetchMessagesL (const RArray < TFSMailMsgId > &, TFSMailDetails , MFSMailRequestObserver &)
IMPORT_C void	GetSubFoldersL ( RPointerArray < CFSMailFolder > &)
IMPORT_C MFSMailIterator *	ListMessagesL (const TFSMailDetails , const RArray < TFSMailSortCriteria > &)
IMPORT_C CFSMailFolder *	NewL ( TFSMailMsgId )
IMPORT_C CFSMailFolder *	NewLC ( TFSMailMsgId )
IMPORT_C void	ReleaseExtension ( CEmailExtension *)
IMPORT_C void	RemoveDownLoadedAttachmentsL ()
IMPORT_C void	RemoveMessageL (const TFSMailMsgId )
IMPORT_C TBool	SupportsCopyFromL ( TFSFolderType )
IMPORT_C TBool	SupportsMoveFromL ( TFSFolderType )

Protected Member Functions
	CFSMailFolder ()

Private Member Functions
void	ConstructL ( 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)

void

ConstructL

(

TFSMailMsgId

aFolderId

)

[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 TInt	FetchMessagesL	(	const RArray < TFSMailMsgId > &	aMessageIds,
			TFSMailDetails	aDetails,
			MFSMailRequestObserver &	aObserver
		)

method launches fetching of messages given by user from server

Parameters

const RArray < TFSMailMsgId > & aMessageIds	ids of messages to be fetched
TFSMailDetails aDetails	defines which details each message contains
MFSMailRequestObserver & aObserver	request observer for conveying fetching progress events to user

GetSubFoldersL(RPointerArray< CFSMailFolder > &)

IMPORT_C void

GetSubFoldersL

(

RPointerArray < CFSMailFolder > &

aSubFolders

)

lists subfolders contained by this folder

Parameters

RPointerArray < CFSMailFolder > & aSubFolders

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

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

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

Parameters

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

NewL(TFSMailMsgId)

IMPORT_C CFSMailFolder *

NewL

(

TFSMailMsgId

aFolderId

)

[static]

Two-phased constructor.

Parameters

TFSMailMsgId aFolderId

folder id in plugin containing folder

NewLC(TFSMailMsgId)

IMPORT_C CFSMailFolder *

NewLC

(

TFSMailMsgId

aFolderId

)

[static]

Two-phased constructor.

Parameters

TFSMailMsgId aFolderId

folder id in plugin containing folder

ReleaseExtension(CEmailExtension *)

IMPORT_C void

ReleaseExtension

(

CEmailExtension *

aExtension

)

[virtual]

CExtendableEmail::ReleaseExtension

Parameters

CEmailExtension * aExtension

RemoveDownLoadedAttachmentsL()

IMPORT_C void

RemoveDownLoadedAttachmentsL

(

)

removes downloaded attachments from local/terminal memory

RemoveMessageL(const TFSMailMsgId)

IMPORT_C void

RemoveMessageL

(

const TFSMailMsgId

aMessageId

)

removes given message from folder

Parameters

const TFSMailMsgId aMessageId

id of message to be removed

SupportsCopyFromL(TFSFolderType)

IMPORT_C TBool

SupportsCopyFromL

(

TFSFolderType

aFolderType

)

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

Parameters

TFSFolderType aFolderType

folder type

SupportsMoveFromL(TFSFolderType)

IMPORT_C TBool

SupportsMoveFromL

(

TFSFolderType

aFolderType

)

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

Parameters

TFSFolderType aFolderType

folder type

Member Data Documentation

CFSMailRequestHandler * iRequestHandler

CFSMailRequestHandler *

iRequestHandler

[private]

request handler for plugin requests