vendor/swiftmailer/lib/classes/Swift/Transport.php
changeset 0 7f95f8617b0b
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/vendor/swiftmailer/lib/classes/Swift/Transport.php	Sat Sep 24 15:40:41 2011 +0200
@@ -0,0 +1,58 @@
+<?php
+
+/*
+ * This file is part of SwiftMailer.
+ * (c) 2004-2009 Chris Corbyn
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+
+/**
+ * Sends Messages via an abstract Transport subsystem.
+ * 
+ * @package Swift
+ * @subpackage Transport
+ * @author Chris Corbyn
+ */
+interface Swift_Transport
+{
+
+  /**
+   * Test if this Transport mechanism has started.
+   * 
+   * @return boolean
+   */
+  public function isStarted();
+  
+  /**
+   * Start this Transport mechanism.
+   */
+  public function start();
+  
+  /**
+   * Stop this Transport mechanism.
+   */
+  public function stop();
+  
+  /**
+   * Send the given Message.
+   * 
+   * Recipient/sender data will be retreived from the Message API.
+   * The return value is the number of recipients who were accepted for delivery.
+   * 
+   * @param Swift_Mime_Message $message
+   * @param string[] &$failedRecipients to collect failures by-reference
+   * @return int
+   */
+  public function send(Swift_Mime_Message $message, &$failedRecipients = null);
+  
+  /**
+   * Register a plugin in the Transport.
+   * 
+   * @param Swift_Events_EventListener $plugin
+   */
+  public function registerPlugin(Swift_Events_EventListener $plugin);
+  
+}