Inheritance diagram for kmailMaildirFormat:

Collaboration diagram for kmailMaildirFormat:

[legend]

Public Member Functions
	kmailMaildirFormat (shared_ptr< context > ctx)

const string	getName () const

void	createFolder (const folder::path &path)

void	destroyFolder (const folder::path &path)

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

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

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

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

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

Protected Member Functions
bool	supports () const

void	listFoldersImpl (std::vector< folder::path > &list, const folder::path &root, const bool recursive) const

Protected Member Functions inherited from maildirFormat
	maildirFormat (shared_ptr< context > ctx)

shared_ptr< context >	getContext ()

shared_ptr< const context >	getContext () const

Protected Member Functions inherited from object
	object ()

	object (const object &)

object &	operator= (const object &)

virtual	~object ()

Static Protected Member Functions
static bool	isSubfolderDirectory (const utility::file &file)

Additional Inherited Members
Public Types inherited from maildirFormat
enum	DirectoryType { ROOT_DIRECTORY, NEW_DIRECTORY, CUR_DIRECTORY, TMP_DIRECTORY, CONTAINER_DIRECTORY }

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

Static Protected Attributes inherited from maildirFormat
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

Reads KMail Maildir format.

Constructor & Destructor Documentation

◆ kmailMaildirFormat()

kmailMaildirFormat ( shared_ptr< context > ctx )

Member Function Documentation

◆ createFolder()

void createFolder ( const folder::path & path )

virtual

Create the specified folder.

Parameters

path	virtual path of the folder

Exceptions

exceptions::filesystem_exception,invalid_folder_name

Implements maildirFormat.

References maildirFormat::CUR_DIRECTORY, kmailMaildirFormat::folderPathToFileSystemPath(), platform::getHandler(), maildirFormat::NEW_DIRECTORY, maildirFormat::ROOT_DIRECTORY, and maildirFormat::TMP_DIRECTORY.

◆ destroyFolder()

void destroyFolder ( const folder::path & path )

virtual

Destroy the specified folder.

Parameters

path	virtual path of the folder

Exceptions

exceptions::filesystem_exception

Implements maildirFormat.

References maildirFormat::CONTAINER_DIRECTORY, kmailMaildirFormat::folderPathToFileSystemPath(), platform::getHandler(), and maildirFormat::ROOT_DIRECTORY.

◆ folderExists()

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

virtual

Test whether the specified folder exists.

Parameters

path	virtual path of the folder

Returns: true if the folder exists, false otherwise

Implements maildirFormat.

References maildirFormat::CUR_DIRECTORY, kmailMaildirFormat::folderPathToFileSystemPath(), platform::getHandler(), maildirFormat::NEW_DIRECTORY, maildirFormat::ROOT_DIRECTORY, and maildirFormat::TMP_DIRECTORY.

◆ folderHasSubfolders()

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

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

Implements maildirFormat.

References maildirFormat::CONTAINER_DIRECTORY, kmailMaildirFormat::folderPathToFileSystemPath(), platform::getHandler(), and kmailMaildirFormat::isSubfolderDirectory().

◆ folderPathToFileSystemPath()

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

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

Implements maildirFormat.

References maildirFormat::CONTAINER_DIRECTORY, vmime::count(), maildirFormat::CUR_DIR, maildirFormat::CUR_DIRECTORY, word::getBuffer(), maildirFormat::getContext(), path::getLastComponent(), path::getSize(), kmailMaildirFormat::listFolders(), maildirFormat::NEW_DIR, maildirFormat::NEW_DIRECTORY, maildirFormat::ROOT_DIRECTORY, word::setBuffer(), maildirFormat::TMP_DIR, and maildirFormat::TMP_DIRECTORY.

Referenced by kmailMaildirFormat::createFolder(), kmailMaildirFormat::destroyFolder(), kmailMaildirFormat::folderExists(), kmailMaildirFormat::folderHasSubfolders(), kmailMaildirFormat::listFoldersImpl(), and kmailMaildirFormat::renameFolder().

◆ getName()

const string getName ( ) const

virtual

Return the name of this Maildir format.

Returns: format name

Implements maildirFormat.

◆ isSubfolderDirectory()

bool isSubfolderDirectory ( const utility::file & file )

staticprotected

Test whether the specified file system directory corresponds to a maildir subfolder.

The name of the directory should not start with '.' to be listed as a subfolder.

Parameters

file	reference to a file system directory

Returns: true if the specified directory is a maildir subfolder, false otherwise

References word::getBuffer(), file::getFullPath(), path::getLastComponent(), and file::isDirectory().

Referenced by kmailMaildirFormat::folderHasSubfolders(), and kmailMaildirFormat::listFoldersImpl().

◆ listFolders()

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

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.