Overview

Packages

  • CONTENIDO
  • Core
    • Authentication
    • Backend
    • Cache
    • CEC
    • Chain
    • ContentType
    • Database
    • Debug
    • Exception
    • Frontend
      • Search
      • URI
      • Util
    • GenericDB
      • Model
    • GUI
      • HTML
    • I18N
    • LayoutHandler
    • Log
    • Security
    • Session
    • Util
    • Validation
    • Versioning
    • XML
  • Module
    • ContentRssCreator
    • ContentSitemapHtml
    • ContentSitemapXml
    • ContentUserForum
    • NavigationTop
    • ScriptCookieDirective
  • mpAutoloaderClassMap
  • None
  • Plugin
    • ContentAllocation
    • CronjobOverview
    • FormAssistant
    • FrontendLogic
    • FrontendUsers
    • Linkchecker
    • ModRewrite
    • Newsletter
    • Repository
      • FrontendNavigation
      • KeywordDensity
    • SearchSolr
    • SmartyWrapper
    • UrlShortener
    • UserForum
    • Workflow
  • PluginManager
  • Setup
    • Form
    • GUI
    • Helper
      • Environment
      • Filesystem
      • MySQL
      • PHP
    • UpgradeJob
  • Smarty
    • Cacher
    • Compiler
    • Config
    • Debug
    • PluginsBlock
    • PluginsFilter
    • PluginsFunction
    • PluginsInternal
    • PluginsModifier
    • PluginsModifierCompiler
    • PluginsShared
    • Security
    • Template
    • TemplateResources
  • Swift
    • ByteStream
    • CharacterStream
    • Encoder
    • Events
    • KeyCache
    • Mailer
    • Mime
    • Plugins
    • Transport

Classes

  • Swift_FailoverTransport
  • Swift_LoadBalancedTransport
  • Swift_MailTransport
  • Swift_Plugins_Loggers_ArrayLogger
  • Swift_Plugins_Loggers_EchoLogger
  • Swift_SendmailTransport
  • Swift_SmtpTransport
  • Swift_Transport_AbstractSmtpTransport
  • Swift_Transport_Esmtp_Auth_CramMd5Authenticator
  • Swift_Transport_Esmtp_Auth_LoginAuthenticator
  • Swift_Transport_Esmtp_Auth_PlainAuthenticator
  • Swift_Transport_Esmtp_AuthHandler
  • Swift_Transport_EsmtpTransport
  • Swift_Transport_FailoverTransport
  • Swift_Transport_LoadBalancedTransport
  • Swift_Transport_MailTransport
  • Swift_Transport_SendmailTransport
  • Swift_Transport_SimpleMailInvoker
  • Swift_Transport_StreamBuffer

Interfaces

  • Swift_Plugins_Logger
  • Swift_Plugins_Pop_Pop3Exception
  • Swift_Transport
  • Swift_Transport_Esmtp_Authenticator
  • Swift_Transport_EsmtpHandler
  • Swift_Transport_IoBuffer
  • Swift_Transport_MailInvoker
  • Swift_Transport_SmtpAgent
  • Swift_TransportException
  • Overview
  • Package
  • Class
  • Todo
  • Download

Class Swift_Transport_AbstractSmtpTransport

Sends Messages over SMTP.

Swift_Transport_AbstractSmtpTransport implements Swift_Transport

Direct known subclasses

Swift_Transport_EsmtpTransport, Swift_Transport_SendmailTransport

Indirect known subclasses

Swift_SendmailTransport, Swift_SmtpTransport
Abstract
Package: Swift\Transport
Author: Chris Corbyn
Located at classes/swiftmailer/lib/classes/Swift/Transport/AbstractSmtpTransport.php
Methods summary
abstract protected
# _getBufferParams( )

Return an array of params for the Buffer

Return an array of params for the Buffer

public
# __construct( Swift_Transport_IoBuffer $buf, Swift_Events_EventDispatcher $dispatcher )

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

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

Parameters

$buf
$dispatcher
public Swift_Transport_AbstractSmtpTransport
# 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]).

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]).

Parameters

$domain

Returns

