Swift_Transport Interface Reference

Inheritance diagram for Swift_Transport:

Public Member Functions
	isStarted ()
	start ()
	stop ()
	send (Swift_Mime_Message $message, &$failedRecipients=null)
	registerPlugin (Swift_Events_EventListener $plugin)

Detailed Description

Sends Messages via an abstract Transport subsystem.

Author

Chris Corbyn

Definition at line 16 of file Transport.php.

Member Function Documentation

isStarted

(

)

Test if this Transport mechanism has started.

Returns

bool

Implemented in Swift_Transport_AbstractSmtpTransport, Swift_Transport_LoadBalancedTransport, Swift_Transport_SpoolTransport, Swift_Transport_MailTransport, MboxTransport, and Swift_Transport_NullTransport.

Referenced by Swift_MemorySpool\flushQueue(), and Swift_FileSpool\flushQueue().

registerPlugin

(

Swift_Events_EventListener

$plugin

)

Register a plugin in the Transport.

Parameters

Swift_Events_EventListener

$plugin

Implemented in Swift_Transport_AbstractSmtpTransport, Swift_Transport_MailTransport, Swift_Transport_LoadBalancedTransport, Swift_Transport_SpoolTransport, and Swift_Transport_NullTransport.

send	(	Swift_Mime_Message	$message,
		&	$failedRecipients = null
	)

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.

Parameters

Swift_Mime_Message	$message
	string[]	$failedRecipients An array of failures by-reference

Returns

int

Implemented in Swift_Transport_AbstractSmtpTransport, Swift_Transport_MailTransport, Swift_Transport_SendmailTransport, Swift_Transport_LoadBalancedTransport, Swift_Transport_SpoolTransport, Swift_Transport_NullTransport, and Swift_Transport_FailoverTransport.

Referenced by Swift_MemorySpool\flushQueue(), and Swift_FileSpool\flushQueue().

start

(

)

Start this Transport mechanism.

Implemented in Swift_Transport_AbstractSmtpTransport, Swift_Transport_LoadBalancedTransport, Swift_Transport_SpoolTransport, Swift_Transport_MailTransport, MboxTransport, Swift_Transport_SendmailTransport, and Swift_Transport_NullTransport.

Referenced by Swift_MemorySpool\flushQueue(), and Swift_FileSpool\flushQueue().

stop

(

)

Stop this Transport mechanism.

Implemented in Swift_Transport_AbstractSmtpTransport, Swift_Transport_LoadBalancedTransport, Swift_Transport_SpoolTransport, Swift_Transport_MailTransport, MboxTransport, and Swift_Transport_NullTransport.