Swift_Transport Interface Reference

Inheritance diagram for Swift_Transport:

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

Detailed Description

Definition at line 21 of file Transport.php.

Member Function Documentation

Swift_Transport::isStarted

(

)

Test if this Transport mechanism has started.

Returns

boolean

Implemented in Swift_Transport_AbstractSmtpTransport, Swift_Transport_LoadBalancedTransport, and Swift_Transport_MailTransport.

Swift_Transport::registerPlugin

(

Swift_Events_EventListener

$plugin

)

Register a plugin in the Transport.

Parameters

Swift_Events_EventListener

$plugin

Implemented in Swift_Transport_AbstractSmtpTransport, Swift_Transport_MailTransport, and Swift_Transport_LoadBalancedTransport.

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

Send the given Message.

Recipient/sender data will be retreived from the Message API. The return value is the number of recipients who were accepted for delivery.

Parameters

Swift_Mime_Message	$message
	string[]	&$failedRecipients to collect failures by-reference

Returns

int

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

Swift_Transport::start

(

)

Start this Transport mechanism.

Implemented in Swift_Transport_AbstractSmtpTransport, Swift_Transport_LoadBalancedTransport, Swift_Transport_MailTransport, and Swift_Transport_SendmailTransport.

Swift_Transport::stop

(

)

Stop this Transport mechanism.

Implemented in Swift_Transport_AbstractSmtpTransport, Swift_Transport_LoadBalancedTransport, and Swift_Transport_MailTransport.

---

The documentation for this interface was generated from the following file:

• L:/XOOPS_Allure/SVN_XOOPS2/RMC/rmcommon/trunk/rmcommon/class/swift/classes/Swift/Transport.php