Swift_Transport_SendmailTransport Class Reference

Inheritance diagram for Swift_Transport_SendmailTransport:

Public Member Functions
	__construct (Swift_Transport_IoBuffer $buf, Swift_Events_EventDispatcher $dispatcher)
	start ()
	setCommand ($command)
	getCommand ()
	send (Swift_Mime_Message $message, &$failedRecipients=null)
Public Member Functions inherited from Swift_Transport_AbstractSmtpTransport
	__construct (Swift_Transport_IoBuffer $buf, Swift_Events_EventDispatcher $dispatcher)
	setLocalDomain ($domain)
	getLocalDomain ()
	setSourceIp ($source)
	getSourceIp ()
	start ()
	isStarted ()
	send (Swift_Mime_Message $message, &$failedRecipients=null)
	stop ()
	registerPlugin (Swift_Events_EventListener $plugin)
	reset ()
	getBuffer ()
	executeCommand ($command, $codes=array(), &$failures=null)
	__destruct ()

Protected Member Functions
	_getBufferParams ()
Protected Member Functions inherited from Swift_Transport_AbstractSmtpTransport
	_getBufferParams ()
	_readGreeting ()
	_doHeloCommand ()
	_doMailFromCommand ($address)
	_doRcptToCommand ($address)
	_doDataCommand ()
	_streamMessage (Swift_Mime_Message $message)
	_getReversePath (Swift_Mime_Message $message)
	_throwException (Swift_TransportException $e)
	_assertResponseCode ($response, $wanted)
	_getFullResponse ($seq)

Private Attributes
	$_params

Additional Inherited Members
Protected Attributes inherited from Swift_Transport_AbstractSmtpTransport
	$_buffer
	$_started = false
	$_domain = '[127.0.0.1]'
	$_eventDispatcher
	$_sourceIp

Detailed Description

SendmailTransport for sending mail through a Sendmail/Postfix (etc..) binary.

Supported modes are -bs and -t, with any additional flags desired. It is advised to use -bs mode since error reporting with -t mode is not possible.

Author

Chris Corbyn

Definition at line 20 of file Transport/SendmailTransport.php.

Constructor & Destructor Documentation

__construct	(	Swift_Transport_IoBuffer	$buf,
		Swift_Events_EventDispatcher	$dispatcher
	)

Create a new SendmailTransport with $buf for I/O.

Parameters

Swift_Transport_IoBuffer	$buf
Swift_Events_EventDispatcher	$dispatcher

Definition at line 40 of file Transport/SendmailTransport.php.

Member Function Documentation

_getBufferParams ( )

protected

Get the params to initialize the buffer

Definition at line 155 of file Transport/SendmailTransport.php.

References $_params.

getCommand

(

)

Get the sendmail command which will be invoked.

Returns

string

Definition at line 81 of file Transport/SendmailTransport.php.

Referenced by send(), and start().

send	(	Swift_Mime_Message	$message,
		&	$failedRecipients = null
	)

Send the given Message.

Recipient/sender data will be retrieved from the Message API.

The return value is the number of recipients who were accepted for delivery. NOTE: If using 'sendmail -t' you will not be aware of any failures until they bounce (i.e. send() will always return 100% success).

Parameters

Swift_Mime_Message	$message
	string[]	$failedRecipients An array of failures by-reference

Returns

int

Implements Swift_Transport.

Definition at line 100 of file Transport/SendmailTransport.php.

References Swift_Transport_AbstractSmtpTransport\_getReversePath(), Swift_Transport_AbstractSmtpTransport\_throwException(), elseif, Swift_Mime_Message\generateId(), Swift_Mime_Message\getBcc(), Swift_Transport_AbstractSmtpTransport\getBuffer(), Swift_Mime_Message\getCc(), getCommand(), Swift_Mime_Message\getTo(), Swift_Events_SendEvent\RESULT_SUCCESS, and Swift_Mime_MimeEntity\toByteStream().

setCommand

(

$command

)

Set the command to invoke.

If using -t mode you are strongly advised to include -oi or -i in the flags. For example: /usr/sbin/sendmail -oi -t Swift will append a -f<sender> flag if one is not present.

The recommended mode is "-bs" since it is interactive and failure notifications are hence possible.

Parameters

string

$command

Returns

Swift_Transport_SendmailTransport

Definition at line 69 of file Transport/SendmailTransport.php.

Referenced by Swift_SendmailTransport\__construct().

start

(

)

Start the standalone SMTP session if running in -bs mode.

Implements Swift_Transport.

Definition at line 48 of file Transport/SendmailTransport.php.

References getCommand().

Member Data Documentation

$_params

private

Initial value:

= array(
        'timeout' => 30,
        'blocking' => 1,
        'command' => '/usr/sbin/sendmail -bs',
        'type' => Swift_Transport_IoBuffer::TYPE_PROCESS,
        )

Definition at line 27 of file Transport/SendmailTransport.php.

Referenced by _getBufferParams().