Swift_Transport_Esmtp_Authenticator
in
An Authentication mechanism.
Tags
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.
Methods
authenticate()
Try to authenticate the user with $username and $password.
public
authenticate(Swift_Transport_SmtpAgent $agent, string $username, string $password) : bool
Parameters
- $agent : Swift_Transport_SmtpAgent
- $username : string
- $password : string
Tags
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