transport Class Reference

#include <transport.hpp>

Inheritance diagram for transport:

Collaboration diagram for transport:

Public Member Functions
virtual void	send (shared_ptr< vmime::message > msg, utility::progressListener *progress=NULL)
virtual void	send (const mailbox &expeditor, const mailboxList &recipients, utility::inputStream &is, const size_t size, utility::progressListener *progress=NULL, const mailbox &sender=mailbox())=0
virtual void	send (shared_ptr< vmime::message > msg, const mailbox &expeditor, const mailboxList &recipients, utility::progressListener *progress=NULL, const mailbox &sender=mailbox())
Type	getType () const
Public Member Functions inherited from service
virtual	~service ()
virtual const string	getProtocolName () const =0
shared_ptr< const session >	getSession () const
shared_ptr< session >	getSession ()
virtual const serviceInfos &	getInfos () const =0
virtual void	connect ()=0
virtual void	disconnect ()=0
virtual bool	isConnected () const =0
virtual void	noop ()=0
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)
virtual bool	isSecuredConnection () const =0
virtual shared_ptr< connectionInfos >	getConnectionInfos () const =0

Protected Member Functions
	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 ()

Additional Inherited Members
Public Types inherited from service
enum	Type { TYPE_STORE = 0 , TYPE_TRANSPORT }

Detailed Description

A transport service.

Encapsulate protocols that can send messages.

Constructor & Destructor Documentation

transport()

transport ( shared_ptr< session >  sess, const serviceInfos &  infos, shared_ptr< security::authenticator >  auth  )

protected

Member Function Documentation

getType()

transport::Type getType ( ) const

virtual

Return the type of service.

Returns

type of service

Implements service.

References service::TYPE_TRANSPORT.

processHeader()

void processHeader ( shared_ptr< header >  header )

protected

Prepares the header before transmitting the message.

Removes headers that should not be present (eg. "Bcc", "Return-Path"), or adds missing headers that are required/recommended by the RFCs. The header is modified inline.

Parameters

header

headers to process

References vmime::fields::DATE, header::Date(), vmime::dynamicCast(), messageId::generateId(), header::getFieldAt(), header::getFieldCount(), header::hasField(), vmime::fields::MESSAGE_ID, header::MessageId(), vmime::fields::MIME_VERSION, header::MimeVersion(), datetime::now(), transport::processHeaderField(), header::removeField(), header::replaceField(), and vmime::SUPPORTED_MIME_VERSION.

Referenced by transport::send().

processHeaderField()

shared_ptr< headerField > processHeaderField ( shared_ptr< headerField >  field )

protected

Called by processHeader().

Decides what to do with the specified header field.

Returns

NULL if the header should be removed, a reference to a new headerField if the field is to be replaced, or a reference to the same headerField that was passed if the field should be left as is

References vmime::fields::BCC, vmime::dynamicCast(), stringUtils::isStringEqualNoCase(), vmime::fields::ORIGINAL_RECIPIENT, and vmime::fields::RETURN_PATH.

Referenced by transport::processHeader().

send() [1/3]

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

pure 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)

Implemented in sendmailTransport, and SMTPTransport.

send() [2/3]

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 in SMTPTransport.

References vmime::dynamicCast(), and transport::send().

send() [3/3]

void send ( shared_ptr< vmime::message >  msg, utility::progressListener *  progress = NULL  )

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
progress	progress listener, or NULL if not used

References vmime::fields::BCC, vmime::fields::CC, vmime::clone(), vmime::dynamicCast(), vmime::fields::FROM, transport::processHeader(), transport::send(), vmime::fields::SENDER, and vmime::fields::TO.

Referenced by transport::send(), and transport::send().

---

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

• transport.hpp
• transport.cpp