Class Swift_Plugins_PopBeforeSmtpPlugin

InheritanceSwift_Plugins_PopBeforeSmtpPlugin
ImplementsSwift_Events_TransportChangeListener, Swift_Plugins_Pop_Pop3Connection

Makes sure a connection to a POP3 host has been established prior to connecting to SMTP.

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__construct() Create a new PopBeforeSmtpPlugin for $host and $port. Swift_Plugins_PopBeforeSmtpPlugin
beforeTransportStarted() Invoked just before a Transport is started. Swift_Plugins_PopBeforeSmtpPlugin
beforeTransportStopped() Not used. Swift_Plugins_PopBeforeSmtpPlugin
bindSmtp() Bind this plugin to a specific SMTP transport instance. Swift_Plugins_PopBeforeSmtpPlugin
connect() Connect to the POP3 host and authenticate. Swift_Plugins_PopBeforeSmtpPlugin
disconnect() Disconnect from the POP3 host. Swift_Plugins_PopBeforeSmtpPlugin
newInstance() Create a new PopBeforeSmtpPlugin for $host and $port. Swift_Plugins_PopBeforeSmtpPlugin
setConnection() Set a Pop3Connection to delegate to instead of connecting directly. Swift_Plugins_PopBeforeSmtpPlugin
setPassword() Set the password to use when connecting (if needed). Swift_Plugins_PopBeforeSmtpPlugin
setTimeout() Set the connection timeout in seconds (default 10). Swift_Plugins_PopBeforeSmtpPlugin
setUsername() Set the username to use when connecting (if needed). Swift_Plugins_PopBeforeSmtpPlugin
transportStarted() Not used. Swift_Plugins_PopBeforeSmtpPlugin
transportStopped() Not used. Swift_Plugins_PopBeforeSmtpPlugin

Method Details

__construct() public method

Create a new PopBeforeSmtpPlugin for $host and $port.

public void __construct ( $host, $port 110, $crypto null )
$host string
$port int
$crypto string

As "tls" or "ssl"

beforeTransportStarted() public method

Invoked just before a Transport is started.

public void beforeTransportStarted ( Swift_Events_TransportChangeEvent $evt )
$evt Swift_Events_TransportChangeEvent
beforeTransportStopped() public method

Not used.

public void beforeTransportStopped ( Swift_Events_TransportChangeEvent $evt )
$evt
bindSmtp() public method

Bind this plugin to a specific SMTP transport instance.

public void bindSmtp ( Swift_Transport $smtp )
$smtp
connect() public method

Connect to the POP3 host and authenticate.

public void connect ( )
throws Swift_Plugins_Pop_Pop3Exception

if connection fails

disconnect() public method

Disconnect from the POP3 host.

public void disconnect ( )
newInstance() public static method

Create a new PopBeforeSmtpPlugin for $host and $port.

public static Swift_Plugins_PopBeforeSmtpPlugin newInstance ( $host, $port 110, $crypto null )
$host string
$port int
$crypto string

As "tls" or "ssl"

setConnection() public method

Set a Pop3Connection to delegate to instead of connecting directly.

public Swift_Plugins_PopBeforeSmtpPlugin setConnection ( Swift_Plugins_Pop_Pop3Connection $connection )
$connection Swift_Plugins_Pop_Pop3Connection
setPassword() public method

Set the password to use when connecting (if needed).

public Swift_Plugins_PopBeforeSmtpPlugin setPassword ( $password )
$password string
setTimeout() public method

Set the connection timeout in seconds (default 10).

public Swift_Plugins_PopBeforeSmtpPlugin setTimeout ( $timeout )
$timeout int
setUsername() public method

Set the username to use when connecting (if needed).

public Swift_Plugins_PopBeforeSmtpPlugin setUsername ( $username )
$username string
transportStarted() public method

Not used.

public void transportStarted ( Swift_Events_TransportChangeEvent $evt )
$evt
transportStopped() public method

Not used.

public void transportStopped ( Swift_Events_TransportChangeEvent $evt )
$evt