PHP Class Swift_Transport_Esmtp_AuthHandler, Halite

Author: Chris Corbyn

Inheritance: implements Swift_Transport_EsmtpHandler

Show file Open project: HaliteChallenge/Halite Class Usage Examples

Public Methods

Method	Description
__construct ( array $authenticators )	Create a new AuthHandler with $authenticators for support.
afterEhlo ( Swift_Transport_SmtpAgent $agent )	Runs immediately after a EHLO has been issued.
exposeMixinMethods ( ) : string[]	Returns an array of method names which are exposed to the Esmtp class.
getAuthMode ( ) : string	Get the auth mode to use to authenticate.
getAuthenticators ( ) : Swift_Transport_Esmtp_Authenticator[]	Get the Authenticators which can process a login request.
getHandledKeyword ( ) : boolean	Get the name of the ESMTP extension this handles.
getMailParams ( )	Not used.
getPassword ( ) : string	Get the password to authenticate with.
getPriorityOver ( string $esmtpKeyword ) : integer	Returns +1, -1 or 0 according to the rules for usort().
getRcptParams ( )	Not used.
getUsername ( ) : string	Get the username to authenticate with.
onCommand ( Swift_Transport_SmtpAgent $agent, $command, $codes = [], &$failedRecipients = null, &$stop = false )	Not used.
resetState ( )	Not used.
setAuthMode ( string $mode )	Set the auth mode to use to authenticate.
setAuthenticators ( array $authenticators )	Set the Authenticators which can process a login request.
setKeywordParams ( array $parameters )	Set the parameters which the EHLO greeting indicated.
setPassword ( string $password )	Set the password to authenticate with.
setUsername ( string $username )	Set the username to authenticate with.

Protected Methods

Method	Description
_getAuthenticatorsForAgent ( ) : array	Returns the authenticator list for the given agent.

Method Details

__construct() public method

Create a new AuthHandler with $authenticators for support.

public __construct ( array $authenticators )
$authenticators	array

_getAuthenticatorsForAgent() protected method

Returns the authenticator list for the given agent.

protected _getAuthenticatorsForAgent ( ) : array
return	array

afterEhlo() public method

Runs immediately after a EHLO has been issued.

public afterEhlo ( Swift_Transport_SmtpAgent $agent )
$agent	Swift_Transport_SmtpAgent	to read/write

exposeMixinMethods() public method

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

public exposeMixinMethods ( ) : string[]
return	string[]

getAuthMode() public method

Get the auth mode to use to authenticate.

public getAuthMode ( ) : string
return	string

getAuthenticators() public method

Get the Authenticators which can process a login request.

public getAuthenticators ( ) : Swift_Transport_Esmtp_Authenticator[]
return	Swift_Transport_Esmtp_Authenticator[]

getHandledKeyword() public method

Get the name of the ESMTP extension this handles.

public getHandledKeyword ( ) : boolean
return	boolean

getMailParams() public method

Not used.

public getMailParams ( )

getPassword() public method

Get the password to authenticate with.

public getPassword ( ) : string
return	string

getPriorityOver() public method

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

public getPriorityOver ( string $esmtpKeyword ) : integer
$esmtpKeyword	string	to compare with
return	integer

getRcptParams() public method

Not used.

public getRcptParams ( )

getUsername() public method

Get the username to authenticate with.

public getUsername ( ) : string
return	string

onCommand() public method

Not used.

public onCommand ( Swift_Transport_SmtpAgent $agent, $command, $codes = [], &$failedRecipients = null, &$stop = false )
$agent	Swift_Transport_SmtpAgent

resetState() public method

Not used.

public resetState ( )

setAuthMode() public method

Set the auth mode to use to authenticate.

public setAuthMode ( string $mode )
$mode	string

setAuthenticators() public method

Set the Authenticators which can process a login request.

public setAuthenticators ( array $authenticators )
$authenticators	array

setKeywordParams() public method

Set the parameters which the EHLO greeting indicated.

public setKeywordParams ( array $parameters )
$parameters	array

setPassword() public method

Set the password to authenticate with.

public setPassword ( string $password )
$password	string

setUsername() public method

Set the username to authenticate with.

public setUsername ( string $username )
$username	string