#include <courierMaildirFormat.hpp>

Inheritance diagram for courierMaildirFormat:

[legend]

Collaboration diagram for courierMaildirFormat:

[legend]

Public Member Functions
	courierMaildirFormat (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	renameFolderImpl (const folder::path &oldPath, const folder::path &newPath)

bool	listDirectories (const folder::path &root, std::vector< string > &dirs, const bool onlyTestForExistence) 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 const string	toModifiedUTF7 (const folder::path::component &text)

static const folder::path::component	fromModifiedUTF7 (const string &text)

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 Courier/QMail Maildir format.

Constructor & Destructor Documentation

◆ courierMaildirFormat()

courierMaildirFormat ( 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, vmime::dynamicCast(), courierMaildirFormat::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 vmime::dynamicCast(), courierMaildirFormat::folderPathToFileSystemPath(), platform::getHandler(), courierMaildirFormat::listFolders(), 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, vmime::dynamicCast(), courierMaildirFormat::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 vmime::dynamicCast(), and courierMaildirFormat::listDirectories().

◆ 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, maildirFormat::CUR_DIR, maildirFormat::CUR_DIRECTORY, vmime::dynamicCast(), maildirFormat::getContext(), maildirFormat::NEW_DIR, maildirFormat::NEW_DIRECTORY, maildirFormat::ROOT_DIRECTORY, maildirFormat::TMP_DIR, maildirFormat::TMP_DIRECTORY, and courierMaildirFormat::toModifiedUTF7().

Referenced by courierMaildirFormat::createFolder(), courierMaildirFormat::destroyFolder(), courierMaildirFormat::folderExists(), and courierMaildirFormat::renameFolderImpl().

◆ fromModifiedUTF7()

const folder::path::component fromModifiedUTF7 ( const string & text )

staticprotected

References charset::convert(), vmime::dynamicCast(), vmime::charsets::UTF_7, and vmime::charsets::UTF_8.

Referenced by courierMaildirFormat::listFolders().

◆ 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 start with a '.' 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 courierMaildirFormat::listDirectories(), and courierMaildirFormat::supports().

◆ listDirectories()

bool listDirectories	(	const folder::path &	root,
		std::vector< string > &	dirs,
		const bool	onlyTestForExistence
	)		const

protected

List directories corresponding to folders which are (direct or indirect) children of specified folder.

Parameters

root	root folder
dirs	list in which found directories will be added
onlyTestForExistence	if true, the function returns as soon as the first directory is found

Returns: true if at least one directory has been found, false otherwise

References vmime::dynamicCast(), maildirFormat::getContext(), platform::getHandler(), courierMaildirFormat::isSubfolderDirectory(), and courierMaildirFormat::toModifiedUTF7().

Referenced by courierMaildirFormat::folderHasSubfolders(), and courierMaildirFormat::listFolders().

◆ 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.