Interface Swift_Transport

Implemented bySwift_FailoverTransport, Swift_LoadBalancedTransport, Swift_MailTransport, Swift_NullTransport, Swift_SendmailTransport, Swift_SmtpTransport, Swift_SpoolTransport, Swift_Transport_AbstractSmtpTransport, Swift_Transport_EsmtpTransport, Swift_Transport_FailoverTransport, Swift_Transport_LoadBalancedTransport, Swift_Transport_MailTransport, Swift_Transport_NullTransport, Swift_Transport_SendmailTransport, Swift_Transport_SpoolTransport

Sends Messages via an abstract Transport subsystem.

Public Methods

Hide inherited methods

MethodDescriptionDefined 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

isStarted() public abstract method

Test if this Transport mechanism has started.

public abstract bool isStarted ( )
registerPlugin() public abstract method

Register a plugin in the Transport.

public abstract void registerPlugin ( Swift_Events_EventListener $plugin )
$plugin Swift_Events_EventListener
send() public abstract method

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, &$failedRecipients null )
$message Swift_Mime_Message
$failedRecipients string[]

An array of failures by-reference

start() public abstract method

Start this Transport mechanism.

public abstract void start ( )
stop() public abstract method

Stop this Transport mechanism.

public abstract void stop ( )