Inheritance diagram for maildirFormat:

Collaboration diagram for maildirFormat:

[legend]

Classes
class	context

Public Types
enum	DirectoryType { ROOT_DIRECTORY, NEW_DIRECTORY, CUR_DIRECTORY, TMP_DIRECTORY, CONTAINER_DIRECTORY }

Public Member Functions
virtual const string	getName () const =0

virtual void	createFolder (const folder::path &path)=0

virtual void	destroyFolder (const folder::path &path)=0

virtual void	renameFolder (const folder::path &oldPath, const folder::path &newPath)=0

virtual bool	folderExists (const folder::path &path) const =0

virtual bool	folderHasSubfolders (const folder::path &path) const =0

virtual const utility::file::path	folderPathToFileSystemPath (const folder::path &path, const DirectoryType type) const =0

virtual const std::vector< folder::path >	listFolders (const folder::path &root, const bool recursive) const =0

Static Public Member Functions
static shared_ptr< maildirFormat >	detect (shared_ptr< maildirStore > store)

Protected Member Functions
	maildirFormat (shared_ptr< context > ctx)

shared_ptr< context >	getContext ()

shared_ptr< const context >	getContext () const

virtual bool	supports () const =0

Protected Member Functions inherited from object
	object ()

	object (const object &)

object &	operator= (const object &)

virtual	~object ()

Static Protected Attributes
static const utility::file::path::component	TMP_DIR

static const utility::file::path::component	CUR_DIR

static const utility::file::path::component	NEW_DIR

Detailed Description

Interface for an object capable of reading a specific Maildir format.

Member Enumeration Documentation

◆ DirectoryType

enum DirectoryType

Physical directory types.

Enumerator
ROOT_DIRECTORY	Root directory.
NEW_DIRECTORY	Directory containing unread messages.
CUR_DIRECTORY	Directory containing messages that have been seen.
TMP_DIRECTORY	Temporary directory used for reliable delivery.
CONTAINER_DIRECTORY	Container for subfolders.

Constructor & Destructor Documentation

◆ maildirFormat()

maildirFormat ( shared_ptr< context > ctx )

protected

Member Function Documentation

◆ createFolder()

virtual void createFolder ( const folder::path & path )

pure virtual

Create the specified folder.

Parameters

path	virtual path of the folder

Exceptions

exceptions::filesystem_exception,invalid_folder_name

Implemented in courierMaildirFormat, and kmailMaildirFormat.

◆ destroyFolder()

virtual void destroyFolder ( const folder::path & path )

pure virtual

Destroy the specified folder.

Parameters

path	virtual path of the folder

Exceptions

exceptions::filesystem_exception

Implemented in courierMaildirFormat, and kmailMaildirFormat.

◆ detect()

shared_ptr< maildirFormat > detect ( shared_ptr< maildirStore > store )

static

Try to detect the format of the specified Maildir store.

If the format cannot be detected, a compatible implementation will be returned.

Parameters

store of which to detect format

Returns: a Maildir format implementation for the specified store

Referenced by maildirStore::connect().

◆ folderExists()

virtual bool folderExists ( const folder::path & path ) const

pure virtual

Test whether the specified folder exists.

Parameters

path	virtual path of the folder

Returns: true if the folder exists, false otherwise

Implemented in courierMaildirFormat, and kmailMaildirFormat.

◆ folderHasSubfolders()

virtual bool folderHasSubfolders ( const folder::path & path ) const

pure virtual

Test whether the specified folder has subfolders.

Parameters

path	virtual path of the folder

Returns: true if the folder has at least one subfolder, false otherwise

Implemented in courierMaildirFormat, and kmailMaildirFormat.

◆ folderPathToFileSystemPath()

virtual const utility::file::path folderPathToFileSystemPath	(	const folder::path &	path,
		const DirectoryType	type
	)		const

pure virtual

Returns the directory which represents the specified folder on the file system.

Parameters

path	virtual path of the folder
type	type of directory to return

Returns: corresponding directory on the file system

Implemented in courierMaildirFormat, and kmailMaildirFormat.

◆ getContext() [1/2]

shared_ptr< maildirFormat::context > getContext ( )

protected

Returns the current context.

Returns: current context

Referenced by courierMaildirFormat::folderPathToFileSystemPath(), kmailMaildirFormat::folderPathToFileSystemPath(), courierMaildirFormat::listDirectories(), and courierMaildirFormat::supports().

◆ getContext() [2/2]

shared_ptr< const maildirFormat::context > getContext ( ) const

protected

Returns the current context (const version).

Returns: current context

◆ getName()

virtual const string getName ( ) const

pure virtual

Return the name of this Maildir format.

Returns: format name

Implemented in courierMaildirFormat, and kmailMaildirFormat.

◆ listFolders()

virtual const std::vector<folder::path> listFolders	(	const folder::path &	root,
		const bool	recursive
	)		const

pure virtual

List subfolders in the specified folder.

Parameters

root	root folder in which to start the search
recursive	if set to true, all the descendant are returned; if set to false, only direct children are returned.