Swift_Transport_Esmtp_AuthHandler
in package
implements
Swift_Transport_EsmtpHandler
An ESMTP handler for AUTH support (RFC 5248).
Tags
Interfaces, Classes and Traits
- Swift_Transport_EsmtpHandler
- An ESMTP handler.
Table of Contents
- $auth_mode : string
- The auth mode for authentication.
- $authenticators : array<string|int, Swift_Transport_Esmtp_Authenticator>
- Authenticators available to process the request.
- $esmtpParams : array<string|int, string>
- The ESMTP AUTH parameters available.
- $password : string
- The password for authentication.
- $username : string
- The username for authentication.
- __construct() : mixed
- Create a new AuthHandler with $authenticators for support.
- afterEhlo() : mixed
- Runs immediately after a EHLO has been issued.
- exposeMixinMethods() : array<string|int, string>
- Returns an array of method names which are exposed to the Esmtp class.
- getAuthenticators() : array<string|int, Swift_Transport_Esmtp_Authenticator>
- Get the Authenticators which can process a login request.
- getAuthMode() : string
- Get the auth mode to use to authenticate.
- getHandledKeyword() : string
- Get the name of the ESMTP extension this handles.
- getMailParams() : array<string|int, string>
- Not used.
- getPassword() : string
- Get the password to authenticate with.
- getPriorityOver() : int
- Returns +1, -1 or 0 according to the rules for usort().
- getRcptParams() : array<string|int, string>
- Not used.
- getUsername() : string
- Get the username to authenticate with.
- onCommand() : mixed
- Not used.
- resetState() : mixed
- Not used.
- setAuthenticators() : mixed
- Set the Authenticators which can process a login request.
- setAuthMode() : mixed
- Set the auth mode to use to authenticate.
- setKeywordParams() : mixed
- Set the parameters which the EHLO greeting indicated.
- setPassword() : mixed
- Set the password to authenticate with.
- setUsername() : mixed
- Set the username to authenticate with.
- getAuthenticatorsForAgent() : array<string|int, mixed>
- Returns the authenticator list for the given agent.
Properties
$auth_mode
The auth mode for authentication.
private
string
$auth_mode
$authenticators
Authenticators available to process the request.
private
array<string|int, Swift_Transport_Esmtp_Authenticator>
$authenticators
= []
$esmtpParams
The ESMTP AUTH parameters available.
private
array<string|int, string>
$esmtpParams
= []
$password
The password for authentication.
private
string
$password
$username
The username for authentication.
private
string
$username
Methods
__construct()
Create a new AuthHandler with $authenticators for support.
public
__construct(array<string|int, Swift_Transport_Esmtp_Authenticator> $authenticators) : mixed
Parameters
- $authenticators : array<string|int, Swift_Transport_Esmtp_Authenticator>
Return values
mixed —afterEhlo()
Runs immediately after a EHLO has been issued.
public
afterEhlo(Swift_Transport_SmtpAgent $agent) : mixed
Parameters
- $agent : Swift_Transport_SmtpAgent
-
to read/write
Return values
mixed —exposeMixinMethods()
Returns an array of method names which are exposed to the Esmtp class.
public
exposeMixinMethods() : array<string|int, string>
Return values
array<string|int, string> —getAuthenticators()
Get the Authenticators which can process a login request.
public
getAuthenticators() : array<string|int, Swift_Transport_Esmtp_Authenticator>
Return values
array<string|int, Swift_Transport_Esmtp_Authenticator> —getAuthMode()
Get the auth mode to use to authenticate.
public
getAuthMode() : string
Return values
string —getHandledKeyword()
Get the name of the ESMTP extension this handles.
public
getHandledKeyword() : string
Return values
string —getMailParams()
Not used.
public
getMailParams() : array<string|int, string>
Return values
array<string|int, string> —getPassword()
Get the password to authenticate with.
public
getPassword() : string
Return values
string —getPriorityOver()
Returns +1, -1 or 0 according to the rules for usort().
public
getPriorityOver(string $esmtpKeyword) : int
This method is called to ensure extensions can be execute in an appropriate order.
Parameters
- $esmtpKeyword : string
-
to compare with
Return values
int —getRcptParams()
Not used.
public
getRcptParams() : array<string|int, string>
Return values
array<string|int, string> —getUsername()
Get the username to authenticate with.
public
getUsername() : string
Return values
string —onCommand()
Not used.
public
onCommand(Swift_Transport_SmtpAgent $agent, mixed $command[, mixed $codes = [] ][, mixed &$failedRecipients = null ][, mixed &$stop = false ]) : mixed
Parameters
- $agent : Swift_Transport_SmtpAgent
-
to read/write
- $command : mixed
-
to send
- $codes : mixed = []
-
expected in response
- $failedRecipients : mixed = null
-
to collect failures
- $stop : mixed = false
-
to be set true by-reference if the command is now sent
Return values
mixed —resetState()
Not used.
public
resetState() : mixed
Return values
mixed —setAuthenticators()
Set the Authenticators which can process a login request.
public
setAuthenticators(array<string|int, Swift_Transport_Esmtp_Authenticator> $authenticators) : mixed
Parameters
- $authenticators : array<string|int, Swift_Transport_Esmtp_Authenticator>
Return values
mixed —setAuthMode()
Set the auth mode to use to authenticate.
public
setAuthMode(string $mode) : mixed
Parameters
- $mode : string
Return values
mixed —setKeywordParams()
Set the parameters which the EHLO greeting indicated.
public
setKeywordParams(array<string|int, string> $parameters) : mixed
Parameters
- $parameters : array<string|int, string>
Return values
mixed —setPassword()
Set the password to authenticate with.
public
setPassword(string $password) : mixed
Parameters
- $password : string
Return values
mixed —setUsername()
Set the username to authenticate with.
public
setUsername(string $username) : mixed
Parameters
- $username : string
Return values
mixed —getAuthenticatorsForAgent()
Returns the authenticator list for the given agent.
protected
getAuthenticatorsForAgent() : array<string|int, mixed>