49 lines
1.3 KiB
PHP
49 lines
1.3 KiB
PHP
<?php
|
|
|
|
/*
|
|
The interface an AUTH mechanism implements in Swift Mailer.
|
|
|
|
This program is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
*/
|
|
|
|
//@require 'Swift/Transport/SmtpAgent.php';
|
|
|
|
/**
|
|
* An Authentication mechanism.
|
|
* @package Swift
|
|
* @subpackage Transport
|
|
* @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 Swift_Transport_SmtpAgent $agent
|
|
* @param string $username
|
|
* @param string $password
|
|
* @return boolean
|
|
*/
|
|
public function authenticate(Swift_Transport_SmtpAgent $agent,
|
|
$username, $password);
|
|
|
|
}
|