Classes List

Swift_Plugins_RedirectingPlugin

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
 65 
 66 
 67 
 68 
 69 
 70 
 71 
 72 
 73 
 74 
 75 
 76 
 77 
 78 
 79 
 80 
 81 
 82 
 83 
 84 
 85 
 86 
 87 
 88 
 89 
 90 
 91 
 92 
 93 
 94 
 95 
 96 
 97 
 98 
 99 
 100 
 101 
 102 
 103 
 104 
 105 
 106 
 107 
 108 
 109 
 110 
 111 
 112 
 113 
 114 
 115 
 116 
 117 
 118 
 119 
 120 
 121 
 122 
 123 
 124 
 125 
 126 
 127 
 128 
 129 
 130 
 131 
 132 
 133 
 134 
 135 
 136 
 137 
 138 
 139 
 140 
 141 
 142 
 143 
 144 
 145 
 146 
 147 
 148 
 149 
 150 
 151 
 152 
 153 
 154 
 155 
 156 
 157 
 158 
 159 
 160 
 161 
 162 
 163 
 164 
 165 
 166 
 167 
 168 
 169 
 170 
 171 
 172 
 173 
 174 
 175 
 176 
 177 
 178 
 179 
 180 
 181 
 182 
 183 
 184 
 185 
 186 
 187 
 188 
 189 
 190 
 191 
 192 
 193 
 194 
 195 
 196 
 197 
 198 
 199 
 200 
 201 
 202 
<?php

/* * This file is part of SwiftMailer. * (c) 2009 Fabien Potencier * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */


/** * Redirects all email to a single recipient. * * @author Fabien Potencier */
class Swift_Plugins_RedirectingPlugin implements Swift_Events_SendListener
{
    /** * The recipient who will receive all messages. * * @var mixed */
    private $recipient;

    /** * List of regular expression for recipient whitelisting. * * @var array */
    private $whitelist = [];

    /** * Create a new RedirectingPlugin. * * @param mixed $recipient */
    public function __construct($recipientarray $whitelist = [])
    {
        $this->recipient = $recipient;
        $this->whitelist = $whitelist;
    }

    /** * Set the recipient of all messages. * * @param mixed $recipient */
    public function setRecipient($recipient)
    {
        $this->recipient = $recipient;
    }

    /** * Get the recipient of all messages. * * @return mixed */
    public function getRecipient()
    {
        return $this->recipient;
    }

    /** * Set a list of regular expressions to whitelist certain recipients. */
    public function setWhitelist(array $whitelist)
    {
        $this->whitelist = $whitelist;
    }

    /** * Get the whitelist. * * @return array */
    public function getWhitelist()
    {
        return $this->whitelist;
    }

    /** * Invoked immediately before the Message is sent. */
    public function beforeSendPerformed(Swift_Events_SendEvent $evt)
    {
        $message = $evt->getMessage();
        $headers = $message->getHeaders();

        // conditionally save current recipients

        if ($headers->has('to')) {
            $headers->addMailboxHeader('X-Swift-To'$message->getTo());
        }

        if ($headers->has('cc')) {
            $headers->addMailboxHeader('X-Swift-Cc'$message->getCc());
        }

        if ($headers->has('bcc')) {
            $headers->addMailboxHeader('X-Swift-Bcc'$message->getBcc());
        }

        // Filter remaining headers against whitelist
        $this->filterHeaderSet($headers'To');
        $this->filterHeaderSet($headers'Cc');
        $this->filterHeaderSet($headers'Bcc');

        // Add each hard coded recipient
        $to = $message->getTo();
        if (null === $to) {
            $to = [];
        }

        foreach ((array) $this->recipient as $recipient) {
            if (!array_key_exists($recipient$to)) {
                $message->addTo($recipient);
            }
        }
    }

    /** * Filter header set against a whitelist of regular expressions. * * @param string $type */
    private function filterHeaderSet(Swift_Mime_SimpleHeaderSet $headerSet$type)
    {
        foreach ($headerSet->getAll($typeas $headers) {
            $headers->setNameAddresses($this->filterNameAddresses($headers->getNameAddresses()));
        }
    }

    /** * Filtered list of addresses => name pairs. * * @return array */
    private function filterNameAddresses(array $recipients)
    {
        $filtered = [];

        foreach ($recipients as $address => $name) {
            if ($this->isWhitelisted($address)) {
                $filtered[$address] = $name;
            }
        }

        return $filtered;
    }

    /** * Matches address against whitelist of regular expressions. * * @return bool */
    protected function isWhitelisted($recipient)
    {
        if (in_array($recipient(array) $this->recipient)) {
            return true;
        }

        foreach ($this->whitelist as $pattern) {
            if (preg_match($pattern$recipient)) {
                return true;
            }
        }

        return false;
    }

    /** * Invoked immediately after the Message is sent. */
    public function sendPerformed(Swift_Events_SendEvent $evt)
    {
        $this->restoreMessage($evt->getMessage());
    }

    private function restoreMessage(Swift_Mime_SimpleMessage $message)
    {
        // restore original headers
        $headers = $message->getHeaders();

        if ($headers->has('X-Swift-To')) {
            $message->setTo($headers->get('X-Swift-To')->getNameAddresses());
            $headers->removeAll('X-Swift-To');
        } else {
            $message->setTo(null);
        }

        if ($headers->has('X-Swift-Cc')) {
            $message->setCc($headers->get('X-Swift-Cc')->getNameAddresses());
            $headers->removeAll('X-Swift-Cc');
        }

        if ($headers->has('X-Swift-Bcc')) {
            $message->setBcc($headers->get('X-Swift-Bcc')->getNameAddresses());
            $headers->removeAll('X-Swift-Bcc');
        }
    }
}