Interface Swift_Transport_Esmtp_Authenticator

All Classes | Methods
Implemented bySwift_Transport_Esmtp_Auth_CramMd5Authenticator, Swift_Transport_Esmtp_Auth_LoginAuthenticator, Swift_Transport_Esmtp_Auth_NTLMAuthenticator, Swift_Transport_Esmtp_Auth_PlainAuthenticator, Swift_Transport_Esmtp_Auth_XOAuth2Authenticator

An Authentication mechanism.

Public Methods

Hide inherited methods

MethodDescriptionDefined By
authenticate() Try to authenticate the user with $username and $password. Swift_Transport_Esmtp_Authenticator
getAuthKeyword() Get the name of the AUTH mechanism this Authenticator handles. Swift_Transport_Esmtp_Authenticator

Method Details

authenticate() public abstract method

Try to authenticate the user with $username and $password.

public abstract bool authenticate ( Swift_Transport_SmtpAgent $agent, $username, $password )
$agent Swift_Transport_SmtpAgent
$username string
$password string
getAuthKeyword() public abstract method

Get the name of the AUTH mechanism this Authenticator handles.

public abstract string getAuthKeyword ( )