Documentation

Swift_Transport_EsmtpTransport extends Swift_Transport_AbstractSmtpTransport

in package

• Application

implements Swift_Transport_SmtpAgent

Sends Messages over SMTP with ESMTP support.

Tags

author

Chris Corbyn

Interfaces, Classes and Traits

Swift_Transport_SmtpAgent

Wraps an IoBuffer to send/receive SMTP commands/responses.

Table of Contents

$addressEncoder  : mixed

$buffer  : mixed

Input-Output buffer for sending/receiving SMTP commands and responses

$domain  : mixed

The domain name to use in HELO command

$eventDispatcher  : mixed

The event dispatching layer

$pipeline  : mixed

The pipelined commands waiting for response

$pipelining  : mixed

Whether the PIPELINING SMTP extension is enabled (RFC 2920)

$sourceIp  : mixed

Source Ip

$started  : mixed

Connection status

$capabilities  : array<string|int, string>

ESMTP capabilities.

$handlers  : array<string|int, Swift_Transport_EsmtpHandler>

ESMTP extension handlers.

$params  : array<string|int, mixed>

Connection buffer parameters.

__call()  : mixed

Mixin handling method for ESMTP handlers

__construct()  : mixed

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

__destruct()  : mixed

Destructor.

executeCommand()  : string|null

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

getAddressEncoder()  : mixed

getBuffer()  : Swift_Transport_IoBuffer

Get the IoBuffer where read/writes are occurring.

getEncryption()  : string

Get the encryption type.

getExtensionHandlers()  : array<string|int, Swift_Transport_EsmtpHandler>

Get ESMTP extension handlers.

getHost()  : string

Get the host to connect to.

getLocalDomain()  : string

Get the name of the domain Swift will identify as.

getPipelining()  : bool|null

Returns whether SMTP pipelining is enabled.

getPort()  : int

Get the port to connect to.

getSourceIp()  : string

Returns the IP used to connect to the destination.

getStreamOptions()  : array<string|int, mixed>

Returns the stream context options.

getTimeout()  : int

Get the connection timeout.

isStarted()  : bool

Test if an SMTP connection has been established.

ping()  : bool

Check if this Transport mechanism is alive.

registerPlugin()  : mixed

Register a plugin.

reset()  : mixed

Reset the current mail transaction.

send()  : int

Send the given Message.

setAddressEncoder()  : mixed

setEncryption()  : $this

Set the encryption type (tls or ssl).

setExtensionHandlers()  : $this

Set ESMTP extension handlers.

setHost()  : $this

Set the host to connect to.

setLocalDomain()  : $this

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

setPipelining()  : $this

Sets whether SMTP pipelining is enabled.

setPort()  : $this

Set the port to connect to.

setSourceIp()  : $this

Sets the source IP.

setStreamOptions()  : $this

Sets the stream context options.

setTimeout()  : $this

Set the connection timeout.

start()  : mixed

Start the SMTP connection.

stop()  : mixed

Stop the SMTP connection.

assertResponseCode()  : mixed

Throws an Exception if a response code is incorrect

doDataCommand()  : mixed

Send the DATA command

doHeloCommand()  : mixed

Overridden to perform EHLO instead

doMailFromCommand()  : mixed

Overridden to add Extension support

doRcptToCommand()  : mixed

Overridden to add Extension support

getBufferParams()  : mixed

Get the params to initialize the buffer

getFullResponse()  : mixed

Get an entire multi-line response using its sequence number

getReversePath()  : mixed

Determine the best-use reverse path for this message

readGreeting()  : mixed

Read the opening SMTP greeting

streamMessage()  : mixed

Stream the contents of the message over the buffer

throwException()  : mixed

Throw a TransportException, first sending it to any listeners

doMailTransaction()  : mixed

Send an email to the given recipients from the given reverse path

getActiveHandlers()  : mixed

Get ESMTP handlers which are currently ok to use

getCapabilities()  : mixed

Determine ESMTP capabilities by function group

sendBcc()  : mixed

Send a message to all Bcc: recipients

sendTo()  : mixed

Send a message to the given To: recipients

setHandlerParams()  : mixed

Set parameters which are used by each extension handler