Inheritance diagram for Swift_Transport_Esmtp_AuthHandler:

Public Member Functions
	__construct (array $authenticators)

	afterEhlo (Swift_Transport_SmtpAgent $agent)

	exposeMixinMethods ()

	getAuthenticators ()

	getAuthMode ()

	getHandledKeyword ()

	getMailParams ()

	getPassword ()

	getPriorityOver ($esmtpKeyword)

	getRcptParams ()

	getUsername ()

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

	resetState ()

	setAuthenticators (array $authenticators)

	setAuthMode ($mode)

	setKeywordParams (array $parameters)

	setPassword ($password)

	setUsername ($username)

Protected Member Functions
	_getAuthenticatorsForAgent ()

Private Attributes
	$_auth_mode

	$_authenticators = array()

	$_esmtpParams = array()

	$_password

	$_username

Detailed Description

Definition at line 21 of file AuthHandler.php.

Constructor & Destructor Documentation

Swift_Transport_Esmtp_AuthHandler::__construct ( array $authenticators )

Create a new AuthHandler with $authenticators for support.

Parameters

Swift_Transport_Esmtp_Authenticator[] $authenticators

Definition at line 63 of file AuthHandler.php.

References setAuthenticators().

Here is the call graph for this function:

Member Function Documentation

Swift_Transport_Esmtp_AuthHandler::_getAuthenticatorsForAgent ( )

protected

Returns the authenticator list for the given agent.

Parameters

Swift_Transport_SmtpAgent $agent

Returns: array protected

Definition at line 245 of file AuthHandler.php.

References $_authenticators.

Referenced by afterEhlo().

Here is the caller graph for this function:

Swift_Transport_Esmtp_AuthHandler::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 162 of file AuthHandler.php.

References _getAuthenticatorsForAgent().

Here is the call graph for this function:

Swift_Transport_Esmtp_AuthHandler::exposeMixinMethods ( )

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

Returns: string[]

Implements Swift_Transport_EsmtpHandler.

Definition at line 225 of file AuthHandler.php.

Swift_Transport_Esmtp_AuthHandler::getAuthenticators ( )

Get the Authenticators which can process a login request.

Returns: Swift_Transport_Esmtp_Authenticator[]

Definition at line 81 of file AuthHandler.php.

References $_authenticators.

Swift_Transport_Esmtp_AuthHandler::getAuthMode ( )

Get the auth mode to use to authenticate.

Returns: string

Definition at line 135 of file AuthHandler.php.

References $_auth_mode.

Swift_Transport_Esmtp_AuthHandler::getHandledKeyword ( )

Get the name of the ESMTP extension this handles.

Returns: boolean

Implements Swift_Transport_EsmtpHandler.

Definition at line 144 of file AuthHandler.php.

Swift_Transport_Esmtp_AuthHandler::getMailParams ( )

Not used.

Implements Swift_Transport_EsmtpHandler.

Definition at line 189 of file AuthHandler.php.

Swift_Transport_Esmtp_AuthHandler::getPassword ( )

Get the password to authenticate with.

Returns: string

Definition at line 117 of file AuthHandler.php.

References $_password.

Swift_Transport_Esmtp_AuthHandler::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 216 of file AuthHandler.php.

Swift_Transport_Esmtp_AuthHandler::getRcptParams ( )

Not used.

Implements Swift_Transport_EsmtpHandler.

Definition at line 197 of file AuthHandler.php.

Swift_Transport_Esmtp_AuthHandler::getUsername ( )

Get the username to authenticate with.

Returns: string

Definition at line 99 of file AuthHandler.php.

References $_username.

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

Not used.

Implements Swift_Transport_EsmtpHandler.

Definition at line 205 of file AuthHandler.php.

Swift_Transport_Esmtp_AuthHandler::resetState ( )

Not used.

Implements Swift_Transport_EsmtpHandler.

Definition at line 233 of file AuthHandler.php.

Swift_Transport_Esmtp_AuthHandler::setAuthenticators ( array $authenticators )

Set the Authenticators which can process a login request.

Parameters

Swift_Transport_Esmtp_Authenticator[] $authenticators

Definition at line 72 of file AuthHandler.php.

Referenced by __construct().

Here is the caller graph for this function:

Swift_Transport_Esmtp_AuthHandler::setAuthMode ( $mode )

Set the auth mode to use to authenticate.

Parameters

string $mode

Definition at line 126 of file AuthHandler.php.

Swift_Transport_Esmtp_AuthHandler::setKeywordParams ( array $parameters )

Set the parameters which the EHLO greeting indicated.

Parameters

string[] $parameters

Implements Swift_Transport_EsmtpHandler.

Definition at line 153 of file AuthHandler.php.

Swift_Transport_Esmtp_AuthHandler::setPassword ( $password )

Set the password to authenticate with.

Parameters

string $password

Definition at line 108 of file AuthHandler.php.

Swift_Transport_Esmtp_AuthHandler::setUsername ( $username )

Set the username to authenticate with.

Parameters

string $username

Definition at line 90 of file AuthHandler.php.

Member Data Documentation

Swift_Transport_Esmtp_AuthHandler::$_auth_mode

private

Definition at line 50 of file AuthHandler.php.

Referenced by getAuthMode().

Swift_Transport_Esmtp_AuthHandler::$_authenticators = array()

private

Definition at line 29 of file AuthHandler.php.

Referenced by _getAuthenticatorsForAgent(), and getAuthenticators().

Swift_Transport_Esmtp_AuthHandler::$_esmtpParams = array()

private

Definition at line 57 of file AuthHandler.php.

Swift_Transport_Esmtp_AuthHandler::$_password

private

Definition at line 43 of file AuthHandler.php.

Referenced by getPassword().

Swift_Transport_Esmtp_AuthHandler::$_username

private

Definition at line 36 of file AuthHandler.php.

Referenced by getUsername().

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

L:/XOOPS_Allure/SVN_XOOPS2/RMC/rmcommon/trunk/rmcommon/class/swift/classes/Swift/Transport/Esmtp/AuthHandler.php

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation