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

http://zoop.googlecode.com/ · PHP · 38 lines · 7 code · 6 blank · 25 comment · 0 complexity · 30f92ba42ace66ec0ecdf424e00fa816 MD5 · raw file

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