Swift_Transport_Esmtp_Auth_CramMd5Authenticator
in package
implements
Swift_Transport_Esmtp_Authenticator
Handles CRAM-MD5 authentication.
Tags
Interfaces, Classes and Traits
- Swift_Transport_Esmtp_Authenticator
- An Authentication mechanism.
Table of Contents
- authenticate() : bool
- Try to authenticate the user with $username and $password.
- getAuthKeyword() : string
- Get the name of the AUTH mechanism this Authenticator handles.
- getResponse() : string
- Generate a CRAM-MD5 response from a server challenge.
Methods
authenticate()
Try to authenticate the user with $username and $password.
public
authenticate(Swift_Transport_SmtpAgent $agent, mixed $username, mixed $password) : bool
Parameters
- $agent : Swift_Transport_SmtpAgent
- $username : mixed
- $password : mixed
Return values
bool —true if authentication worked (returning false is deprecated, throw a Swift_TransportException instead)
getAuthKeyword()
Get the name of the AUTH mechanism this Authenticator handles.
public
getAuthKeyword() : string
Return values
string —getResponse()
Generate a CRAM-MD5 response from a server challenge.
private
getResponse(string $secret, string $challenge) : string
Parameters
- $secret : string
- $challenge : string