1<?php
2
3/**
4 * Swift Mailer Authenticator Interface
5 * Please read the LICENSE file
6 * @author Chris Corbyn <chris@w3style.co.uk>
7 * @package Swift_Authenticator
8 * @license GNU Lesser General Public License
9 */
10
11/**
12 * Swift Authenticator Interface
13 * Lists the methods all authenticators must implement
14 * @package Swift_Authenticator
15 * @author Chris Corbyn <chris@w3style.co.uk>
16 */
17interface Swift_Authenticator
18{
19  /**
20   * Try to authenticate using the username and password
21   * Returns false on failure
22   * @param string The username
23   * @param string The password
24   * @param Swift The instance of Swift this authenticator is used in
25   * @return boolean
26   */
27  public function isAuthenticated($username, $password, Swift $instance);
28  /**
29   * Return the name of the AUTH extension this is for
30   * @return string
31   */
32  public function getAuthExtensionName();
33}
34