Class: Swift_Transport_EsmtpTransport

Source Location: /vendors/swift/classes/Swift/Transport/EsmtpTransport.php

Class Overview

Swift_Transport_AbstractSmtpTransport
   |
   --Swift_Transport_EsmtpTransport

Sends Messages over SMTP with ESMTP support.

Author(s):

Chris Corbyn

Implements interfaces:

Swift_Transport_SmtpAgent

Methods

Child classes:

Swift_SmtpTransport: Sends Messages over SMTP with ESMTP support.

Inherited Variables

Class: Swift_Transport_AbstractSmtpTransport

Swift_Transport_AbstractSmtpTransport::$_buffer
Swift_Transport_AbstractSmtpTransport::$_domain
Swift_Transport_AbstractSmtpTransport::$_eventDispatcher
Swift_Transport_AbstractSmtpTransport::$_started

Inherited Methods

Class: Swift_Transport_AbstractSmtpTransport

Swift_Transport_AbstractSmtpTransport::__construct(): Creates a new EsmtpTransport using the given I/O buffer.
Swift_Transport_AbstractSmtpTransport::executeCommand(): Run a command against the buffer, expecting the given response codes.
Swift_Transport_AbstractSmtpTransport::getBuffer(): Get the IoBuffer where read/writes are occurring.
Swift_Transport_AbstractSmtpTransport::getLocalDomain(): Get the name of the domain Swift will identify as.
Swift_Transport_AbstractSmtpTransport::isStarted(): Test if an SMTP connection has been established.
Swift_Transport_AbstractSmtpTransport::registerPlugin(): Register a plugin.
Swift_Transport_AbstractSmtpTransport::reset(): Reset the current mail transaction.
Swift_Transport_AbstractSmtpTransport::send(): Send the given Message.
Swift_Transport_AbstractSmtpTransport::setLocalDomain(): Set the name of the local domain which Swift will identify itself as.
Swift_Transport_AbstractSmtpTransport::start(): Start the SMTP connection.
Swift_Transport_AbstractSmtpTransport::stop(): Stop the SMTP connection.
Swift_Transport_AbstractSmtpTransport::_assertResponseCode(): Throws an Exception if a response code is incorrect
Swift_Transport_AbstractSmtpTransport::_doDataCommand(): Send the DATA command
Swift_Transport_AbstractSmtpTransport::_doHeloCommand(): Send the HELO welcome
Swift_Transport_AbstractSmtpTransport::_doMailFromCommand(): Send the MAIL FROM command
Swift_Transport_AbstractSmtpTransport::_doRcptToCommand(): Send the RCPT TO command
Swift_Transport_AbstractSmtpTransport::_getBufferParams(): Return an array of params for the Buffer
Swift_Transport_AbstractSmtpTransport::_getFullResponse(): Get an entire multi-line response using its sequence number
Swift_Transport_AbstractSmtpTransport::_getReversePath(): Determine the best-use reverse path for this message
Swift_Transport_AbstractSmtpTransport::_readGreeting(): Read the opening SMTP greeting
Swift_Transport_AbstractSmtpTransport::_streamMessage(): Stream the contents of the message over the buffer
Swift_Transport_AbstractSmtpTransport::_throwException(): Throw a TransportException, first sending it to any listeners
Swift_Transport_AbstractSmtpTransport::__destruct(): Destructor.

Class Details

[line 25]
Sends Messages over SMTP with ESMTP support.

Tags:

author:	Chris Corbyn
filesource:	Source Code for this file

[ Top ]

Class Methods

constructor __construct [line 64]

Swift_Transport_EsmtpTransport __construct(
Swift_Transport_IoBuffer
$buf, 
$extensionHandlers, Swift_Events_EventDispatcher
$dispatcher)

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

Parameters:

Swift_Transport_IoBuffer	$buf
Swift_Transport_EsmtpHandler[]	$extensionHandlers
Swift_Events_EventDispatcher	$dispatcher

[ Top ]

method executeCommand [line 182]

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.

Parameters:

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

[ Top ]

method getEncryption [line 142]

string getEncryption(
)

Get the encryption type.

Tags:

access:

public

[ Top ]

method getExtensionHandlers [line 168]

Swift_Transport_EsmtpHandler[] getExtensionHandlers(
)

Get ESMTP extension handlers.

Tags:

access:

public

[ Top ]

method getHost [line 85]

string getHost(
)

Get the host to connect to.

Tags:

access:

public

[ Top ]

method getPort [line 104]

int getPort(
)

Get the port to connect to.

Tags:

access:

public

[ Top ]

method getTimeout [line 123]

int getTimeout(
)

Get the connection timeout.

Tags:

access:

public

[ Top ]

method setEncryption [line 132]

void setEncryption(

$enc, string
$encryption)

Set the encryption type (tls or ssl)

Tags:

access:

public

Parameters:

string	$encryption
	$enc

[ Top ]

method setExtensionHandlers [line 151]

void setExtensionHandlers(

$handlers)

Set ESMTP extension handlers.

Tags:

access:

public

Parameters:

Swift_Transport_EsmtpHandler[]

$handlers

[ Top ]

method setHost [line 75]

void setHost(
string
$host)

Set the host to connect to.

Tags:

access:

public

Parameters:

string

$host

[ Top ]

method setPort [line 94]

void setPort(
int
$port)

Set the port to connect to.

Tags:

access:

public

Parameters:

int

$port

[ Top ]

method setTimeout [line 113]

void setTimeout(
int
$timeout)

Set the connection timeout.

Tags:

access:

public

Parameters:

int

$timeout

seconds

[ Top ]

method _doHeloCommand [line 235]

void _doHeloCommand(
)

Overridden to perform EHLO instead

Tags:

access:

protected

Overrides Swift_Transport_AbstractSmtpTransport::_doHeloCommand() (Send the HELO welcome)

[ Top ]

method _doMailFromCommand [line 257]

void _doMailFromCommand(

$address)

Overridden to add Extension support

Tags:

access:

protected

Overrides Swift_Transport_AbstractSmtpTransport::_doMailFromCommand() (Send the MAIL FROM command)

Parameters:

$address

[ Top ]

method _doRcptToCommand [line 272]

void _doRcptToCommand(

$address)

Overridden to add Extension support

Tags:

access:

protected

Overrides Swift_Transport_AbstractSmtpTransport::_doRcptToCommand() (Send the RCPT TO command)

Parameters:

$address

[ Top ]

method _getBufferParams [line 229]

void _getBufferParams(
)

Get the params to initialize the buffer

Tags:

access:

protected

Overrides Swift_Transport_AbstractSmtpTransport::_getBufferParams() (Return an array of params for the Buffer)

[ Top ]

method __call [line 203]

void __call(

$method, 
$args)

Mixin handling method for ESMTP handlers

Tags:

access:

public

Parameters:

	$method
	$args

[ Top ]

Documentation generated on Mon, 05 Sep 2011 20:33:16 -0500 by phpDocumentor 1.4.3