interface AuthenticatorInterface

An Authentication mechanism.

@author Chris Corbyn

Hierarchy

interface \Symfony\Component\Mailer\Transport\Smtp\Auth\AuthenticatorInterface

Expanded class hierarchy of AuthenticatorInterface

All classes that implement AuthenticatorInterface

1 file declares its use of AuthenticatorInterface

EsmtpTransport.php in vendor/symfony/mailer/Transport/Smtp/EsmtpTransport.php

File

vendor/symfony/mailer/Transport/Smtp/Auth/AuthenticatorInterface.php, line 22

Namespace

Symfony\Component\Mailer\Transport\Smtp\Auth

View source

interface AuthenticatorInterface {
    
    /**
     * Tries to authenticate the user.
     *
     * @throws TransportExceptionInterface
     */
    public function authenticate(EsmtpTransport $client) : void;
    
    /**
     * Gets the name of the AUTH mechanism this Authenticator handles.
     */
    public function getAuthKeyword() : string;

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overrides
AuthenticatorInterface::authenticate	public	function	Tries to authenticate the user.	4
AuthenticatorInterface::getAuthKeyword	public	function	Gets the name of the AUTH mechanism this Authenticator handles.	4