SMTPTransport Class Reference

#include <SMTPTransport.hpp>

Inheritance diagram for SMTPTransport:

Collaboration diagram for SMTPTransport:

Public Member Functions
	SMTPTransport (shared_ptr< session > sess, shared_ptr< security::authenticator > auth, const bool secured=false)
	~SMTPTransport ()
const string	getProtocolName () const
const serviceInfos &	getInfos () const
void	connect ()
bool	isConnected () const
void	disconnect ()
void	noop ()
void	send (const mailbox &expeditor, const mailboxList &recipients, utility::inputStream &is, const size_t size, utility::progressListener *progress=NULL, const mailbox &sender=mailbox())
void	send (shared_ptr< vmime::message > msg, const mailbox &expeditor, const mailboxList &recipients, utility::progressListener *progress=NULL, const mailbox &sender=mailbox())
bool	isSecuredConnection () const
shared_ptr< connectionInfos >	getConnectionInfos () const
shared_ptr< SMTPConnection >	getConnection ()
bool	isSMTPS () const
Public Member Functions inherited from transport
virtual void	send (shared_ptr< vmime::message > msg, utility::progressListener *progress=NULL)
Type	getType () const
Public Member Functions inherited from service
virtual	~service ()
shared_ptr< const session >	getSession () const
shared_ptr< session >	getSession ()
shared_ptr< const security::authenticator >	getAuthenticator () const
shared_ptr< security::authenticator >	getAuthenticator ()
void	setAuthenticator (shared_ptr< security::authenticator > auth)
void	setCertificateVerifier (shared_ptr< security::cert::certificateVerifier > cv)
shared_ptr< security::cert::certificateVerifier >	getCertificateVerifier ()
void	setSocketFactory (shared_ptr< socketFactory > sf)
shared_ptr< socketFactory >	getSocketFactory ()
void	setTimeoutHandlerFactory (shared_ptr< timeoutHandlerFactory > thf)
shared_ptr< timeoutHandlerFactory >	getTimeoutHandlerFactory ()
void	setTracerFactory (shared_ptr< tracerFactory > tf)
shared_ptr< tracerFactory >	getTracerFactory ()
template<typename TYPE >
void	setProperty (const string &name, const TYPE &value)

Static Public Member Functions
static const serviceInfos &	getInfosInstance ()

Additional Inherited Members
Public Types inherited from service
enum	Type { TYPE_STORE = 0 , TYPE_TRANSPORT }
Protected Member Functions inherited from transport
	transport (shared_ptr< session > sess, const serviceInfos &infos, shared_ptr< security::authenticator > auth)
shared_ptr< headerField >	processHeaderField (shared_ptr< headerField > field)
void	processHeader (shared_ptr< header > header)
Protected Member Functions inherited from service
	service (shared_ptr< session > sess, const serviceInfos &infos, shared_ptr< security::authenticator > auth)
Protected Member Functions inherited from object
	object ()
	object (const object &)
object &	operator= (const object &)
virtual	~object ()

Detailed Description

SMTP transport service.

Constructor & Destructor Documentation

SMTPTransport()

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

~SMTPTransport()

~SMTPTransport

(

)

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

Member Function Documentation

connect()

void connect ( )

virtual

Connect to service.

Implements service.

References vmime::dynamicCast(), service::getAuthenticator(), and SMTPTransport::isConnected().

disconnect()

void disconnect ( )

virtual

Disconnect from service.

Implements service.

References vmime::dynamicCast(), and SMTPTransport::isConnected().

Referenced by SMTPTransport::~SMTPTransport().

getConnection()

shared_ptr< SMTPConnection > getConnection

(

)

getConnectionInfos()

shared_ptr< connectionInfos > getConnectionInfos ( ) const

virtual

Get information about the connection.

Returns

information about the connection

Implements service.

References vmime::dynamicCast().

getInfos()

const serviceInfos & getInfos ( ) const

virtual

Return information about this service.

Returns

information about the service

Implements service.

Referenced by SMTPTransport::send().

getInfosInstance()

const serviceInfos & getInfosInstance ( )

static

getProtocolName()

const string getProtocolName ( ) const

virtual

Return the protocol name of this service.

Returns

protocol name

Implements service.

isConnected()

bool isConnected ( ) const

virtual

Test whether this service is connected.

Returns

true if the service is connected, false otherwise

Implements service.

Referenced by SMTPTransport::connect(), SMTPTransport::disconnect(), SMTPTransport::noop(), SMTPTransport::send(), SMTPTransport::send(), and SMTPTransport::~SMTPTransport().

isSecuredConnection()

bool isSecuredConnection ( ) const

virtual

Check whether the connection is secured.

Returns

true if the connection is secured, false otherwise

Implements service.

References vmime::dynamicCast().

isSMTPS()

bool isSMTPS

(

)

const

noop()

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 vmime::dynamicCast(), SMTPTransport::isConnected(), and SMTPCommand::NOOP().

send() [1/2]

void send ( const mailbox &  expeditor, const mailboxList &  recipients, utility::inputStream &  is, const size_t  size, utility::progressListener *  progress = NULL, const mailbox &  sender = mailbox()  )

virtual

Send a message over this transport service.

Parameters

expeditor	expeditor mailbox
recipients	list of recipient mailboxes
is	input stream providing message data (header + body)
size	size of the message data
progress	progress listener, or NULL if not used
sender	envelope sender (if empty, expeditor will be used)

Implements transport.

References vmime::utility::bufferedStreamCopy(), vmime::dynamicCast(), and SMTPTransport::isConnected().

Referenced by SMTPTransport::send().

send() [2/2]

void send ( shared_ptr< vmime::message >  msg, const mailbox &  expeditor, const mailboxList &  recipients, utility::progressListener *  progress = NULL, const mailbox &  sender = mailbox()  )

virtual

Send a message over this transport service.

The default implementation simply generates the whole message into a string buffer and "streams" it via a inputStreamStringAdapter.

Parameters

msg	message to send
expeditor	expeditor mailbox
recipients	list of recipient mailboxes
progress	progress listener, or NULL if not used
sender	envelope sender (if empty, expeditor will be used)

Reimplemented from transport.

References vmime::dynamicCast(), generationContext::getDefaultContext(), SMTPTransport::getInfos(), service::getSession(), SMTPTransport::isConnected(), and SMTPTransport::send().

---

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

• SMTPTransport.hpp
• SMTPTransport.cpp