Swift_Transport_Esmtp_Authenticator Interface Reference

Inheritance diagram for Swift_Transport_Esmtp_Authenticator:

Public Member Functions
	getAuthKeyword ()
	authenticate (Swift_Transport_SmtpAgent $agent, $username, $password)

Detailed Description

An Authentication mechanism.

Author

Chris Corbyn

Definition at line 16 of file Authenticator.php.

Member Function Documentation

authenticate	(	Swift_Transport_SmtpAgent	$agent,
			$username,
			$password
	)

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

Parameters

Swift_Transport_SmtpAgent	$agent
string	$username
string	$password

Returns

bool

Implemented in Swift_Transport_Esmtp_Auth_XOAuth2Authenticator, Swift_Transport_Esmtp_Auth_NTLMAuthenticator, Swift_Transport_Esmtp_Auth_CramMd5Authenticator, Swift_Transport_Esmtp_Auth_LoginAuthenticator, and Swift_Transport_Esmtp_Auth_PlainAuthenticator.

getAuthKeyword

(

)

Get the name of the AUTH mechanism this Authenticator handles.

Returns

string

Implemented in Swift_Transport_Esmtp_Auth_XOAuth2Authenticator, Swift_Transport_Esmtp_Auth_NTLMAuthenticator, Swift_Transport_Esmtp_Auth_CramMd5Authenticator, Swift_Transport_Esmtp_Auth_LoginAuthenticator, and Swift_Transport_Esmtp_Auth_PlainAuthenticator.