courierMaildirFormat Class Reference

Reads Courier/QMail Maildir format. More...

Inheritance diagram for courierMaildirFormat:

[legend]

Collaboration diagram for courierMaildirFormat:

[legend]

List of all members.

Public Member Functions
	courierMaildirFormat (ref< 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
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)

---

Detailed Description

Reads Courier/QMail Maildir format.

---

Constructor & Destructor Documentation

courierMaildirFormat

(

ref< context >

ctx

)

---

Member Function Documentation

void createFolder

(

const folder::path &

path

)

[virtual]

Create the specified folder.

Parameters:

path

virtual path of the folder

Exceptions:

filesystem_exception,invalid_folder_name

Implements maildirFormat.

void destroyFolder

(

const folder::path &

path

)

[virtual]

Destroy the specified folder.

Parameters:

path

virtual path of the folder

Exceptions:

filesystem_exception

Implements maildirFormat.

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.

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.

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 courierMaildirFormat::listDirectories().

const folder::path::component fromModifiedUTF7

(

const string &

text

)

[static, protected]

const string getName

(

)

const [virtual]

Return the name of this Maildir format.

Returns:

format name

Implements maildirFormat.

bool isSubfolderDirectory

(

const utility::file &

file

)

[static, protected]

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

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

Referenced by courierMaildirFormat::folderPathToFileSystemPath().

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.

Returns:

list of subfolders

Implements maildirFormat.

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

Rename the specified folder.

Parameters:

	oldPath	old virtual path of the folder
	newPath	new virtual path of the folder

Exceptions:

filesystem_exception

Implements maildirFormat.

void renameFolderImpl	(	const folder::path &	oldPath,
		const folder::path &	newPath
	)			[protected]

bool supports

(

)

const [protected, virtual]

Quick checks whether this implementation can read the Maildir format in the specified directory.

Returns:

true if the implementation supports the specified Maildir, or false otherwise

Implements maildirFormat.

const string toModifiedUTF7

(

const folder::path::component &

text

)

[static, protected]

---

The documentation for this class was generated from the following files:

• courierMaildirFormat.hpp
• courierMaildirFormat.cpp