1: <?php
2:
3: /*
4: * This file is part of SwiftMailer.
5: * (c) 2004-2009 Chris Corbyn
6: *
7: * For the full copyright and license information, please view the LICENSE
8: * file that was distributed with this source code.
9: */
10:
11: /**
12: * An Authentication mechanism.
13: * @package Swift
14: * @subpackage Transport
15: * @author Chris Corbyn
16: */
17: interface Swift_Transport_Esmtp_Authenticator
18: {
19: /**
20: * Get the name of the AUTH mechanism this Authenticator handles.
21: * @return string
22: */
23: public function getAuthKeyword();
24:
25: /**
26: * Try to authenticate the user with $username and $password.
27: * @param Swift_Transport_SmtpAgent $agent
28: * @param string $username
29: * @param string $password
30: * @return boolean
31: */
32: public function authenticate(Swift_Transport_SmtpAgent $agent, $username, $password);
33: }
34: