Swift_Plugins_PopBeforeSmtpPlugin Class Reference

Inheritance diagram for Swift_Plugins_PopBeforeSmtpPlugin:

Public Member Functions
	__construct ($host, $port=110, $crypto=null)
	beforeTransportStarted (Swift_Events_TransportChangeEvent $evt)
	beforeTransportStopped (Swift_Events_TransportChangeEvent $evt)
	bindSmtp (Swift_Transport $smtp)
	connect ()
	disconnect ()
	setConnection (Swift_Plugins_Pop_Pop3Connection $connection)
	setPassword ($password)
	setTimeout ($timeout)
	setUsername ($username)
	transportStarted (Swift_Events_TransportChangeEvent $evt)
	transportStopped (Swift_Events_TransportChangeEvent $evt)

Static Public Member Functions
static	newInstance ($host, $port=110, $crypto=null)

Private Member Functions
	_assertOk ($response)
	_command ($command)
	_getHostString ()

Private Attributes
	$_connection
	$_crypto
	$_host
	$_password
	$_port
	$_socket
	$_timeout = 10
	$_transport
	$_username

Detailed Description

Definition at line 22 of file PopBeforeSmtpPlugin.php.

Constructor & Destructor Documentation

Swift_Plugins_PopBeforeSmtpPlugin::__construct	(		$host,
			$port = 110,
			$crypto = null
	)

Create a new PopBeforeSmtpPlugin for $host and $port.

Parameters

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

Definition at line 60 of file PopBeforeSmtpPlugin.php.

Member Function Documentation

Swift_Plugins_PopBeforeSmtpPlugin::_assertOk (   $response )

private

Definition at line 262 of file PopBeforeSmtpPlugin.php.

Referenced by _command(), and connect().

Here is the caller graph for this function:

Swift_Plugins_PopBeforeSmtpPlugin::_command (   $command )

private

Definition at line 241 of file PopBeforeSmtpPlugin.php.

References _assertOk().

Referenced by connect(), and disconnect().

Here is the call graph for this function:

Here is the caller graph for this function:

Swift_Plugins_PopBeforeSmtpPlugin::_getHostString ( )

private

Definition at line 272 of file PopBeforeSmtpPlugin.php.

References $_host.

Referenced by connect().

Here is the caller graph for this function:

Swift_Plugins_PopBeforeSmtpPlugin::beforeTransportStarted

(

Swift_Events_TransportChangeEvent

$evt

)

Invoked just before a Transport is started.

Parameters

Swift_Events_TransportChangeEvent

$evt

Implements Swift_Events_TransportChangeListener.

Definition at line 204 of file PopBeforeSmtpPlugin.php.

References connect(), disconnect(), and Swift_Events_TransportChangeEvent\getTransport().

Here is the call graph for this function:

Swift_Plugins_PopBeforeSmtpPlugin::beforeTransportStopped

(

Swift_Events_TransportChangeEvent

$evt

)

Not used.

Implements Swift_Events_TransportChangeListener.

Definition at line 228 of file PopBeforeSmtpPlugin.php.

Swift_Plugins_PopBeforeSmtpPlugin::bindSmtp

(

Swift_Transport

$smtp

)

Bind this plugin to a specific SMTP transport instance.

Parameters

Swift_Transport

Definition at line 97 of file PopBeforeSmtpPlugin.php.

Swift_Plugins_PopBeforeSmtpPlugin::connect

(

)

Connect to the POP3 host and authenticate.

Exceptions

Swift_Plugins_Pop_Pop3Exception

if connection fails

Implements Swift_Plugins_Pop_Pop3Connection.

Definition at line 140 of file PopBeforeSmtpPlugin.php.

References _assertOk(), _command(), and _getHostString().

Referenced by beforeTransportStarted().

Here is the call graph for this function:

Here is the caller graph for this function:

Swift_Plugins_PopBeforeSmtpPlugin::disconnect

(

)

Disconnect from the POP3 host.

Implements Swift_Plugins_Pop_Pop3Connection.

