Interface Swift_Transport
Sends Messages via an abstract Transport subsystem.
Public Methods
Method | Description | Defined By |
---|---|---|
isStarted() | Test if this Transport mechanism has started. | Swift_Transport |
registerPlugin() | Register a plugin in the Transport. | Swift_Transport |
send() | Send the given Message. | Swift_Transport |
start() | Start this Transport mechanism. | Swift_Transport |
stop() | Stop this Transport mechanism. | Swift_Transport |
Method Details
Test if this Transport mechanism has started.
public abstract bool isStarted ( ) |
Register a plugin in the Transport.
public abstract void registerPlugin ( Swift_Events_EventListener $plugin ) | ||
$plugin | Swift_Events_EventListener |
Send the given Message.
Recipient/sender data will be retrieved from the Message API. The return value is the number of recipients who were accepted for delivery.
public abstract int send ( Swift_Mime_Message $message, <b>&</b>$failedRecipients = null ) | ||
$message | Swift_Mime_Message | |
$failedRecipients | string[] | An array of failures by-reference |
Start this Transport mechanism.
public abstract void start ( ) |
Stop this Transport mechanism.
public abstract void stop ( ) |