\Swift_Transport_Esmtp_AuthHandler
An ESMTP handler for AUTH support.
- Author: Chris Corbyn
Synopsis
class Swift_Transport_Esmtp_AuthHandler
implements
Swift_Transport_EsmtpHandler
{
- // members
- private array $_authenticators;
- private string $_username;
- private string $_password;
- private string $_auth_mode;
- private array $_esmtpParams;
- // methods
- public void __construct()
- public void setAuthenticators()
- public array getAuthenticators()
- public void setUsername()
- public string getUsername()
- public void setPassword()
- public string getPassword()
- public void setAuthMode()
- public string getAuthMode()
- public boolean getHandledKeyword()
- public void setKeywordParams()
- public void afterEhlo()
- public void getMailParams()
- public void getRcptParams()
- public void onCommand()
- public int getPriorityOver()
- public array exposeMixinMethods()
- public void resetState()
- protected array _getAuthenticatorsForAgent()
Hierarchy
Implements
Members
private
- $_auth_mode
—
string
The auth mode for authentication. - $_authenticators
—
array
Authenticators available to process the request. - $_esmtpParams
—
array
The ESMTP AUTH parameters available. - $_password
—
string
The password for authentication. - $_username
—
string
The username for authentication.
Methods
protected
- _getAuthenticatorsForAgent() — Returns the authenticator list for the given agent.
public
- __construct() — Create a new AuthHandler with $authenticators for support.
- afterEhlo() — Runs immediately after a EHLO has been issued.
- exposeMixinMethods() — Returns an array of method names which are exposed to the Esmtp class.
- getAuthMode() — Get the auth mode to use to authenticate.
- getAuthenticators() — Get the Authenticators which can process a login request.
- getHandledKeyword() — Get the name of the ESMTP extension this handles.
- getMailParams() — Not used.
- getPassword() — Get the password to authenticate with.
- getPriorityOver() — Returns +1, -1 or 0 according to the rules for usort().
- getRcptParams() — Not used.
- getUsername() — Get the username to authenticate with.
- onCommand() — Not used.
- resetState() — Not used.
- setAuthMode() — Set the auth mode to use to authenticate.
- setAuthenticators() — Set the Authenticators which can process a login request.
- setKeywordParams() — Set the parameters which the EHLO greeting indicated.
- setPassword() — Set the password to authenticate with.
- setUsername() — Set the username to authenticate with.