Definition at line 180 of file PopBeforeSmtpPlugin.php.

References _command().

Referenced by beforeTransportStarted().

Here is the call graph for this function:

Here is the caller graph for this function:

static Swift_Plugins_PopBeforeSmtpPlugin::newInstance (   $host,   $port = 110,   $crypto = null  )

static

Create a new PopBeforeSmtpPlugin for $host and $port.

Parameters

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

Returns

Swift_Plugins_PopBeforeSmtpPlugin

Definition at line 76 of file PopBeforeSmtpPlugin.php.

Swift_Plugins_PopBeforeSmtpPlugin::setConnection

(

Swift_Plugins_Pop_Pop3Connection

$connection

)

Set a Pop3Connection to delegate to instead of connecting directly.

Parameters

Swift_Plugins_Pop_Pop3Connection

$connection

Definition at line 86 of file PopBeforeSmtpPlugin.php.

Swift_Plugins_PopBeforeSmtpPlugin::setPassword

(

$password

)

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

Parameters

string

$password

Definition at line 129 of file PopBeforeSmtpPlugin.php.

Swift_Plugins_PopBeforeSmtpPlugin::setTimeout

(

$timeout

)

Set the connection timeout in seconds (default 10).

Parameters

int

$timeout

Definition at line 107 of file PopBeforeSmtpPlugin.php.

Swift_Plugins_PopBeforeSmtpPlugin::setUsername

(

$username

)

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

Parameters

string

$username

Definition at line 118 of file PopBeforeSmtpPlugin.php.

Swift_Plugins_PopBeforeSmtpPlugin::transportStarted

(

Swift_Events_TransportChangeEvent

$evt

)

Not used.

Implements Swift_Events_TransportChangeListener.

Definition at line 221 of file PopBeforeSmtpPlugin.php.

Swift_Plugins_PopBeforeSmtpPlugin::transportStopped

(

Swift_Events_TransportChangeEvent

$evt

)

Not used.

Implements Swift_Events_TransportChangeListener.

Definition at line 235 of file PopBeforeSmtpPlugin.php.

Member Data Documentation

Swift_Plugins_PopBeforeSmtpPlugin::$_connection

private

A delegate connection to use (mostly a test hook)

Definition at line 27 of file PopBeforeSmtpPlugin.php.

Swift_Plugins_PopBeforeSmtpPlugin::$_crypto

private

Encryption type to use (if any)

Definition at line 36 of file PopBeforeSmtpPlugin.php.

Swift_Plugins_PopBeforeSmtpPlugin::$_host

private

Hostname of the POP3 server

Definition at line 30 of file PopBeforeSmtpPlugin.php.

Referenced by _getHostString().

Swift_Plugins_PopBeforeSmtpPlugin::$_password

private

Password to use (if any)

Definition at line 42 of file PopBeforeSmtpPlugin.php.

Swift_Plugins_PopBeforeSmtpPlugin::$_port

private

Port number to connect on

Definition at line 33 of file PopBeforeSmtpPlugin.php.

Swift_Plugins_PopBeforeSmtpPlugin::$_socket

private

Established connection via TCP socket

Definition at line 45 of file PopBeforeSmtpPlugin.php.

Swift_Plugins_PopBeforeSmtpPlugin::$_timeout = 10

private

Connect timeout in seconds

Definition at line 48 of file PopBeforeSmtpPlugin.php.

Swift_Plugins_PopBeforeSmtpPlugin::$_transport

private

SMTP Transport to bind to

Definition at line 51 of file PopBeforeSmtpPlugin.php.

Swift_Plugins_PopBeforeSmtpPlugin::$_username

private

Username to use (if any)

Definition at line 39 of file PopBeforeSmtpPlugin.php.

---

The documentation for this class was generated from the following file:

• L:/XOOPS_Allure/SVN_XOOPS2/RMC/rmcommon/trunk/rmcommon/class/swift/classes/Swift/Plugins/PopBeforeSmtpPlugin.php