Docs For Class Swift_Transport_AbstractSmtpTransport

Swift_Transport_AbstractSmtpTransport __construct(
Swift_Transport_IoBuffer
$buf, Swift_Events_EventDispatcher
$dispatcher)

Creates a new EsmtpTransport using the given I/O buffer.

Tags:

access:

public

Overridden in child classes as:

Swift_Transport_EsmtpTransport::__construct(): Creates a new EsmtpTransport using the given I/O buffer.

Swift_SmtpTransport::__construct(): Create a new SmtpTransport, optionally with $host, $port and $security.

Swift_Transport_SendmailTransport::__construct(): Create a new SendmailTransport with $buf for I/O.

Swift_SendmailTransport::__construct(): Create a new SendmailTransport, optionally using $command for sending.

Parameters:

Swift_Transport_IoBuffer	$buf
Swift_Events_EventDispatcher	$dispatcher

[ Top ]

void __destruct(
)

Destructor.

Tags:

access:

public

[ Top ]

string executeCommand(
string
$command, [int[]
$codes = array()], [string[]
&$failures = null])

Run a command against the buffer, expecting the given response codes.

If no response codes are given, the response will not be validated. If codes are given, an exception will be thrown on an invalid response.

Tags:

access:

public

Overridden in child classes as:

Swift_Transport_EsmtpTransport::executeCommand(): Run a command against the buffer, expecting the given response codes.

Parameters:

string	$command
int[]	$codes
string[]	&$failures

[ Top ]

Swift_Transport_IoBuffer getBuffer(
)

Get the IoBuffer where read/writes are occurring.

Tags:

access:

public

[ Top ]

string getLocalDomain(
)

Get the name of the domain Swift will identify as.

Tags:

access:

public

[ Top ]

boolean isStarted(
)

Test if an SMTP connection has been established.

Tags:

access:

public

Implementation of:

Swift_Transport::isStarted(): Test if this Transport mechanism has started.

[ Top ]

void registerPlugin(
Swift_Events_EventListener
$plugin)

Register a plugin.

Tags:

access:

public

Implementation of:

Swift_Transport::registerPlugin(): Register a plugin in the Transport.

Parameters:

Swift_Events_EventListener

$plugin

[ Top ]

void reset(
)

Reset the current mail transaction.

Tags:

access:

public

[ Top ]

int send(
Swift_Mime_Message
$message, [string[]
&$failedRecipients = null])

Send the given Message.

Recipient/sender data will be retreived from the Message API. The return value is the number of recipients who were accepted for delivery.

Tags:

access:

public

Overridden in child classes as:

Swift_Transport_SendmailTransport::send(): Send the given Message.

Implementation of:

Swift_Transport::send(): Send the given Message.

Parameters:

Swift_Mime_Message	$message
string[]	&$failedRecipients	to collect failures by-reference

[ Top ]

void setLocalDomain(
string
$domain)

Set the name of the local domain which Swift will identify itself as.

This should be a fully-qualified domain name and should be truly the domain you're using. If your server doesn't have a domain name, use the IP in square brackets (i.e. [127.0.0.1]).

Tags:

access:

public

Parameters:

string

$domain

[ Top ]

void start(
)

Start the SMTP connection.

Tags:

access:

public

Overridden in child classes as:

Swift_Transport_SendmailTransport::start(): Start the standalone SMTP session if running in -bs mode.

Implementation of:

Swift_Transport::start(): Start this Transport mechanism.

[ Top ]

void stop(
)

Stop the SMTP connection.

Tags:

access:

public

Implementation of:

Swift_Transport::stop(): Stop this Transport mechanism.

[ Top ]

void _assertResponseCode(

$response, 
$wanted)

Throws an Exception if a response code is incorrect

Tags:

access:

protected

Parameters:

	$response
	$wanted

[ Top ]

void _doDataCommand(
)

Send the DATA command

Tags:

access:

protected

[ Top ]

void _doHeloCommand(
)

Send the HELO welcome

Tags:

access:

protected

Overridden in child classes as:

Swift_Transport_EsmtpTransport::_doHeloCommand(): Overridden to perform EHLO instead

[ Top ]

void _doMailFromCommand(

$address)

Send the MAIL FROM command

Tags:

access:

protected

Overridden in child classes as:

Swift_Transport_EsmtpTransport::_doMailFromCommand(): Overridden to add Extension support

Parameters:

$address

[ Top ]

void _doRcptToCommand(

$address)

Send the RCPT TO command

Tags:

access:

protected

Overridden in child classes as:

Swift_Transport_EsmtpTransport::_doRcptToCommand(): Overridden to add Extension support

Parameters:

$address

[ Top ]

void _getBufferParams(
)

Return an array of params for the Buffer

Tags:

abstract:
access:	protected

Overridden in child classes as:

Swift_Transport_EsmtpTransport::_getBufferParams(): Get the params to initialize the buffer

Swift_Transport_SendmailTransport::_getBufferParams(): Get the params to initialize the buffer

[ Top ]

void _getFullResponse(

$seq)

Get an entire multi-line response using its sequence number

Tags:

access:

protected

Parameters:

$seq

[ Top ]

void _getReversePath(
Swift_Mime_Message
$message)

Determine the best-use reverse path for this message

Tags:

access:

protected

Parameters:

Swift_Mime_Message

$message

[ Top ]

void _readGreeting(
)

Read the opening SMTP greeting

Tags:

access:

protected

[ Top ]

void _streamMessage(
Swift_Mime_Message
$message)

Stream the contents of the message over the buffer

Tags:

access:

protected

Parameters:

Swift_Mime_Message

$message

[ Top ]

void _throwException(
Swift_TransportException
$e)

Throw a TransportException, first sending it to any listeners

Tags:

access:

protected

Parameters:

Swift_TransportException

$e

[ Top ]

Class: Swift_Transport_AbstractSmtpTransport

Class Overview

Author(s):

Variables

Methods

Child classes:

Class Details

Tags:

Class Variables

$_buffer =

Tags:

$_domain = '[127.0.0.1]'

Tags:

$_eventDispatcher =

Tags:

$_started = false

Tags:

Class Methods

constructor __construct [line 51]

Tags:

Parameters:

destructor __destruct [line 538]

Tags:

method executeCommand [line 281]

Tags:

Parameters:

method getBuffer [line 265]

Tags:

method getLocalDomain [line 78]

Tags:

method isStarted [line 124]

Tags:

method registerPlugin [line 247]

Tags:

Parameters:

method reset [line 255]

Tags:

method send [line 139]

Tags:

Parameters:

method setLocalDomain [line 67]

Tags:

Parameters:

method start [line 86]

Tags:

method stop [line 206]

Tags:

method _assertResponseCode [line 392]

Tags:

Parameters:

method _doDataCommand [line 327]

Tags:

method _doHeloCommand [line 303]

Tags:

method _doMailFromCommand [line 311]

Tags:

Parameters:

method _doRcptToCommand [line 319]

Tags:

Parameters:

method _getBufferParams [line 43]

Tags:

method _getFullResponse [line 415]

Tags:

Parameters:

method _getReversePath [line 350]

Tags:

Parameters:

method _readGreeting [line 297]

Tags:

method _streamMessage [line 333]

Tags:

Parameters:

method _throwException [line 375]

Tags:

Parameters: