Class Swift_Plugins_DecoratorPlugin

Allows customization of Messages on-the-fly.

Swift_Plugins_DecoratorPlugin implements Swift_Events_SendListener, Swift_Plugins_Decorator_Replacements

Package: Swift\Plugins
Author: Chris Corbyn
Author: Fabien Potencier
Located at vendors/swiftmailer/lib/classes/Swift/Plugins/DecoratorPlugin.php

Methods summary

`public`	# `__construct( mixed $replacements )` Create a new DecoratorPlugin with $replacements. Create a new DecoratorPlugin with $replacements. The $replacements can either be an associative array, or an implementation of `Swift_Plugins_Decorator_Replacements`. When using an array, it should be of the form: $replacements = array( "address1@domain.tld" => array("{a}" => "b", "{c}" => "d"), "address2@domain.tld" => array("{a}" => "x", "{c}" => "y") ) When using an instance of `Swift_Plugins_Decorator_Replacements`, the object should return just the array of replacements for the address given to `Swift_Plugins_Decorator_Replacements::getReplacementsFor()`. Parameters `$replacements` `mixed` $replacements Array or Swift_Plugins_Decorator_Replacements
`public`	# `setReplacements( mixed $replacements )` Sets replacements. Sets replacements. Parameters `$replacements` `mixed` $replacements Array or Swift_Plugins_Decorator_Replacements See `Swift_Plugins_DecoratorPlugin::__construct()`
`public`	# `beforeSendPerformed( Swift_Events_SendEvent $evt )` Invoked immediately before the Message is sent. Invoked immediately before the Message is sent. Parameters `$evt` `Swift_Events_SendEvent` $evt Implementation of `Swift_Events_SendListener::beforeSendPerformed()`
`public array`	# `getReplacementsFor( string $address )` Find a map of replacements for the address. Find a map of replacements for the address. If this plugin was provided with a delegate instance of `Swift_Plugins_Decorator_Replacements` then the call will be delegated to it. Otherwise, it will attempt to find the replacements from the array provided in the constructor. If no replacements can be found, an empty value (NULL) is returned. Parameters `$address` `string` $address Returns `array` Implementation of `Swift_Plugins_Decorator_Replacements::getReplacementsFor()`
`public`	# `sendPerformed( Swift_Events_SendEvent $evt )` Invoked immediately after the Message is sent. Invoked immediately after the Message is sent. Parameters `$evt` `Swift_Events_SendEvent` $evt Implementation of `Swift_Events_SendListener::sendPerformed()`
`private`	# `_restoreMessage( Swift_Mime_Message $message )` Restore a changed message back to its original state Restore a changed message back to its original state

Magic methods summary

Properties summary

`private mixed`	`$_replacements`	# The replacement map The replacement map
`private mixed`	`$_originalBody`	# The body as it was before replacements The body as it was before replacements
`private array`	`$_originalHeaders`	# The original headers of the message, before replacements The original headers of the message, before replacements
`private array`	`$_originalChildBodies`	# Bodies of children before they are replaced Bodies of children before they are replaced
`private mixed`	`$_lastMessage`	# The Message that was last replaced The Message that was last replaced

Packages

Classes

Interfaces

Class Swift_Plugins_DecoratorPlugin

Methods summary

Parameters

Parameters

See

Parameters

Implementation of

Parameters

Returns

Implementation of

Parameters

Implementation of

Magic methods summary

Properties summary