Classes List

Swift_Transport_Esmtp_Authenticator

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
<?php

/* * This file is part of SwiftMailer. * (c) 2004-2009 Chris Corbyn * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */


/** * An Authentication mechanism. * * @author Chris Corbyn */
interface Swift_Transport_Esmtp_Authenticator
{
    /** * Get the name of the AUTH mechanism this Authenticator handles. * * @return string */
    public function getAuthKeyword();

    /** * Try to authenticate the user with $username and $password. * * @param string $username * @param string $password * * @return bool true if authentication worked (returning false is deprecated, throw a Swift_TransportException instead) * * @throws Swift_TransportException Allows the message to bubble up when authentication was not successful */
    public function authenticate(Swift_Transport_SmtpAgent $agent$username$password);
}