#include <serviceInfos.hpp>

Inheritance diagram for serviceInfos:

[legend]

Classes
class	property

Public Member Functions
virtual	~serviceInfos ()
virtual const string	getPropertyPrefix () const =0
virtual const std::vector< property >	getAvailableProperties () const =0
template<typename TYPE>
const TYPE	getPropertyValue (shared_ptr< session > s, const property &p) const
bool	hasProperty (shared_ptr< session > s, const property &p) const

Protected Member Functions
	serviceInfos ()
	serviceInfos (const serviceInfos &)

Detailed Description

Stores information about a messaging service.

Constructor & Destructor Documentation

◆ serviceInfos() [1/2]

serviceInfos ( )

protected

Referenced by serviceFactory, and serviceInfos().

◆ serviceInfos() [2/2]

serviceInfos ( const serviceInfos & )

protected

References serviceInfos().

◆ ~serviceInfos()

~serviceInfos ( )

virtual

Member Function Documentation

◆ getAvailableProperties()

virtual const std::vector< property > getAvailableProperties ( ) const

pure virtual

Return a list of available properties for this service.

Returns: list of properties

Implemented in IMAPServiceInfos, maildirServiceInfos, POP3ServiceInfos, sendmailServiceInfos, and SMTPServiceInfos.

◆ getPropertyPrefix()

virtual const string getPropertyPrefix ( ) const

pure virtual

Return the property prefix used by this service.

Use this to set/get properties in the session object.

Returns: property prefix

Implemented in IMAPServiceInfos, maildirServiceInfos, POP3ServiceInfos, sendmailServiceInfos, and SMTPServiceInfos.

Referenced by getPropertyValue(), and hasProperty().

◆ getPropertyValue()

template<typename TYPE>

const TYPE getPropertyValue	(	shared_ptr< session >	s,
		const property &	p ) const

Helper function to retrieve the value of a property.

Parameters

s	session object
p	property to retrieve

Exceptions

exceptions::no_such_property if the property does not exist and has the flag property::FLAG_REQUIRED

Returns: value of the property

References serviceInfos::property::FLAG_REQUIRED, serviceInfos::property::getDefaultValue(), serviceInfos::property::getFlags(), serviceInfos::property::getName(), and getPropertyPrefix().

◆ hasProperty()

bool hasProperty	(	shared_ptr< session >	s,
		const property &	p ) const

Helper function to test if the specified property is set in the session object.

Parameters

s	session object
p	property to test

Returns: true if the property is set, false otherwise

References serviceInfos::property::getName(), getPropertyPrefix(), and hasProperty().

Referenced by hasProperty().

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

Classes

Public Member Functions

Protected Member Functions