Geeklog
[ class tree: Geeklog ] [ index: Geeklog ] [ all elements ]

Class: Swift_Transport_EsmtpTransport

Source Location: /system/vendor/swiftmailer/swiftmailer/lib/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:

Methods


Child classes:

Swift_SmtpTransport
Sends Messages over SMTP with ESMTP support.

Inherited Variables

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::getSourceIp()
Returns the IP used to connect to the destination.
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::setSourceIp()
Sets the source IP.
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 16]
Sends Messages over SMTP with ESMTP support.



Tags:

author:  Chris Corbyn


[ Top ]


Class Methods


constructor __construct [line 55]

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

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



Tags:

access:  public


Overridden in child classes as:

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

Overrides Swift_Transport_AbstractSmtpTransport::__construct() (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 256]

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

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



Implementation of:
Swift_Transport_SmtpAgent::executeCommand()
Run a command against the buffer, expecting the given response codes.
Overrides Swift_Transport_AbstractSmtpTransport::executeCommand() (Run a command against the buffer, expecting the given response codes.)

Parameters:

string   $command  
int[]   $codes  
string[]   $failures   An array of failures by-reference
   &$failures  

[ Top ]

method getEncryption [line 160]

string getEncryption( )

Get the encryption type.



Tags:

access:  public


[ Top ]

method getExtensionHandlers [line 239]

Swift_Transport_EsmtpHandler[] getExtensionHandlers( )

Get ESMTP extension handlers.



Tags:

access:  public


[ Top ]

method getHost [line 80]

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 getSourceIp [line 208]

string getSourceIp( )

Returns the IP used to connect to the destination.



Tags:

access:  public


Overrides Swift_Transport_AbstractSmtpTransport::getSourceIp() (Returns the IP used to connect to the destination.)

[ Top ]

method getStreamOptions [line 184]

array getStreamOptions( )

Returns the stream context options.



Tags:

access:  public


[ Top ]

method getTimeout [line 129]

int getTimeout( )

Get the connection timeout.



Tags:

access:  public


[ Top ]

method setEncryption [line 141]

Swift_Transport_EsmtpTransport setEncryption( string $encryption)

Set the encryption type (tls or ssl).



Tags:

access:  public


Parameters:

string   $encryption  

[ Top ]

method setExtensionHandlers [line 220]

Swift_Transport_EsmtpTransport setExtensionHandlers( $handlers)

Set ESMTP extension handlers.



Tags:

access:  public


Parameters:

Swift_Transport_EsmtpHandler[]   $handlers  

[ Top ]

method setHost [line 68]

Swift_Transport_EsmtpTransport setHost( string $host)

Set the host to connect to.



Tags:

access:  public


Parameters:

string   $host  

[ Top ]

method setPort [line 92]

Swift_Transport_EsmtpTransport setPort( int $port)

Set the port to connect to.



Tags:

access:  public


Parameters:

int   $port  

[ Top ]

method setSourceIp [line 196]

Swift_Transport_EsmtpTransport setSourceIp( string $source)

Sets the source IP.



Tags:

access:  public


Overrides Swift_Transport_AbstractSmtpTransport::setSourceIp() (Sets the source IP.)

Parameters:

string   $source  

[ Top ]

method setStreamOptions [line 172]

Swift_Transport_EsmtpTransport setStreamOptions( array $options)

Sets the stream context options.



Tags:

access:  public


Parameters:

array   $options  

[ Top ]

method setTimeout [line 116]

Swift_Transport_EsmtpTransport setTimeout( int $timeout)

Set the connection timeout.



Tags:

access:  public


Parameters:

int   $timeout   seconds

[ Top ]

method _doHeloCommand [line 301]

void _doHeloCommand( )

Overridden to perform EHLO instead



Tags:

access:  protected


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

[ Top ]

method _doMailFromCommand [line 339]

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 353]

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 295]

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 276]

void __call( $method, $args)

Mixin handling method for ESMTP handlers



Tags:

access:  public


Parameters:

   $method  
   $args  

[ Top ]


Documentation generated on Sun, 02 Oct 2016 07:48:25 +0000 by phpDocumentor 1.4.3