Swift_Transport_Esmtp_AuthHandler Class Reference

Inheritance diagram for Swift_Transport_Esmtp_AuthHandler:

Public Member Functions
	__construct (array $authenticators)
	setAuthenticators (array $authenticators)
	getAuthenticators ()
	setUsername ($username)
	getUsername ()
	setPassword ($password)
	getPassword ()
	setAuthMode ($mode)
	getAuthMode ()
	getHandledKeyword ()
	setKeywordParams (array $parameters)
	afterEhlo (Swift_Transport_SmtpAgent $agent)
	getMailParams ()
	getRcptParams ()
	onCommand (Swift_Transport_SmtpAgent $agent, $command, $codes=array(), &$failedRecipients=null, &$stop=false)
	getPriorityOver ($esmtpKeyword)
	exposeMixinMethods ()
	resetState ()

Protected Member Functions
	_getAuthenticatorsForAgent ()

Private Attributes
	$_authenticators = array()
	$_username
	$_password
	$_auth_mode
	$_esmtpParams = array()

Detailed Description

An ESMTP handler for AUTH support.

Author

Chris Corbyn

Definition at line 16 of file AuthHandler.php.

Constructor & Destructor Documentation

__construct

(

array

$authenticators

)

Create a new AuthHandler with $authenticators for support.

Parameters

Swift_Transport_Esmtp_Authenticator[]

$authenticators

Definition at line 58 of file AuthHandler.php.

References setAuthenticators().

Member Function Documentation

_getAuthenticatorsForAgent ( )

protected

Returns the authenticator list for the given agent.

Parameters

Swift_Transport_SmtpAgent

$agent

Returns

array

Definition at line 249 of file AuthHandler.php.

References $_authenticators.

Referenced by afterEhlo().

afterEhlo

(

Swift_Transport_SmtpAgent

$agent

)

Runs immediately after a EHLO has been issued.

Parameters

Swift_Transport_SmtpAgent

$agent

to read/write

Implements Swift_Transport_EsmtpHandler.

Definition at line 168 of file AuthHandler.php.

References _getAuthenticatorsForAgent().

exposeMixinMethods

(

)

Returns an array of method names which are exposed to the Esmtp class.

Returns

string[]

Implements Swift_Transport_EsmtpHandler.

Definition at line 230 of file AuthHandler.php.

getAuthenticators

(

)

Get the Authenticators which can process a login request.

Returns

Swift_Transport_Esmtp_Authenticator[]

Definition at line 78 of file AuthHandler.php.

References $_authenticators.

getAuthMode

(

)

Get the auth mode to use to authenticate.

Returns

string

Definition at line 138 of file AuthHandler.php.

References $_auth_mode.

getHandledKeyword

(

)

Get the name of the ESMTP extension this handles.

Returns

bool

Implements Swift_Transport_EsmtpHandler.

Definition at line 148 of file AuthHandler.php.

getMailParams

(

)

Not used.

Implements Swift_Transport_EsmtpHandler.

Definition at line 191 of file AuthHandler.php.

getPassword

(

)

Get the password to authenticate with.

Returns

string

Definition at line 118 of file AuthHandler.php.

References $_password.

getPriorityOver

(

$esmtpKeyword

)

Returns +1, -1 or 0 according to the rules for usort().

This method is called to ensure extensions can be execute in an appropriate order.

Parameters

string

$esmtpKeyword

to compare with

Returns

int

Implements Swift_Transport_EsmtpHandler.

Definition at line 220 of file AuthHandler.php.

getRcptParams

(

)

Not used.

Implements Swift_Transport_EsmtpHandler.

Definition at line 199 of file AuthHandler.php.

getUsername

(

)

Get the username to authenticate with.

Returns

string

Definition at line 98 of file AuthHandler.php.

References $_username.

onCommand	(	Swift_Transport_SmtpAgent	$agent,
			$command,
			$codes = array(),
		&	$failedRecipients = null,
		&	$stop = false
	)

Not used.

Implements Swift_Transport_EsmtpHandler.

Definition at line 207 of file AuthHandler.php.

resetState

(

)

Not used.

Implements Swift_Transport_EsmtpHandler.

Definition at line 238 of file AuthHandler.php.

setAuthenticators

(

array

$authenticators

)

Set the Authenticators which can process a login request.

Parameters

Swift_Transport_Esmtp_Authenticator[]

$authenticators

Definition at line 68 of file AuthHandler.php.

Referenced by __construct().

setAuthMode

(

$mode

)

Set the auth mode to use to authenticate.

Parameters

string

$mode

Definition at line 128 of file AuthHandler.php.

setKeywordParams

(

array

$parameters

)

Set the parameters which the EHLO greeting indicated.

Parameters

string[]

$parameters

Implements Swift_Transport_EsmtpHandler.

Definition at line 158 of file AuthHandler.php.

setPassword

(

$password

)

Set the password to authenticate with.

Parameters

string

$password

Definition at line 108 of file AuthHandler.php.

setUsername

(

$username

)

Set the username to authenticate with.

Parameters

string

$username

Definition at line 88 of file AuthHandler.php.

Member Data Documentation

$_auth_mode

private

Definition at line 44 of file AuthHandler.php.

Referenced by getAuthMode().

$_authenticators = array()

private

Definition at line 23 of file AuthHandler.php.

Referenced by _getAuthenticatorsForAgent(), and getAuthenticators().

$_esmtpParams = array()

private

Definition at line 51 of file AuthHandler.php.

$_password

private

Definition at line 37 of file AuthHandler.php.

Referenced by getPassword().

$_username

private

Definition at line 30 of file AuthHandler.php.

Referenced by getUsername().