Class Swift_Transport_Esmtp_AuthHandler

All Classes | Methods
InheritanceSwift_Transport_Esmtp_AuthHandler
ImplementsSwift_Transport_EsmtpHandler

An ESMTP handler for AUTH support.

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__construct() Create a new AuthHandler with $authenticators for support. Swift_Transport_Esmtp_AuthHandler
afterEhlo() Runs immediately after a EHLO has been issued. Swift_Transport_Esmtp_AuthHandler
exposeMixinMethods() Returns an array of method names which are exposed to the Esmtp class. Swift_Transport_Esmtp_AuthHandler
getAuthMode() Get the auth mode to use to authenticate. Swift_Transport_Esmtp_AuthHandler
getAuthenticators() Get the Authenticators which can process a login request. Swift_Transport_Esmtp_AuthHandler
getHandledKeyword() Get the name of the ESMTP extension this handles. Swift_Transport_Esmtp_AuthHandler
getMailParams() Not used. Swift_Transport_Esmtp_AuthHandler
getPassword() Get the password to authenticate with. Swift_Transport_Esmtp_AuthHandler
getPriorityOver() Returns +1, -1 or 0 according to the rules for usort(). Swift_Transport_Esmtp_AuthHandler
getRcptParams() Not used. Swift_Transport_Esmtp_AuthHandler
getUsername() Get the username to authenticate with. Swift_Transport_Esmtp_AuthHandler
onCommand() Not used. Swift_Transport_Esmtp_AuthHandler
resetState() Not used. Swift_Transport_Esmtp_AuthHandler
setAuthMode() Set the auth mode to use to authenticate. Swift_Transport_Esmtp_AuthHandler
setAuthenticators() Set the Authenticators which can process a login request. Swift_Transport_Esmtp_AuthHandler
setKeywordParams() Set the parameters which the EHLO greeting indicated. Swift_Transport_Esmtp_AuthHandler
setPassword() Set the password to authenticate with. Swift_Transport_Esmtp_AuthHandler
setUsername() Set the username to authenticate with. Swift_Transport_Esmtp_AuthHandler

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
_getAuthenticatorsForAgent() Returns the authenticator list for the given agent. Swift_Transport_Esmtp_AuthHandler

Method Details

__construct() public method

Create a new AuthHandler with $authenticators for support.

public void __construct ( array $authenticators )
$authenticators Swift_Transport_Esmtp_Authenticator[]
_getAuthenticatorsForAgent() protected method

Returns the authenticator list for the given agent.

protected array _getAuthenticatorsForAgent ( )
afterEhlo() public method

Runs immediately after a EHLO has been issued.

public void 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 string[] exposeMixinMethods ( )
getAuthMode() public method

Get the auth mode to use to authenticate.

public string getAuthMode ( )
getAuthenticators() public method

Get the Authenticators which can process a login request.

public Swift_Transport_Esmtp_Authenticator[] getAuthenticators ( )
getHandledKeyword() public method

Get the name of the ESMTP extension this handles.

public bool getHandledKeyword ( )
getMailParams() public method

Not used.

public void getMailParams ( )
getPassword() public method

Get the password to authenticate with.

public string getPassword ( )
getPriorityOver() public method

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.

public int getPriorityOver ( $esmtpKeyword )
$esmtpKeyword string

To compare with
getRcptParams() public method

Not used.

public void getRcptParams ( )
getUsername() public method

Get the username to authenticate with.

public string getUsername ( )
onCommand() public method

Not used.

public void onCommand ( Swift_Transport_SmtpAgent $agent, $command, $codes = [], <b>&</b>$failedRecipients = null, <b>&</b>$stop = false )
$agent
$command
$codes
$failedRecipients
$stop
resetState() public method

Not used.

public void resetState ( )
setAuthMode() public method

Set the auth mode to use to authenticate.

public void setAuthMode ( $mode )
$mode string
setAuthenticators() public method

Set the Authenticators which can process a login request.

public void setAuthenticators ( array $authenticators )
$authenticators Swift_Transport_Esmtp_Authenticator[]
setKeywordParams() public method

Set the parameters which the EHLO greeting indicated.

public void setKeywordParams ( array $parameters )
$parameters string[]
setPassword() public method

Set the password to authenticate with.

public void setPassword ( $password )
$password string
setUsername() public method

Set the username to authenticate with.

public void setUsername ( $username )
$username string