IMAPStore Class Reference

IMAP store service. More...

Inheritance diagram for IMAPStore:

[legend]

Collaboration diagram for IMAPStore:

[legend]

List of all members.

Public Member Functions
	IMAPStore (ref< session > sess, ref< security::authenticator > auth, const bool secured=false)
	~IMAPStore ()
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 ()
int	getCapabilities () const
bool	isIMAPS () const
bool	isSecuredConnection () const
ref< connectionInfos >	getConnectionInfos () const
Static Public Member Functions
static const serviceInfos &	getInfosInstance ()
Protected Member Functions
ref< IMAPConnection >	connection ()
void	registerFolder (IMAPFolder *folder)
void	unregisterFolder (IMAPFolder *folder)
Protected Attributes
ref< IMAPConnection >	m_connection
std::list< IMAPFolder * >	m_folders
const bool	m_isIMAPS
Static Protected Attributes
static IMAPServiceInfos	sm_infos

---

Detailed Description

IMAP store service.

---

Constructor & Destructor Documentation

IMAPStore	(	ref< session >	sess,
		ref< security::authenticator >	auth,
		const bool	secured = false
	)

~IMAPStore

(

)

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

---

Member Function Documentation

void connect

(

)

[virtual]

Connect to service.

Implements service.

References service::getAuthenticator(), IMAPStore::isConnected(), and IMAPStore::m_connection.

ref< IMAPConnection > connection

(

)

[protected]

References IMAPStore::m_connection.

void disconnect

(

)

[virtual]

Disconnect from service.

Implements service.

References IMAPStore::isConnected(), IMAPStore::m_connection, and IMAPStore::m_folders.

Referenced by IMAPStore::~IMAPStore().

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.

References IMAPStore::m_connection.

ref< folder > getDefaultFolder

(

)

[virtual]

Return the default folder.

This is protocol dependent and usually is the INBOX folder.

Returns:

default folder

Implements store.

References IMAPStore::isConnected().

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 IMAPStore::isConnected().

const serviceInfos & getInfos

(

)

const [virtual]

Return information about this service.

Returns:

information about the service

Implements service.

Reimplemented in IMAPSStore.

References IMAPStore::sm_infos.

const serviceInfos & getInfosInstance

(

)

[static]

Reimplemented in IMAPSStore.

References IMAPStore::sm_infos.

const string getProtocolName

(

)

const [virtual]

Return the protocol name of this service.

Returns:

protocol name

Implements service.

Reimplemented in IMAPSStore.

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 IMAPStore::isConnected().

bool isConnected

(

)

const [virtual]

Test whether this service is connected.

Returns:

true if the service is connected, false otherwise

Implements service.

References IMAPStore::m_connection.

Referenced by IMAPStore::connect(), IMAPStore::disconnect(), IMAPStore::getDefaultFolder(), IMAPStore::getFolder(), IMAPStore::getRootFolder(), IMAPStore::noop(), and IMAPStore::~IMAPStore().

bool isIMAPS

(

)

const

References IMAPStore::m_isIMAPS.

bool isSecuredConnection

(

)

const [virtual]

Check whether the connection is secured.

Returns:

true if the connection is secured, false otherwise

Implements service.

References IMAPStore::m_connection.

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.

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.

References IMAPStore::isConnected(), and IMAPStore::m_connection.

void registerFolder

(

IMAPFolder *

folder

)

[protected]

References IMAPStore::m_folders.

void unregisterFolder

(

IMAPFolder *

folder

)

[protected]

References IMAPStore::m_folders.

---

Member Data Documentation

ref<IMAPConnection> m_connection [protected]

Referenced by IMAPStore::connect(), IMAPStore::connection(), IMAPStore::disconnect(), IMAPStore::getConnectionInfos(), IMAPStore::isConnected(), IMAPStore::isSecuredConnection(), and IMAPStore::noop().

std::list<IMAPFolder*> m_folders [protected]

Referenced by IMAPStore::disconnect(), IMAPStore::registerFolder(), and IMAPStore::unregisterFolder().

const bool m_isIMAPS [protected]

Referenced by IMAPStore::isIMAPS().

IMAPServiceInfos sm_infos [static, protected]

Referenced by IMAPStore::getInfos(), and IMAPStore::getInfosInstance().

---

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

• IMAPStore.hpp
• IMAPStore.cpp