/framework/vendor/swift/lib/classes/Swift/Transport/Esmtp/Authenticator.php

 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//@require 'Swift/Transport/SmtpAgent.php';
12
13/**
14 * An Authentication mechanism.
15 * @package Swift
16 * @subpackage Transport
17 * @author Chris Corbyn
18 */
19interface Swift_Transport_Esmtp_Authenticator
20{
21  
22  /**
23   * Get the name of the AUTH mechanism this Authenticator handles.
24   * @return string
25   */
26  public function getAuthKeyword();
27  
28  /**
29   * Try to authenticate the user with $username and $password.
30   * @param Swift_Transport_SmtpAgent $agent
31   * @param string $username
32   * @param string $password
33   * @return boolean
34   */
35  public function authenticate(Swift_Transport_SmtpAgent $agent,
36    $username, $password);
37  
38}