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

Class: Swift_Plugins_PopBeforeSmtpPlugin

Source Location: /system/vendor/swiftmailer/swiftmailer/lib/classes/Swift/Plugins/PopBeforeSmtpPlugin.php

Class Overview


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


Author(s):

  • Chris Corbyn

Implements interfaces:

Methods



Class Details

[line 16]
Makes sure a connection to a POP3 host has been established prior to connecting to SMTP.



Tags:

author:  Chris Corbyn


[ Top ]


Class Methods


static method newInstance [line 68]

static Swift_Plugins_PopBeforeSmtpPlugin newInstance( string $host, [int $port = 110], [string $crypto = null])

Create a new PopBeforeSmtpPlugin for $host and $port.



Tags:

access:  public


Parameters:

string   $host  
int   $port  
string   $crypto   as "tls" or "ssl"

[ Top ]

constructor __construct [line 52]

Swift_Plugins_PopBeforeSmtpPlugin __construct( string $host, [int $port = 110], [string $crypto = null])

Create a new PopBeforeSmtpPlugin for $host and $port.



Tags:

access:  public


Parameters:

string   $host  
int   $port  
string   $crypto   as "tls" or "ssl"

[ Top ]

method beforeTransportStarted [line 197]

void beforeTransportStarted( Swift_Events_TransportChangeEvent $evt)

Invoked just before a Transport is started.



Tags:

access:  public



Implementation of:
Swift_Events_TransportChangeListener::beforeTransportStarted()
Invoked just before a Transport is started.

Parameters:


[ Top ]

method beforeTransportStopped [line 219]

void beforeTransportStopped( Swift_Events_TransportChangeEvent $evt)

Not used.



Tags:

access:  public



Implementation of:
Swift_Events_TransportChangeListener::beforeTransportStopped()
Invoked just before a Transport is stopped.

Parameters:


[ Top ]

method bindSmtp [line 92]

void bindSmtp( Swift_Transport $smtp)

Bind this plugin to a specific SMTP transport instance.



Tags:

access:  public


Parameters:

Swift_Transport   $smtp  

[ Top ]

method connect [line 144]

void connect( )

Connect to the POP3 host and authenticate.



Tags:

throws:  Swift_Plugins_Pop_Pop3Exception if connection fails
access:  public



Implementation of:
Swift_Plugins_Pop_Pop3Connection::connect()
Connect to the POP3 host and throw an Exception if it fails.
[ Top ]

method disconnect [line 177]

void disconnect( )

Disconnect from the POP3 host.



Tags:

access:  public



Implementation of:
Swift_Plugins_Pop_Pop3Connection::disconnect()
Disconnect from the POP3 host and throw an Exception if it fails.
[ Top ]

method setConnection [line 80]

Swift_Plugins_PopBeforeSmtpPlugin setConnection( Swift_Plugins_Pop_Pop3Connection $connection)

Set a Pop3Connection to delegate to instead of connecting directly.



Tags:

access:  public


Parameters:

Swift_Plugins_Pop_Pop3Connection   $connection  

[ Top ]

method setPassword [line 132]

Swift_Plugins_PopBeforeSmtpPlugin setPassword( string $password)

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



Tags:

access:  public


Parameters:

string   $password  

[ Top ]

method setTimeout [line 104]

Swift_Plugins_PopBeforeSmtpPlugin setTimeout( int $timeout)

Set the connection timeout in seconds (default 10).



Tags:

access:  public


Parameters:

int   $timeout  

[ Top ]

method setUsername [line 118]

Swift_Plugins_PopBeforeSmtpPlugin setUsername( string $username)

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



Tags:

access:  public


Parameters:

string   $username  

[ Top ]

method transportStarted [line 212]

void transportStarted( Swift_Events_TransportChangeEvent $evt)

Not used.



Tags:

access:  public



Implementation of:
Swift_Events_TransportChangeListener::transportStarted()
Invoked immediately after the Transport is started.

Parameters:


[ Top ]

method transportStopped [line 226]

void transportStopped( Swift_Events_TransportChangeEvent $evt)

Not used.



Tags:

access:  public



Implementation of:
Swift_Events_TransportChangeListener::transportStopped()
Invoked immediately after the Transport is stopped.

Parameters:


[ Top ]


Documentation generated on Sun, 02 Oct 2016 07:53:33 +0000 by phpDocumentor 1.4.3