Swift_Plugins_RedirectingPlugin
in package
implements
Swift_Events_SendListener
Redirects all email to a single recipient.
Tags
Interfaces, Classes and Traits
- Swift_Events_SendListener
- Listens for Messages being sent from within the Transport system.
Table of Contents
- $recipient : mixed
- The recipient who will receive all messages.
- $whitelist : array<string|int, mixed>
- List of regular expression for recipient whitelisting.
- __construct() : mixed
- Create a new RedirectingPlugin.
- beforeSendPerformed() : mixed
- Invoked immediately before the Message is sent.
- getRecipient() : mixed
- Get the recipient of all messages.
- getWhitelist() : array<string|int, mixed>
- Get the whitelist.
- sendPerformed() : mixed
- Invoked immediately after the Message is sent.
- setRecipient() : mixed
- Set the recipient of all messages.
- setWhitelist() : mixed
- Set a list of regular expressions to whitelist certain recipients.
- isWhitelisted() : bool
- Matches address against whitelist of regular expressions.
- filterHeaderSet() : mixed
- Filter header set against a whitelist of regular expressions.
- filterNameAddresses() : array<string|int, mixed>
- Filtered list of addresses => name pairs.
- restoreMessage() : mixed
Properties
$recipient
The recipient who will receive all messages.
private
mixed
$recipient
$whitelist
List of regular expression for recipient whitelisting.
private
array<string|int, mixed>
$whitelist
= []
Methods
__construct()
Create a new RedirectingPlugin.
public
__construct(mixed $recipient[, array<string|int, mixed> $whitelist = [] ]) : mixed
Parameters
- $recipient : mixed
- $whitelist : array<string|int, mixed> = []
Return values
mixed —beforeSendPerformed()
Invoked immediately before the Message is sent.
public
beforeSendPerformed(Swift_Events_SendEvent $evt) : mixed
Parameters
- $evt : Swift_Events_SendEvent
Return values
mixed —getRecipient()
Get the recipient of all messages.
public
getRecipient() : mixed
Return values
mixed —getWhitelist()
Get the whitelist.
public
getWhitelist() : array<string|int, mixed>
Return values
array<string|int, mixed> —sendPerformed()
Invoked immediately after the Message is sent.
public
sendPerformed(Swift_Events_SendEvent $evt) : mixed
Parameters
- $evt : Swift_Events_SendEvent
Return values
mixed —setRecipient()
Set the recipient of all messages.
public
setRecipient(mixed $recipient) : mixed
Parameters
- $recipient : mixed
Return values
mixed —setWhitelist()
Set a list of regular expressions to whitelist certain recipients.
public
setWhitelist(array<string|int, mixed> $whitelist) : mixed
Parameters
- $whitelist : array<string|int, mixed>
Return values
mixed —isWhitelisted()
Matches address against whitelist of regular expressions.
protected
isWhitelisted(mixed $recipient) : bool
Parameters
- $recipient : mixed
Return values
bool —filterHeaderSet()
Filter header set against a whitelist of regular expressions.
private
filterHeaderSet(Swift_Mime_SimpleHeaderSet $headerSet, string $type) : mixed
Parameters
- $headerSet : Swift_Mime_SimpleHeaderSet
- $type : string
Return values
mixed —filterNameAddresses()
Filtered list of addresses => name pairs.
private
filterNameAddresses(array<string|int, mixed> $recipients) : array<string|int, mixed>
Parameters
- $recipients : array<string|int, mixed>
Return values
array<string|int, mixed> —restoreMessage()
private
restoreMessage(Swift_Mime_SimpleMessage $message) : mixed
Parameters
- $message : Swift_Mime_SimpleMessage