maildirStore Class Reference

maildir store service. More...

Inheritance diagram for maildirStore:

[legend]

Collaboration diagram for maildirStore:

[legend]

List of all members.

Public Member Functions
	maildirStore (ref< session > sess, ref< security::authenticator > auth)
	~maildirStore ()
const string	getProtocolName () const
ref< folder >	getDefaultFolder ()
ref< folder >	getRootFolder ()
ref< folder >	getFolder (const folder::path &path)
bool	isValidFolderName (const folder::path::component &name) const
const serviceInfos &	getInfos () const
void	connect ()
bool	isConnected () const
void	disconnect ()
void	noop ()
const utility::path &	getFileSystemPath () const
int	getCapabilities () const
bool	isSecuredConnection () const
ref< connectionInfos >	getConnectionInfos () const
ref< maildirFormat >	getFormat ()
ref< const maildirFormat >	getFormat () const
Static Public Member Functions
static const serviceInfos &	getInfosInstance ()

---

Detailed Description

maildir store service.

---

Constructor & Destructor Documentation

maildirStore	(	ref< session >	sess,
		ref< security::authenticator >	auth
	)

~maildirStore

(

)

References maildirStore::disconnect(), and maildirStore::isConnected().

---

Member Function Documentation

void connect

(

)

[virtual]

Connect to service.

Implements service.

References maildirFormat::detect(), GET_PROPERTY, platform::getHandler(), and maildirStore::isConnected().

void disconnect

(

)

[virtual]

Disconnect from service.

Implements service.

Referenced by maildirStore::~maildirStore().

int getCapabilities

(

)

const [virtual]

Return the features supported by this service.

This is a combination of store::CAPABILITY_xxx flags.

Returns:

features supported by this service

Implements store.

References store::CAPABILITY_ADD_MESSAGE, store::CAPABILITY_COPY_MESSAGE, store::CAPABILITY_CREATE_FOLDER, store::CAPABILITY_DELETE_MESSAGE, store::CAPABILITY_EXTRACT_PART, store::CAPABILITY_MESSAGE_FLAGS, store::CAPABILITY_PARTIAL_FETCH, and store::CAPABILITY_RENAME_FOLDER.

ref< connectionInfos > getConnectionInfos

(

)

const [virtual]

Get information about the connection.

Returns:

information about the connection

Implements service.

ref< folder > getDefaultFolder

(

)

[virtual]

Return the default folder.

This is protocol dependent and usually is the INBOX folder.

Returns:

default folder

Implements store.

References maildirStore::isConnected().

const utility::path & getFileSystemPath

(

)

const

ref< folder > getFolder

(

const folder::path &

path

)

[virtual]

Return the folder specified by the path.

Parameters:

path

absolute folder path

Returns:

folder at the specified path

Implements store.

References maildirStore::isConnected().

ref< const maildirFormat > getFormat

(

)

const

ref< maildirFormat > getFormat

(

)

const serviceInfos & getInfos

(

)

const [virtual]

Return information about this service.

Returns:

information about the service

Implements service.

const serviceInfos & getInfosInstance

(

)

[static]

const string getProtocolName

(

)

const [virtual]

Return the protocol name of this service.

Returns:

protocol name

Implements service.

ref< folder > getRootFolder

(

)

[virtual]

Return the root folder.

This is protocol dependent and usually is the user's mail drop root folder.

Returns:

root folder

Implements store.

References maildirStore::isConnected().

bool isConnected

(

)

const [virtual]

Test whether this service is connected.

Returns:

true if the service is connected, false otherwise

Implements service.

Referenced by maildirStore::connect(), maildirStore::getDefaultFolder(), maildirStore::getFolder(), maildirStore::getRootFolder(), and maildirStore::~maildirStore().

bool isSecuredConnection

(

)

const [virtual]

Check whether the connection is secured.

Returns:

true if the connection is secured, false otherwise

Implements service.

bool isValidFolderName

(

const folder::path::component &

name

)

const [virtual]

Test whether the specified folder name is a syntactically a valid name.

Returns:

true if the specified folder name is valid, false otherwise

Implements store.

References word::getBuffer(), platform::getHandler(), and stringUtils::trim().

void noop

(

)

[virtual]

Do nothing but ensure the server do not disconnect (for example, this can reset the auto-logout timer on the server, if one exists).

Implements service.

---

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

• maildirStore.hpp
• maildirStore.cpp