Docs For Class Swift_Plugins_PopBeforeSmtpPlugin

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

Create a new PopBeforeSmtpPlugin for $host and $port.

Tags:

access:

public

Parameters:

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

[ Top ]

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

Create a new PopBeforeSmtpPlugin for $host and $port.

Tags:

access:

public

Parameters:

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

[ Top ]

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:

Swift_Events_TransportChangeEvent

$evt

[ Top ]

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:

Swift_Events_TransportChangeEvent

$evt

[ Top ]

void bindSmtp(
Swift_Transport
$smtp)

Bind this plugin to a specific SMTP transport instance.

Tags:

access:

public

Parameters:

Swift_Transport

$smtp

[ Top ]

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 ]

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 ]

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

void setPassword(
string
$password)

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

Tags:

access:

public

Parameters:

string

$password

[ Top ]

void setTimeout(
int
$timeout)

Set the connection timeout in seconds (default 10).

Tags:

access:

public

Parameters:

int

$timeout

[ Top ]

void setUsername(
string
$username)

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

Tags:

access:

public

Parameters:

string

$username

[ Top ]

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:

Swift_Events_TransportChangeEvent

$evt

[ Top ]

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:

Swift_Events_TransportChangeEvent

$evt

[ Top ]

Class: Swift_Plugins_PopBeforeSmtpPlugin

Class Overview

Author(s):

Methods

Class Details

Tags:

Class Methods

static method newInstance [line 76]

Tags:

Parameters:

constructor __construct [line 60]

Tags:

Parameters:

method beforeTransportStarted [line 204]

Tags:

Parameters:

method beforeTransportStopped [line 228]

Tags:

Parameters:

method bindSmtp [line 97]

Tags:

Parameters:

method connect [line 140]

Tags:

method disconnect [line 180]

Tags:

method setConnection [line 86]

Tags:

Parameters:

method setPassword [line 129]

Tags:

Parameters:

method setTimeout [line 107]

Tags:

Parameters:

method setUsername [line 118]

Tags:

Parameters:

method transportStarted [line 221]

Tags:

Parameters:

method transportStopped [line 235]

Tags:

Parameters: