Class Swift_Transport_Esmtp_AuthHandler
Inheritance | Swift_Transport_Esmtp_AuthHandler |
---|---|
Implements | Swift_Transport_EsmtpHandler |
An ESMTP handler for AUTH support.
Public Methods
Protected Methods
Method | Description | Defined By |
---|---|---|
_getAuthenticatorsForAgent() | Returns the authenticator list for the given agent. | Swift_Transport_Esmtp_AuthHandler |
Method Details
Create a new AuthHandler with $authenticators for support.
public void __construct ( array $authenticators ) | ||
$authenticators | Swift_Transport_Esmtp_Authenticator[] |
Returns the authenticator list for the given agent.
protected array _getAuthenticatorsForAgent ( ) |
Runs immediately after a EHLO has been issued.
public void afterEhlo ( Swift_Transport_SmtpAgent $agent ) | ||
$agent | Swift_Transport_SmtpAgent | To read/write |
Returns an array of method names which are exposed to the Esmtp class.
public string[] exposeMixinMethods ( ) |
Get the auth mode to use to authenticate.
public string getAuthMode ( ) |
Get the Authenticators which can process a login request.
public Swift_Transport_Esmtp_Authenticator[] getAuthenticators ( ) |
Get the name of the ESMTP extension this handles.
public bool getHandledKeyword ( ) |
Not used.
public void getMailParams ( ) |
Get the password to authenticate with.
public string getPassword ( ) |
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 |
Not used.
public void getRcptParams ( ) |
Get the username to authenticate with.
public string getUsername ( ) |
Not used.
public void onCommand ( Swift_Transport_SmtpAgent $agent, $command, $codes = [], <b>&</b>$failedRecipients = null, <b>&</b>$stop = false ) | ||
$agent | ||
$command | ||
$codes | ||
$failedRecipients | ||
$stop |
Not used.
public void resetState ( ) |
Set the auth mode to use to authenticate.
public void setAuthMode ( $mode ) | ||
$mode | string |
Set the Authenticators which can process a login request.
public void setAuthenticators ( array $authenticators ) | ||
$authenticators | Swift_Transport_Esmtp_Authenticator[] |
Set the parameters which the EHLO greeting indicated.
public void setKeywordParams ( array $parameters ) | ||
$parameters | string[] |
Set the password to authenticate with.
public void setPassword ( $password ) | ||
$password | string |
Set the username to authenticate with.
public void setUsername ( $username ) | ||
$username | string |