/framework/vendor/swift/lib/classes/Swift/Transport.php
PHP | 60 lines | 9 code | 9 blank | 42 comment | 0 complexity | 0d25b0bd8aea0ffb7837c17200de3524 MD5 | raw file
1<?php 2 3/* 4 * This file is part of SwiftMailer. 5 * (c) 2004-2009 Chris Corbyn 6 * 7 * For the full copyright and license information, please view the LICENSE 8 * file that was distributed with this source code. 9 */ 10 11//@require 'Swift/Mime/Message.php'; 12//@require 'Swift/Events/EventListener.php'; 13 14/** 15 * Sends Messages via an abstract Transport subsystem. 16 * 17 * @package Swift 18 * @subpackage Transport 19 * @author Chris Corbyn 20 */ 21interface Swift_Transport 22{ 23 24 /** 25 * Test if this Transport mechanism has started. 26 * 27 * @return boolean 28 */ 29 public function isStarted(); 30 31 /** 32 * Start this Transport mechanism. 33 */ 34 public function start(); 35 36 /** 37 * Stop this Transport mechanism. 38 */ 39 public function stop(); 40 41 /** 42 * Send the given Message. 43 * 44 * Recipient/sender data will be retreived from the Message API. 45 * The return value is the number of recipients who were accepted for delivery. 46 * 47 * @param Swift_Mime_Message $message 48 * @param string[] &$failedRecipients to collect failures by-reference 49 * @return int 50 */ 51 public function send(Swift_Mime_Message $message, &$failedRecipients = null); 52 53 /** 54 * Register a plugin in the Transport. 55 * 56 * @param Swift_Events_EventListener $plugin 57 */ 58 public function registerPlugin(Swift_Events_EventListener $plugin); 59 60}