Classes List

Swift_Spool

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
<?php

/* * This file is part of SwiftMailer. * (c) 2009 Fabien Potencier <fabien.potencier@gmail.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */


/** * Interface for spools. * * @author Fabien Potencier */
interface Swift_Spool
{
    /** * Starts this Spool mechanism. */
    public function start();

    /** * Stops this Spool mechanism. */
    public function stop();

    /** * Tests if this Spool mechanism has started. * * @return bool */
    public function isStarted();

    /** * Queues a message. * * @param Swift_Mime_SimpleMessage $message The message to store * * @return bool Whether the operation has succeeded */
    public function queueMessage(Swift_Mime_SimpleMessage $message);

    /** * Sends messages using the given transport instance. * * @param Swift_Transport $transport A transport instance * @param string[] $failedRecipients An array of failures by-reference * * @return int The number of sent emails */
    public function flushQueue(Swift_Transport $transport, &$failedRecipients = null);
}