Swift_Transport_AbstractSmtpTransport
public string
# getLocalDomain( )

Get the name of the domain Swift will identify as.

Get the name of the domain Swift will identify as.

Returns

string
public
# setSourceIp( string $source )

Sets the sourceIp

Sets the sourceIp

Parameters

$source
public string
# getSourceIp( )

Returns the ip used to connect to the destination

Returns the ip used to connect to the destination

Returns

string
public
# start( )

Start the SMTP connection.

Start the SMTP connection.

Implementation of

Swift_Transport::start()
public boolean
# isStarted( )

Test if an SMTP connection has been established.

Test if an SMTP connection has been established.

Returns

boolean

Implementation of

Swift_Transport::isStarted()
public integer
# send( Swift_Mime_Message $message, string[] & $failedRecipients = null )

Send the given Message.

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.

Parameters

$message
$failedRecipients
$failedRecipients to collect failures by-reference

Returns

integer

Implementation of

Swift_Transport::send()
public
# stop( )

Stop the SMTP connection.

Stop the SMTP connection.

Implementation of

Swift_Transport::stop()
public
# registerPlugin( Swift_Events_EventListener $plugin )

Register a plugin.

Register a plugin.

Parameters

$plugin

Implementation of

Swift_Transport::registerPlugin()
public
# reset( )

Reset the current mail transaction.

Reset the current mail transaction.

public Swift_Transport_IoBuffer
# getBuffer( )

Get the IoBuffer where read/writes are occurring.

Get the IoBuffer where read/writes are occurring.

Returns

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

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

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

$command
$codes
$failures
$failures

Returns

string
protected
# _readGreeting( )

Read the opening SMTP greeting

Read the opening SMTP greeting

protected
# _doHeloCommand( )

Send the HELO welcome

Send the HELO welcome

protected
# _doMailFromCommand( $address )

Send the MAIL FROM command

Send the MAIL FROM command

protected
# _doRcptToCommand( $address )

Send the RCPT TO command

Send the RCPT TO command

protected
# _doDataCommand( )

Send the DATA command

Send the DATA command

protected
# _streamMessage( Swift_Mime_Message $message )

Stream the contents of the message over the buffer

Stream the contents of the message over the buffer

protected
# _getReversePath( Swift_Mime_Message $message )

Determine the best-use reverse path for this message

Determine the best-use reverse path for this message

protected
# _throwException( Swift_TransportException $e )

Throw a TransportException, first sending it to any listeners

Throw a TransportException, first sending it to any listeners

protected
# _assertResponseCode( $response, $wanted )

Throws an Exception if a response code is incorrect

Throws an Exception if a response code is incorrect

protected
# _getFullResponse( $seq )

Get an entire multi-line response using its sequence number

Get an entire multi-line response using its sequence number

private
# _doMailTransaction( $message, $reversePath, array $recipients, array & $failedRecipients )

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

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

private
# _sendTo( Swift_Mime_Message $message, $reversePath, array $to, array & $failedRecipients )

Send a message to the given To: recipients

Send a message to the given To: recipients

private
# _sendCc( Swift_Mime_Message $message, $reversePath, array $cc, array & $failedRecipients )

Send a message to the given Cc: recipients

Send a message to the given Cc: recipients

private
# _sendBcc( Swift_Mime_Message $message, $reversePath, array $bcc, array & $failedRecipients )

Send a message to all Bcc: recipients

Send a message to all Bcc: recipients

private
# _lookupHostname( )

Try to determine the hostname of the server this is run on

Try to determine the hostname of the server this is run on

private
# _isFqdn( $hostname )

Determine is the $hostname is a fully-qualified name

Determine is the $hostname is a fully-qualified name

public
# __destruct( )

Destructor.

Destructor.

Properties summary
protected $_buffer

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

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

#
protected boolean $_started

Connection status

Connection status

# false
protected string $_domain

The domain name to use in HELO command

The domain name to use in HELO command

# '[127.0.0.1]'
protected $_eventDispatcher

The event dispatching layer

The event dispatching layer

#
protected $_sourceIp

Source Ip

Source Ip

#
CMS CONTENIDO 4.9.7 API documentation generated by ApiGen