Classes List

Swift_Mime_SimpleHeaderFactory

 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 
<?php

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


use Egulias\EmailValidator\EmailValidator;

/** * Creates MIME headers. * * @author Chris Corbyn */
class Swift_Mime_SimpleHeaderFactory implements Swift_Mime_CharsetObserver
{
    /** The HeaderEncoder used by these headers */
    private $encoder;

    /** The Encoder used by parameters */
    private $paramEncoder;

    /** Strict EmailValidator */
    private $emailValidator;

    /** The charset of created Headers */
    private $charset;

    /** Swift_AddressEncoder */
    private $addressEncoder;

    /** * Creates a new SimpleHeaderFactory using $encoder and $paramEncoder. * * @param string|null $charset */
    public function __construct(Swift_Mime_HeaderEncoder $encoderSwift_Encoder $paramEncoderEmailValidator $emailValidator$charset = nullSwift_AddressEncoder $addressEncoder = null)
    {
        $this->encoder = $encoder;
        $this->paramEncoder = $paramEncoder;
        $this->emailValidator = $emailValidator;
        $this->charset = $charset;
        $this->addressEncoder = $addressEncoder ?? new Swift_AddressEncoder_IdnAddressEncoder();
    }

    /** * Create a new Mailbox Header with a list of $addresses. * * @param string $name * @param array|string|null $addresses * * @return Swift_Mime_Header */
    public function createMailboxHeader($name$addresses = null)
    {
        $header = new Swift_Mime_Headers_MailboxHeader($name$this->encoder$this->emailValidator$this->addressEncoder);
        if (isset($addresses)) {
            $header->setFieldBodyModel($addresses);
        }
        $this->setHeaderCharset($header);

        return $header;
    }

    /** * Create a new Date header using $dateTime. * * @param string $name * * @return Swift_Mime_Header */
    public function createDateHeader($nameDateTimeInterface $dateTime = null)
    {
        $header = new Swift_Mime_Headers_DateHeader($name);
        if (isset($dateTime)) {
            $header->setFieldBodyModel($dateTime);
        }
        $this->setHeaderCharset($header);

        return $header;
    }

    /** * Create a new basic text header with $name and $value. * * @param string $name * @param string $value * * @return Swift_Mime_Header */
    public function createTextHeader($name$value = null)
    {
        $header = new Swift_Mime_Headers_UnstructuredHeader($name$this->encoder);
        if (isset($value)) {
            $header->setFieldBodyModel($value);
        }
        $this->setHeaderCharset($header);

        return $header;
    }

    /** * Create a new ParameterizedHeader with $name, $value and $params. * * @param string $name * @param string $value * @param array $params * * @return Swift_Mime_Headers_ParameterizedHeader */
    public function createParameterizedHeader($name$value = null$params = [])
    {
        $header = new Swift_Mime_Headers_ParameterizedHeader($name$this->encoder, ('content-disposition' == strtolower($name)) ? $this->paramEncoder : null);
        if (isset($value)) {
            $header->setFieldBodyModel($value);
        }
        foreach ($params as $k => $v) {
            $header->setParameter($k$v);
        }
        $this->setHeaderCharset($header);

        return $header;
    }

    /** * Create a new ID header for Message-ID or Content-ID. * * @param string $name * @param string|array $ids * * @return Swift_Mime_Header */
    public function createIdHeader($name$ids = null)
    {
        $header = new Swift_Mime_Headers_IdentificationHeader($name$this->emailValidator);
        if (isset($ids)) {
            $header->setFieldBodyModel($ids);
        }
        $this->setHeaderCharset($header);

        return $header;
    }

    /** * Create a new Path header with an address (path) in it. * * @param string $name * @param string $path * * @return Swift_Mime_Header */
    public function createPathHeader($name$path = null)
    {
        $header = new Swift_Mime_Headers_PathHeader($name$this->emailValidator);
        if (isset($path)) {
            $header->setFieldBodyModel($path);
        }
        $this->setHeaderCharset($header);

        return $header;
    }

    /** * Notify this observer that the entity's charset has changed. * * @param string $charset */
    public function charsetChanged($charset)
    {
        $this->charset = $charset;
        $this->encoder->charsetChanged($charset);
        $this->paramEncoder->charsetChanged($charset);
    }

    /** * Make a deep copy of object. */
    public function __clone()
    {
        $this->encoder = clone $this->encoder;
        $this->paramEncoder = clone $this->paramEncoder;
    }

    /** Apply the charset to the Header */
    private function setHeaderCharset(Swift_Mime_Header $header)
    {
        if (isset($this->charset)) {
            $header->setCharset($this->charset);
        }
    }
}