PageRenderTime 30ms CodeModel.GetById 17ms RepoModel.GetById 0ms app.codeStats 0ms

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

http://zoop.googlecode.com/
PHP | 60 lines | 9 code | 9 blank | 42 comment | 0 complexity | 0d25b0bd8aea0ffb7837c17200de3524 MD5 | raw file
Possible License(s): BSD-3-Clause, LGPL-2.1
  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/Mime/Message.php';
  10. //@require 'Swift/Events/EventListener.php';
  11. /**
  12. * Sends Messages via an abstract Transport subsystem.
  13. *
  14. * @package Swift
  15. * @subpackage Transport
  16. * @author Chris Corbyn
  17. */
  18. interface Swift_Transport
  19. {
  20. /**
  21. * Test if this Transport mechanism has started.
  22. *
  23. * @return boolean
  24. */
  25. public function isStarted();
  26. /**
  27. * Start this Transport mechanism.
  28. */
  29. public function start();
  30. /**
  31. * Stop this Transport mechanism.
  32. */
  33. public function stop();
  34. /**
  35. * Send the given Message.
  36. *
  37. * Recipient/sender data will be retreived from the Message API.
  38. * The return value is the number of recipients who were accepted for delivery.
  39. *
  40. * @param Swift_Mime_Message $message
  41. * @param string[] &$failedRecipients to collect failures by-reference
  42. * @return int
  43. */
  44. public function send(Swift_Mime_Message $message, &$failedRecipients = null);
  45. /**
  46. * Register a plugin in the Transport.
  47. *
  48. * @param Swift_Events_EventListener $plugin
  49. */
  50. public function registerPlugin(Swift_Events_EventListener $plugin);
  51. }