first commit
This commit is contained in:
@ -0,0 +1,476 @@
|
||||
<?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.
|
||||
*/
|
||||
|
||||
/**
|
||||
* An abstract base MIME Header.
|
||||
*
|
||||
* @author Chris Corbyn
|
||||
*/
|
||||
abstract class Swift_Mime_Headers_AbstractHeader implements Swift_Mime_Header
|
||||
{
|
||||
const PHRASE_PATTERN = '(?:(?:(?:(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?(\((?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?\)))*(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?(\((?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?\)))|(?:(?:[ \t]*(?:\r\n))?[ \t])))?[a-zA-Z0-9!#\$%&\'\*\+\-\/=\?\^_`\{\}\|~]+(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?(\((?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?\)))*(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?(\((?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?\)))|(?:(?:[ \t]*(?:\r\n))?[ \t])))?)|(?:(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?(\((?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?\)))*(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?(\((?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?\)))|(?:(?:[ \t]*(?:\r\n))?[ \t])))?"((?:(?:[ \t]*(?:\r\n))?[ \t])?(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21\x23-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])))*(?:(?:[ \t]*(?:\r\n))?[ \t])?"(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?(\((?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?\)))*(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?(\((?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?\)))|(?:(?:[ \t]*(?:\r\n))?[ \t])))?))+?)';
|
||||
|
||||
/**
|
||||
* The name of this Header.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private $name;
|
||||
|
||||
/**
|
||||
* The Encoder used to encode this Header.
|
||||
*
|
||||
* @var Swift_Encoder
|
||||
*/
|
||||
private $encoder;
|
||||
|
||||
/**
|
||||
* The maximum length of a line in the header.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
private $lineLength = 78;
|
||||
|
||||
/**
|
||||
* The language used in this Header.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private $lang;
|
||||
|
||||
/**
|
||||
* The character set of the text in this Header.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private $charset = 'utf-8';
|
||||
|
||||
/**
|
||||
* The value of this Header, cached.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private $cachedValue = null;
|
||||
|
||||
/**
|
||||
* Set the character set used in this Header.
|
||||
*
|
||||
* @param string $charset
|
||||
*/
|
||||
public function setCharset($charset)
|
||||
{
|
||||
$this->clearCachedValueIf($charset != $this->charset);
|
||||
$this->charset = $charset;
|
||||
if (isset($this->encoder)) {
|
||||
$this->encoder->charsetChanged($charset);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the character set used in this Header.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getCharset()
|
||||
{
|
||||
return $this->charset;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the language used in this Header.
|
||||
*
|
||||
* For example, for US English, 'en-us'.
|
||||
* This can be unspecified.
|
||||
*
|
||||
* @param string $lang
|
||||
*/
|
||||
public function setLanguage($lang)
|
||||
{
|
||||
$this->clearCachedValueIf($this->lang != $lang);
|
||||
$this->lang = $lang;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the language used in this Header.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getLanguage()
|
||||
{
|
||||
return $this->lang;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the encoder used for encoding the header.
|
||||
*/
|
||||
public function setEncoder(Swift_Mime_HeaderEncoder $encoder)
|
||||
{
|
||||
$this->encoder = $encoder;
|
||||
$this->setCachedValue(null);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the encoder used for encoding this Header.
|
||||
*
|
||||
* @return Swift_Mime_HeaderEncoder
|
||||
*/
|
||||
public function getEncoder()
|
||||
{
|
||||
return $this->encoder;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the name of this header (e.g. charset).
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getFieldName()
|
||||
{
|
||||
return $this->name;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the maximum length of lines in the header (excluding EOL).
|
||||
*
|
||||
* @param int $lineLength
|
||||
*/
|
||||
public function setMaxLineLength($lineLength)
|
||||
{
|
||||
$this->clearCachedValueIf($this->lineLength != $lineLength);
|
||||
$this->lineLength = $lineLength;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the maximum permitted length of lines in this Header.
|
||||
*
|
||||
* @return int
|
||||
*/
|
||||
public function getMaxLineLength()
|
||||
{
|
||||
return $this->lineLength;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get this Header rendered as a RFC 2822 compliant string.
|
||||
*
|
||||
* @return string
|
||||
*
|
||||
* @throws Swift_RfcComplianceException
|
||||
*/
|
||||
public function toString()
|
||||
{
|
||||
return $this->tokensToString($this->toTokens());
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a string representation of this object.
|
||||
*
|
||||
* @return string
|
||||
*
|
||||
* @see toString()
|
||||
*/
|
||||
public function __toString()
|
||||
{
|
||||
return $this->toString();
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the name of this Header field.
|
||||
*
|
||||
* @param string $name
|
||||
*/
|
||||
protected function setFieldName($name)
|
||||
{
|
||||
$this->name = $name;
|
||||
}
|
||||
|
||||
/**
|
||||
* Produces a compliant, formatted RFC 2822 'phrase' based on the string given.
|
||||
*
|
||||
* @param string $string as displayed
|
||||
* @param string $charset of the text
|
||||
* @param bool $shorten the first line to make remove for header name
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
protected function createPhrase(Swift_Mime_Header $header, $string, $charset, Swift_Mime_HeaderEncoder $encoder = null, $shorten = false)
|
||||
{
|
||||
// Treat token as exactly what was given
|
||||
$phraseStr = $string;
|
||||
// If it's not valid
|
||||
|
||||
if (!preg_match('/^'.self::PHRASE_PATTERN.'$/D', $phraseStr)) {
|
||||
// .. but it is just ascii text, try escaping some characters
|
||||
// and make it a quoted-string
|
||||
if (preg_match('/^[\x00-\x08\x0B\x0C\x0E-\x7F]*$/D', $phraseStr)) {
|
||||
$phraseStr = $this->escapeSpecials($phraseStr, ['"']);
|
||||
$phraseStr = '"'.$phraseStr.'"';
|
||||
} else {
|
||||
// ... otherwise it needs encoding
|
||||
// Determine space remaining on line if first line
|
||||
if ($shorten) {
|
||||
$usedLength = \strlen($header->getFieldName().': ');
|
||||
} else {
|
||||
$usedLength = 0;
|
||||
}
|
||||
$phraseStr = $this->encodeWords($header, $string, $usedLength);
|
||||
}
|
||||
}
|
||||
|
||||
return $phraseStr;
|
||||
}
|
||||
|
||||
/**
|
||||
* Escape special characters in a string (convert to quoted-pairs).
|
||||
*
|
||||
* @param string $token
|
||||
* @param string[] $include additional chars to escape
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
private function escapeSpecials($token, $include = [])
|
||||
{
|
||||
foreach (array_merge(['\\'], $include) as $char) {
|
||||
$token = str_replace($char, '\\'.$char, $token);
|
||||
}
|
||||
|
||||
return $token;
|
||||
}
|
||||
|
||||
/**
|
||||
* Encode needed word tokens within a string of input.
|
||||
*
|
||||
* @param string $input
|
||||
* @param string $usedLength optional
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
protected function encodeWords(Swift_Mime_Header $header, $input, $usedLength = -1)
|
||||
{
|
||||
$value = '';
|
||||
|
||||
$tokens = $this->getEncodableWordTokens($input);
|
||||
|
||||
foreach ($tokens as $token) {
|
||||
// See RFC 2822, Sect 2.2 (really 2.2 ??)
|
||||
if ($this->tokenNeedsEncoding($token)) {
|
||||
// Don't encode starting WSP
|
||||
$firstChar = substr($token, 0, 1);
|
||||
switch ($firstChar) {
|
||||
case ' ':
|
||||
case "\t":
|
||||
$value .= $firstChar;
|
||||
$token = substr($token, 1);
|
||||
}
|
||||
|
||||
if (-1 == $usedLength) {
|
||||
$usedLength = \strlen($header->getFieldName().': ') + \strlen($value);
|
||||
}
|
||||
$value .= $this->getTokenAsEncodedWord($token, $usedLength);
|
||||
|
||||
$header->setMaxLineLength(76); // Forcefully override
|
||||
} else {
|
||||
$value .= $token;
|
||||
}
|
||||
}
|
||||
|
||||
return $value;
|
||||
}
|
||||
|
||||
/**
|
||||
* Test if a token needs to be encoded or not.
|
||||
*
|
||||
* @param string $token
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
protected function tokenNeedsEncoding($token)
|
||||
{
|
||||
return preg_match('~[\x00-\x08\x10-\x19\x7F-\xFF\r\n]~', $token);
|
||||
}
|
||||
|
||||
/**
|
||||
* Splits a string into tokens in blocks of words which can be encoded quickly.
|
||||
*
|
||||
* @param string $string
|
||||
*
|
||||
* @return string[]
|
||||
*/
|
||||
protected function getEncodableWordTokens($string)
|
||||
{
|
||||
$tokens = [];
|
||||
|
||||
$encodedToken = '';
|
||||
// Split at all whitespace boundaries
|
||||
foreach (preg_split('~(?=[\t ])~', $string) as $token) {
|
||||
if ($this->tokenNeedsEncoding($token)) {
|
||||
$encodedToken .= $token;
|
||||
} else {
|
||||
if (\strlen($encodedToken) > 0) {
|
||||
$tokens[] = $encodedToken;
|
||||
$encodedToken = '';
|
||||
}
|
||||
$tokens[] = $token;
|
||||
}
|
||||
}
|
||||
if (\strlen($encodedToken)) {
|
||||
$tokens[] = $encodedToken;
|
||||
}
|
||||
|
||||
return $tokens;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a token as an encoded word for safe insertion into headers.
|
||||
*
|
||||
* @param string $token token to encode
|
||||
* @param int $firstLineOffset optional
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
protected function getTokenAsEncodedWord($token, $firstLineOffset = 0)
|
||||
{
|
||||
// Adjust $firstLineOffset to account for space needed for syntax
|
||||
$charsetDecl = $this->charset;
|
||||
if (isset($this->lang)) {
|
||||
$charsetDecl .= '*'.$this->lang;
|
||||
}
|
||||
$encodingWrapperLength = \strlen(
|
||||
'=?'.$charsetDecl.'?'.$this->encoder->getName().'??='
|
||||
);
|
||||
|
||||
if ($firstLineOffset >= 75) {
|
||||
//Does this logic need to be here?
|
||||
$firstLineOffset = 0;
|
||||
}
|
||||
|
||||
$encodedTextLines = explode("\r\n",
|
||||
$this->encoder->encodeString(
|
||||
$token, $firstLineOffset, 75 - $encodingWrapperLength, $this->charset
|
||||
)
|
||||
);
|
||||
|
||||
if ('iso-2022-jp' !== strtolower($this->charset)) {
|
||||
// special encoding for iso-2022-jp using mb_encode_mimeheader
|
||||
foreach ($encodedTextLines as $lineNum => $line) {
|
||||
$encodedTextLines[$lineNum] = '=?'.$charsetDecl.
|
||||
'?'.$this->encoder->getName().
|
||||
'?'.$line.'?=';
|
||||
}
|
||||
}
|
||||
|
||||
return implode("\r\n ", $encodedTextLines);
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates tokens from the given string which include CRLF as individual tokens.
|
||||
*
|
||||
* @param string $token
|
||||
*
|
||||
* @return string[]
|
||||
*/
|
||||
protected function generateTokenLines($token)
|
||||
{
|
||||
return preg_split('~(\r\n)~', $token, -1, PREG_SPLIT_DELIM_CAPTURE);
|
||||
}
|
||||
|
||||
/**
|
||||
* Set a value into the cache.
|
||||
*
|
||||
* @param string $value
|
||||
*/
|
||||
protected function setCachedValue($value)
|
||||
{
|
||||
$this->cachedValue = $value;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the value in the cache.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
protected function getCachedValue()
|
||||
{
|
||||
return $this->cachedValue;
|
||||
}
|
||||
|
||||
/**
|
||||
* Clear the cached value if $condition is met.
|
||||
*
|
||||
* @param bool $condition
|
||||
*/
|
||||
protected function clearCachedValueIf($condition)
|
||||
{
|
||||
if ($condition) {
|
||||
$this->setCachedValue(null);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate a list of all tokens in the final header.
|
||||
*
|
||||
* @param string $string The string to tokenize
|
||||
*
|
||||
* @return array An array of tokens as strings
|
||||
*/
|
||||
protected function toTokens($string = null)
|
||||
{
|
||||
if (null === $string) {
|
||||
$string = $this->getFieldBody();
|
||||
}
|
||||
|
||||
$tokens = [];
|
||||
|
||||
// Generate atoms; split at all invisible boundaries followed by WSP
|
||||
foreach (preg_split('~(?=[ \t])~', $string) as $token) {
|
||||
$newTokens = $this->generateTokenLines($token);
|
||||
foreach ($newTokens as $newToken) {
|
||||
$tokens[] = $newToken;
|
||||
}
|
||||
}
|
||||
|
||||
return $tokens;
|
||||
}
|
||||
|
||||
/**
|
||||
* Takes an array of tokens which appear in the header and turns them into
|
||||
* an RFC 2822 compliant string, adding FWSP where needed.
|
||||
*
|
||||
* @param string[] $tokens
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
private function tokensToString(array $tokens)
|
||||
{
|
||||
$lineCount = 0;
|
||||
$headerLines = [];
|
||||
$headerLines[] = $this->name.': ';
|
||||
$currentLine = &$headerLines[$lineCount++];
|
||||
|
||||
// Build all tokens back into compliant header
|
||||
foreach ($tokens as $i => $token) {
|
||||
// Line longer than specified maximum or token was just a new line
|
||||
if (("\r\n" == $token) ||
|
||||
($i > 0 && \strlen($currentLine.$token) > $this->lineLength)
|
||||
&& 0 < \strlen($currentLine)) {
|
||||
$headerLines[] = '';
|
||||
$currentLine = &$headerLines[$lineCount++];
|
||||
}
|
||||
|
||||
// Append token to the line
|
||||
if ("\r\n" != $token) {
|
||||
$currentLine .= $token;
|
||||
}
|
||||
}
|
||||
|
||||
// Implode with FWS (RFC 2822, 2.2.3)
|
||||
return implode("\r\n", $headerLines)."\r\n";
|
||||
}
|
||||
}
|
@ -0,0 +1,113 @@
|
||||
<?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.
|
||||
*/
|
||||
|
||||
/**
|
||||
* A Date MIME Header for Swift Mailer.
|
||||
*
|
||||
* @author Chris Corbyn
|
||||
*/
|
||||
class Swift_Mime_Headers_DateHeader extends Swift_Mime_Headers_AbstractHeader
|
||||
{
|
||||
/**
|
||||
* Date-time value of this Header.
|
||||
*
|
||||
* @var DateTimeImmutable
|
||||
*/
|
||||
private $dateTime;
|
||||
|
||||
/**
|
||||
* Creates a new DateHeader with $name.
|
||||
*
|
||||
* @param string $name of Header
|
||||
*/
|
||||
public function __construct($name)
|
||||
{
|
||||
$this->setFieldName($name);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the type of Header that this instance represents.
|
||||
*
|
||||
* @see TYPE_TEXT, TYPE_PARAMETERIZED, TYPE_MAILBOX
|
||||
* @see TYPE_DATE, TYPE_ID, TYPE_PATH
|
||||
*
|
||||
* @return int
|
||||
*/
|
||||
public function getFieldType()
|
||||
{
|
||||
return self::TYPE_DATE;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the model for the field body.
|
||||
*
|
||||
* @param DateTimeInterface $model
|
||||
*/
|
||||
public function setFieldBodyModel($model)
|
||||
{
|
||||
$this->setDateTime($model);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the model for the field body.
|
||||
*
|
||||
* @return DateTimeImmutable
|
||||
*/
|
||||
public function getFieldBodyModel()
|
||||
{
|
||||
return $this->getDateTime();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the date-time representing the Date in this Header.
|
||||
*
|
||||
* @return DateTimeImmutable
|
||||
*/
|
||||
public function getDateTime()
|
||||
{
|
||||
return $this->dateTime;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the date-time of the Date in this Header.
|
||||
*
|
||||
* If a DateTime instance is provided, it is converted to DateTimeImmutable.
|
||||
*/
|
||||
public function setDateTime(DateTimeInterface $dateTime)
|
||||
{
|
||||
$this->clearCachedValueIf($this->getCachedValue() != $dateTime->format(DateTime::RFC2822));
|
||||
if ($dateTime instanceof DateTime) {
|
||||
$immutable = new DateTimeImmutable('@'.$dateTime->getTimestamp());
|
||||
$dateTime = $immutable->setTimezone($dateTime->getTimezone());
|
||||
}
|
||||
$this->dateTime = $dateTime;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the string value of the body in this Header.
|
||||
*
|
||||
* This is not necessarily RFC 2822 compliant since folding white space will
|
||||
* not be added at this stage (see {@link toString()} for that).
|
||||
*
|
||||
* @see toString()
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getFieldBody()
|
||||
{
|
||||
if (!$this->getCachedValue()) {
|
||||
if (isset($this->dateTime)) {
|
||||
$this->setCachedValue($this->dateTime->format(DateTime::RFC2822));
|
||||
}
|
||||
}
|
||||
|
||||
return $this->getCachedValue();
|
||||
}
|
||||
}
|
@ -0,0 +1,189 @@
|
||||
<?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;
|
||||
use Egulias\EmailValidator\Validation\MessageIDValidation;
|
||||
use Egulias\EmailValidator\Validation\RFCValidation;
|
||||
|
||||
/**
|
||||
* An ID MIME Header for something like Message-ID or Content-ID.
|
||||
*
|
||||
* @author Chris Corbyn
|
||||
*/
|
||||
class Swift_Mime_Headers_IdentificationHeader extends Swift_Mime_Headers_AbstractHeader
|
||||
{
|
||||
/**
|
||||
* The IDs used in the value of this Header.
|
||||
*
|
||||
* This may hold multiple IDs or just a single ID.
|
||||
*
|
||||
* @var string[]
|
||||
*/
|
||||
private $ids = [];
|
||||
|
||||
/**
|
||||
* The strict EmailValidator.
|
||||
*
|
||||
* @var EmailValidator
|
||||
*/
|
||||
private $emailValidator;
|
||||
|
||||
private $addressEncoder;
|
||||
|
||||
/**
|
||||
* Creates a new IdentificationHeader with the given $name and $id.
|
||||
*
|
||||
* @param string $name
|
||||
*/
|
||||
public function __construct($name, EmailValidator $emailValidator, Swift_AddressEncoder $addressEncoder = null)
|
||||
{
|
||||
$this->setFieldName($name);
|
||||
$this->emailValidator = $emailValidator;
|
||||
$this->addressEncoder = $addressEncoder ?? new Swift_AddressEncoder_IdnAddressEncoder();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the type of Header that this instance represents.
|
||||
*
|
||||
* @see TYPE_TEXT, TYPE_PARAMETERIZED, TYPE_MAILBOX
|
||||
* @see TYPE_DATE, TYPE_ID, TYPE_PATH
|
||||
*
|
||||
* @return int
|
||||
*/
|
||||
public function getFieldType()
|
||||
{
|
||||
return self::TYPE_ID;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the model for the field body.
|
||||
*
|
||||
* This method takes a string ID, or an array of IDs.
|
||||
*
|
||||
* @param mixed $model
|
||||
*
|
||||
* @throws Swift_RfcComplianceException
|
||||
*/
|
||||
public function setFieldBodyModel($model)
|
||||
{
|
||||
$this->setId($model);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the model for the field body.
|
||||
*
|
||||
* This method returns an array of IDs
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function getFieldBodyModel()
|
||||
{
|
||||
return $this->getIds();
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the ID used in the value of this header.
|
||||
*
|
||||
* @param string|array $id
|
||||
*
|
||||
* @throws Swift_RfcComplianceException
|
||||
*/
|
||||
public function setId($id)
|
||||
{
|
||||
$this->setIds(\is_array($id) ? $id : [$id]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the ID used in the value of this Header.
|
||||
*
|
||||
* If multiple IDs are set only the first is returned.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getId()
|
||||
{
|
||||
if (\count($this->ids) > 0) {
|
||||
return $this->ids[0];
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Set a collection of IDs to use in the value of this Header.
|
||||
*
|
||||
* @param string[] $ids
|
||||
*
|
||||
* @throws Swift_RfcComplianceException
|
||||
*/
|
||||
public function setIds(array $ids)
|
||||
{
|
||||
$actualIds = [];
|
||||
|
||||
foreach ($ids as $id) {
|
||||
$this->assertValidId($id);
|
||||
$actualIds[] = $id;
|
||||
}
|
||||
|
||||
$this->clearCachedValueIf($this->ids != $actualIds);
|
||||
$this->ids = $actualIds;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the list of IDs used in this Header.
|
||||
*
|
||||
* @return string[]
|
||||
*/
|
||||
public function getIds()
|
||||
{
|
||||
return $this->ids;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the string value of the body in this Header.
|
||||
*
|
||||
* This is not necessarily RFC 2822 compliant since folding white space will
|
||||
* not be added at this stage (see {@see toString()} for that).
|
||||
*
|
||||
* @see toString()
|
||||
*
|
||||
* @throws Swift_RfcComplianceException
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getFieldBody()
|
||||
{
|
||||
if (!$this->getCachedValue()) {
|
||||
$angleAddrs = [];
|
||||
|
||||
foreach ($this->ids as $id) {
|
||||
$angleAddrs[] = '<'.$this->addressEncoder->encodeString($id).'>';
|
||||
}
|
||||
|
||||
$this->setCachedValue(implode(' ', $angleAddrs));
|
||||
}
|
||||
|
||||
return $this->getCachedValue();
|
||||
}
|
||||
|
||||
/**
|
||||
* Throws an Exception if the id passed does not comply with RFC 2822.
|
||||
*
|
||||
* @param string $id
|
||||
*
|
||||
* @throws Swift_RfcComplianceException
|
||||
*/
|
||||
private function assertValidId($id)
|
||||
{
|
||||
$emailValidation = class_exists(MessageIDValidation::class) ? new MessageIDValidation() : new RFCValidation();
|
||||
|
||||
if (!$this->emailValidator->isValid($id, $emailValidation)) {
|
||||
throw new Swift_RfcComplianceException('Invalid ID given <'.$id.'>');
|
||||
}
|
||||
}
|
||||
}
|
@ -0,0 +1,358 @@
|
||||
<?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;
|
||||
use Egulias\EmailValidator\Validation\RFCValidation;
|
||||
|
||||
/**
|
||||
* A Mailbox Address MIME Header for something like From or Sender.
|
||||
*
|
||||
* @author Chris Corbyn
|
||||
*/
|
||||
class Swift_Mime_Headers_MailboxHeader extends Swift_Mime_Headers_AbstractHeader
|
||||
{
|
||||
/**
|
||||
* The mailboxes used in this Header.
|
||||
*
|
||||
* @var string[]
|
||||
*/
|
||||
private $mailboxes = [];
|
||||
|
||||
/**
|
||||
* The strict EmailValidator.
|
||||
*
|
||||
* @var EmailValidator
|
||||
*/
|
||||
private $emailValidator;
|
||||
|
||||
private $addressEncoder;
|
||||
|
||||
/**
|
||||
* Creates a new MailboxHeader with $name.
|
||||
*
|
||||
* @param string $name of Header
|
||||
*/
|
||||
public function __construct($name, Swift_Mime_HeaderEncoder $encoder, EmailValidator $emailValidator, Swift_AddressEncoder $addressEncoder = null)
|
||||
{
|
||||
$this->setFieldName($name);
|
||||
$this->setEncoder($encoder);
|
||||
$this->emailValidator = $emailValidator;
|
||||
$this->addressEncoder = $addressEncoder ?? new Swift_AddressEncoder_IdnAddressEncoder();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the type of Header that this instance represents.
|
||||
*
|
||||
* @see TYPE_TEXT, TYPE_PARAMETERIZED, TYPE_MAILBOX
|
||||
* @see TYPE_DATE, TYPE_ID, TYPE_PATH
|
||||
*
|
||||
* @return int
|
||||
*/
|
||||
public function getFieldType()
|
||||
{
|
||||
return self::TYPE_MAILBOX;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the model for the field body.
|
||||
*
|
||||
* This method takes a string, or an array of addresses.
|
||||
*
|
||||
* @param mixed $model
|
||||
*
|
||||
* @throws Swift_RfcComplianceException
|
||||
*/
|
||||
public function setFieldBodyModel($model)
|
||||
{
|
||||
$this->setNameAddresses($model);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the model for the field body.
|
||||
*
|
||||
* This method returns an associative array like {@link getNameAddresses()}
|
||||
*
|
||||
* @throws Swift_RfcComplianceException
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function getFieldBodyModel()
|
||||
{
|
||||
return $this->getNameAddresses();
|
||||
}
|
||||
|
||||
/**
|
||||
* Set a list of mailboxes to be shown in this Header.
|
||||
*
|
||||
* The mailboxes can be a simple array of addresses, or an array of
|
||||
* key=>value pairs where (email => personalName).
|
||||
* Example:
|
||||
* <code>
|
||||
* <?php
|
||||
* //Sets two mailboxes in the Header, one with a personal name
|
||||
* $header->setNameAddresses(array(
|
||||
* 'chris@swiftmailer.org' => 'Chris Corbyn',
|
||||
* 'mark@swiftmailer.org' //No associated personal name
|
||||
* ));
|
||||
* ?>
|
||||
* </code>
|
||||
*
|
||||
* @see __construct()
|
||||
* @see setAddresses()
|
||||
* @see setValue()
|
||||
*
|
||||
* @param string|string[] $mailboxes
|
||||
*
|
||||
* @throws Swift_RfcComplianceException
|
||||
*/
|
||||
public function setNameAddresses($mailboxes)
|
||||
{
|
||||
$this->mailboxes = $this->normalizeMailboxes((array) $mailboxes);
|
||||
$this->setCachedValue(null); //Clear any cached value
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the full mailbox list of this Header as an array of valid RFC 2822 strings.
|
||||
*
|
||||
* Example:
|
||||
* <code>
|
||||
* <?php
|
||||
* $header = new Swift_Mime_Headers_MailboxHeader('From',
|
||||
* array('chris@swiftmailer.org' => 'Chris Corbyn',
|
||||
* 'mark@swiftmailer.org' => 'Mark Corbyn')
|
||||
* );
|
||||
* print_r($header->getNameAddressStrings());
|
||||
* // array (
|
||||
* // 0 => Chris Corbyn <chris@swiftmailer.org>,
|
||||
* // 1 => Mark Corbyn <mark@swiftmailer.org>
|
||||
* // )
|
||||
* ?>
|
||||
* </code>
|
||||
*
|
||||
* @see getNameAddresses()
|
||||
* @see toString()
|
||||
*
|
||||
* @throws Swift_RfcComplianceException
|
||||
*
|
||||
* @return string[]
|
||||
*/
|
||||
public function getNameAddressStrings()
|
||||
{
|
||||
return $this->createNameAddressStrings($this->getNameAddresses());
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all mailboxes in this Header as key=>value pairs.
|
||||
*
|
||||
* The key is the address and the value is the name (or null if none set).
|
||||
* Example:
|
||||
* <code>
|
||||
* <?php
|
||||
* $header = new Swift_Mime_Headers_MailboxHeader('From',
|
||||
* array('chris@swiftmailer.org' => 'Chris Corbyn',
|
||||
* 'mark@swiftmailer.org' => 'Mark Corbyn')
|
||||
* );
|
||||
* print_r($header->getNameAddresses());
|
||||
* // array (
|
||||
* // chris@swiftmailer.org => Chris Corbyn,
|
||||
* // mark@swiftmailer.org => Mark Corbyn
|
||||
* // )
|
||||
* ?>
|
||||
* </code>
|
||||
*
|
||||
* @see getAddresses()
|
||||
* @see getNameAddressStrings()
|
||||
*
|
||||
* @return string[]
|
||||
*/
|
||||
public function getNameAddresses()
|
||||
{
|
||||
return $this->mailboxes;
|
||||
}
|
||||
|
||||
/**
|
||||
* Makes this Header represent a list of plain email addresses with no names.
|
||||
*
|
||||
* Example:
|
||||
* <code>
|
||||
* <?php
|
||||
* //Sets three email addresses as the Header data
|
||||
* $header->setAddresses(
|
||||
* array('one@domain.tld', 'two@domain.tld', 'three@domain.tld')
|
||||
* );
|
||||
* ?>
|
||||
* </code>
|
||||
*
|
||||
* @see setNameAddresses()
|
||||
* @see setValue()
|
||||
*
|
||||
* @param string[] $addresses
|
||||
*
|
||||
* @throws Swift_RfcComplianceException
|
||||
*/
|
||||
public function setAddresses($addresses)
|
||||
{
|
||||
$this->setNameAddresses(array_values((array) $addresses));
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all email addresses in this Header.
|
||||
*
|
||||
* @see getNameAddresses()
|
||||
*
|
||||
* @return string[]
|
||||
*/
|
||||
public function getAddresses()
|
||||
{
|
||||
return array_keys($this->mailboxes);
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove one or more addresses from this Header.
|
||||
*
|
||||
* @param string|string[] $addresses
|
||||
*/
|
||||
public function removeAddresses($addresses)
|
||||
{
|
||||
$this->setCachedValue(null);
|
||||
foreach ((array) $addresses as $address) {
|
||||
unset($this->mailboxes[$address]);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the string value of the body in this Header.
|
||||
*
|
||||
* This is not necessarily RFC 2822 compliant since folding white space will
|
||||
* not be added at this stage (see {@link toString()} for that).
|
||||
*
|
||||
* @see toString()
|
||||
*
|
||||
* @throws Swift_RfcComplianceException
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getFieldBody()
|
||||
{
|
||||
// Compute the string value of the header only if needed
|
||||
if (null === $this->getCachedValue()) {
|
||||
$this->setCachedValue($this->createMailboxListString($this->mailboxes));
|
||||
}
|
||||
|
||||
return $this->getCachedValue();
|
||||
}
|
||||
|
||||
/**
|
||||
* Normalizes a user-input list of mailboxes into consistent key=>value pairs.
|
||||
*
|
||||
* @param string[] $mailboxes
|
||||
*
|
||||
* @return string[]
|
||||
*/
|
||||
protected function normalizeMailboxes(array $mailboxes)
|
||||
{
|
||||
$actualMailboxes = [];
|
||||
|
||||
foreach ($mailboxes as $key => $value) {
|
||||
if (\is_string($key)) {
|
||||
//key is email addr
|
||||
$address = $key;
|
||||
$name = $value;
|
||||
} else {
|
||||
$address = $value;
|
||||
$name = null;
|
||||
}
|
||||
$this->assertValidAddress($address);
|
||||
$actualMailboxes[$address] = $name;
|
||||
}
|
||||
|
||||
return $actualMailboxes;
|
||||
}
|
||||
|
||||
/**
|
||||
* Produces a compliant, formatted display-name based on the string given.
|
||||
*
|
||||
* @param string $displayName as displayed
|
||||
* @param bool $shorten the first line to make remove for header name
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
protected function createDisplayNameString($displayName, $shorten = false)
|
||||
{
|
||||
return $this->createPhrase($this, $displayName, $this->getCharset(), $this->getEncoder(), $shorten);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a string form of all the mailboxes in the passed array.
|
||||
*
|
||||
* @param string[] $mailboxes
|
||||
*
|
||||
* @throws Swift_RfcComplianceException
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
protected function createMailboxListString(array $mailboxes)
|
||||
{
|
||||
return implode(', ', $this->createNameAddressStrings($mailboxes));
|
||||
}
|
||||
|
||||
/**
|
||||
* Redefine the encoding requirements for mailboxes.
|
||||
*
|
||||
* All "specials" must be encoded as the full header value will not be quoted
|
||||
*
|
||||
* @see RFC 2822 3.2.1
|
||||
*
|
||||
* @param string $token
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
protected function tokenNeedsEncoding($token)
|
||||
{
|
||||
return preg_match('/[()<>\[\]:;@\,."]/', $token) || parent::tokenNeedsEncoding($token);
|
||||
}
|
||||
|
||||
/**
|
||||
* Return an array of strings conforming the the name-addr spec of RFC 2822.
|
||||
*
|
||||
* @param string[] $mailboxes
|
||||
*
|
||||
* @return string[]
|
||||
*/
|
||||
private function createNameAddressStrings(array $mailboxes)
|
||||
{
|
||||
$strings = [];
|
||||
|
||||
foreach ($mailboxes as $email => $name) {
|
||||
$mailboxStr = $this->addressEncoder->encodeString($email);
|
||||
if (null !== $name) {
|
||||
$nameStr = $this->createDisplayNameString($name, empty($strings));
|
||||
$mailboxStr = $nameStr.' <'.$mailboxStr.'>';
|
||||
}
|
||||
$strings[] = $mailboxStr;
|
||||
}
|
||||
|
||||
return $strings;
|
||||
}
|
||||
|
||||
/**
|
||||
* Throws an Exception if the address passed does not comply with RFC 2822.
|
||||
*
|
||||
* @param string $address
|
||||
*
|
||||
* @throws Swift_RfcComplianceException if invalid
|
||||
*/
|
||||
private function assertValidAddress($address)
|
||||
{
|
||||
if (!$this->emailValidator->isValid($address, new RFCValidation())) {
|
||||
throw new Swift_RfcComplianceException('Address in mailbox given ['.$address.'] does not comply with RFC 2822, 3.6.2.');
|
||||
}
|
||||
}
|
||||
}
|
@ -0,0 +1,135 @@
|
||||
<?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.
|
||||
*/
|
||||
|
||||
/**
|
||||
* An OpenDKIM Specific Header using only raw header datas without encoding.
|
||||
*
|
||||
* @author De Cock Xavier <xdecock@gmail.com>
|
||||
*
|
||||
* @deprecated since SwiftMailer 6.1.0; use Swift_Signers_DKIMSigner instead.
|
||||
*/
|
||||
class Swift_Mime_Headers_OpenDKIMHeader implements Swift_Mime_Header
|
||||
{
|
||||
/**
|
||||
* The value of this Header.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private $value;
|
||||
|
||||
/**
|
||||
* The name of this Header.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private $fieldName;
|
||||
|
||||
/**
|
||||
* @param string $name
|
||||
*/
|
||||
public function __construct($name)
|
||||
{
|
||||
$this->fieldName = $name;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the type of Header that this instance represents.
|
||||
*
|
||||
* @see TYPE_TEXT, TYPE_PARAMETERIZED, TYPE_MAILBOX
|
||||
* @see TYPE_DATE, TYPE_ID, TYPE_PATH
|
||||
*
|
||||
* @return int
|
||||
*/
|
||||
public function getFieldType()
|
||||
{
|
||||
return self::TYPE_TEXT;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the model for the field body.
|
||||
*
|
||||
* This method takes a string for the field value.
|
||||
*
|
||||
* @param string $model
|
||||
*/
|
||||
public function setFieldBodyModel($model)
|
||||
{
|
||||
$this->setValue($model);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the model for the field body.
|
||||
*
|
||||
* This method returns a string.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getFieldBodyModel()
|
||||
{
|
||||
return $this->getValue();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the (unencoded) value of this header.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getValue()
|
||||
{
|
||||
return $this->value;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the (unencoded) value of this header.
|
||||
*
|
||||
* @param string $value
|
||||
*/
|
||||
public function setValue($value)
|
||||
{
|
||||
$this->value = $value;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the value of this header prepared for rendering.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getFieldBody()
|
||||
{
|
||||
return $this->value;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get this Header rendered as a RFC 2822 compliant string.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function toString()
|
||||
{
|
||||
return $this->fieldName.': '.$this->value."\r\n";
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the Header FieldName.
|
||||
*
|
||||
* @see Swift_Mime_Header::getFieldName()
|
||||
*/
|
||||
public function getFieldName()
|
||||
{
|
||||
return $this->fieldName;
|
||||
}
|
||||
|
||||
/**
|
||||
* Ignored.
|
||||
*/
|
||||
public function setCharset($charset)
|
||||
{
|
||||
}
|
||||
}
|
@ -0,0 +1,255 @@
|
||||
<?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.
|
||||
*/
|
||||
|
||||
/**
|
||||
* An abstract base MIME Header.
|
||||
*
|
||||
* @author Chris Corbyn
|
||||
*/
|
||||
class Swift_Mime_Headers_ParameterizedHeader extends Swift_Mime_Headers_UnstructuredHeader
|
||||
{
|
||||
/**
|
||||
* RFC 2231's definition of a token.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
const TOKEN_REGEX = '(?:[\x21\x23-\x27\x2A\x2B\x2D\x2E\x30-\x39\x41-\x5A\x5E-\x7E]+)';
|
||||
|
||||
/**
|
||||
* The Encoder used to encode the parameters.
|
||||
*
|
||||
* @var Swift_Encoder
|
||||
*/
|
||||
private $paramEncoder;
|
||||
|
||||
/**
|
||||
* The parameters as an associative array.
|
||||
*
|
||||
* @var string[]
|
||||
*/
|
||||
private $params = [];
|
||||
|
||||
/**
|
||||
* Creates a new ParameterizedHeader with $name.
|
||||
*
|
||||
* @param string $name
|
||||
*/
|
||||
public function __construct($name, Swift_Mime_HeaderEncoder $encoder, Swift_Encoder $paramEncoder = null)
|
||||
{
|
||||
parent::__construct($name, $encoder);
|
||||
$this->paramEncoder = $paramEncoder;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the type of Header that this instance represents.
|
||||
*
|
||||
* @see TYPE_TEXT, TYPE_PARAMETERIZED, TYPE_MAILBOX
|
||||
* @see TYPE_DATE, TYPE_ID, TYPE_PATH
|
||||
*
|
||||
* @return int
|
||||
*/
|
||||
public function getFieldType()
|
||||
{
|
||||
return self::TYPE_PARAMETERIZED;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the character set used in this Header.
|
||||
*
|
||||
* @param string $charset
|
||||
*/
|
||||
public function setCharset($charset)
|
||||
{
|
||||
parent::setCharset($charset);
|
||||
if (isset($this->paramEncoder)) {
|
||||
$this->paramEncoder->charsetChanged($charset);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the value of $parameter.
|
||||
*
|
||||
* @param string $parameter
|
||||
* @param string $value
|
||||
*/
|
||||
public function setParameter($parameter, $value)
|
||||
{
|
||||
$this->setParameters(array_merge($this->getParameters(), [$parameter => $value]));
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the value of $parameter.
|
||||
*
|
||||
* @param string $parameter
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getParameter($parameter)
|
||||
{
|
||||
$params = $this->getParameters();
|
||||
|
||||
return $params[$parameter] ?? null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set an associative array of parameter names mapped to values.
|
||||
*
|
||||
* @param string[] $parameters
|
||||
*/
|
||||
public function setParameters(array $parameters)
|
||||
{
|
||||
$this->clearCachedValueIf($this->params != $parameters);
|
||||
$this->params = $parameters;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an associative array of parameter names mapped to values.
|
||||
*
|
||||
* @return string[]
|
||||
*/
|
||||
public function getParameters()
|
||||
{
|
||||
return $this->params;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the value of this header prepared for rendering.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getFieldBody() //TODO: Check caching here
|
||||
{
|
||||
$body = parent::getFieldBody();
|
||||
foreach ($this->params as $name => $value) {
|
||||
if (null !== $value) {
|
||||
// Add the parameter
|
||||
$body .= '; '.$this->createParameter($name, $value);
|
||||
}
|
||||
}
|
||||
|
||||
return $body;
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate a list of all tokens in the final header.
|
||||
*
|
||||
* This doesn't need to be overridden in theory, but it is for implementation
|
||||
* reasons to prevent potential breakage of attributes.
|
||||
*
|
||||
* @param string $string The string to tokenize
|
||||
*
|
||||
* @return array An array of tokens as strings
|
||||
*/
|
||||
protected function toTokens($string = null)
|
||||
{
|
||||
$tokens = parent::toTokens(parent::getFieldBody());
|
||||
|
||||
// Try creating any parameters
|
||||
foreach ($this->params as $name => $value) {
|
||||
if (null !== $value) {
|
||||
// Add the semi-colon separator
|
||||
$tokens[\count($tokens) - 1] .= ';';
|
||||
$tokens = array_merge($tokens, $this->generateTokenLines(
|
||||
' '.$this->createParameter($name, $value)
|
||||
));
|
||||
}
|
||||
}
|
||||
|
||||
return $tokens;
|
||||
}
|
||||
|
||||
/**
|
||||
* Render a RFC 2047 compliant header parameter from the $name and $value.
|
||||
*
|
||||
* @param string $name
|
||||
* @param string $value
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
private function createParameter($name, $value)
|
||||
{
|
||||
$origValue = $value;
|
||||
|
||||
$encoded = false;
|
||||
// Allow room for parameter name, indices, "=" and DQUOTEs
|
||||
$maxValueLength = $this->getMaxLineLength() - \strlen($name.'=*N"";') - 1;
|
||||
$firstLineOffset = 0;
|
||||
|
||||
// If it's not already a valid parameter value...
|
||||
if (!preg_match('/^'.self::TOKEN_REGEX.'$/D', $value)) {
|
||||
// TODO: text, or something else??
|
||||
// ... and it's not ascii
|
||||
if (!preg_match('/^[\x00-\x08\x0B\x0C\x0E-\x7F]*$/D', $value)) {
|
||||
$encoded = true;
|
||||
// Allow space for the indices, charset and language
|
||||
$maxValueLength = $this->getMaxLineLength() - \strlen($name.'*N*="";') - 1;
|
||||
$firstLineOffset = \strlen(
|
||||
$this->getCharset()."'".$this->getLanguage()."'"
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
// Encode if we need to
|
||||
if ($encoded || \strlen($value) > $maxValueLength) {
|
||||
if (isset($this->paramEncoder)) {
|
||||
$value = $this->paramEncoder->encodeString(
|
||||
$origValue, $firstLineOffset, $maxValueLength, $this->getCharset()
|
||||
);
|
||||
} else {
|
||||
// We have to go against RFC 2183/2231 in some areas for interoperability
|
||||
$value = $this->getTokenAsEncodedWord($origValue);
|
||||
$encoded = false;
|
||||
}
|
||||
}
|
||||
|
||||
$valueLines = isset($this->paramEncoder) ? explode("\r\n", $value) : [$value];
|
||||
|
||||
// Need to add indices
|
||||
if (\count($valueLines) > 1) {
|
||||
$paramLines = [];
|
||||
foreach ($valueLines as $i => $line) {
|
||||
$paramLines[] = $name.'*'.$i.
|
||||
$this->getEndOfParameterValue($line, true, 0 == $i);
|
||||
}
|
||||
|
||||
return implode(";\r\n ", $paramLines);
|
||||
} else {
|
||||
return $name.$this->getEndOfParameterValue(
|
||||
$valueLines[0], $encoded, true
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the parameter value from the "=" and beyond.
|
||||
*
|
||||
* @param string $value to append
|
||||
* @param bool $encoded
|
||||
* @param bool $firstLine
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
private function getEndOfParameterValue($value, $encoded = false, $firstLine = false)
|
||||
{
|
||||
if (!preg_match('/^'.self::TOKEN_REGEX.'$/D', $value)) {
|
||||
$value = '"'.$value.'"';
|
||||
}
|
||||
$prepend = '=';
|
||||
if ($encoded) {
|
||||
$prepend = '*=';
|
||||
if ($firstLine) {
|
||||
$prepend = '*='.$this->getCharset()."'".$this->getLanguage().
|
||||
"'";
|
||||
}
|
||||
}
|
||||
|
||||
return $prepend.$value;
|
||||
}
|
||||
}
|
@ -0,0 +1,153 @@
|
||||
<?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;
|
||||
use Egulias\EmailValidator\Validation\RFCValidation;
|
||||
|
||||
/**
|
||||
* A Path Header in Swift Mailer, such a Return-Path.
|
||||
*
|
||||
* @author Chris Corbyn
|
||||
*/
|
||||
class Swift_Mime_Headers_PathHeader extends Swift_Mime_Headers_AbstractHeader
|
||||
{
|
||||
/**
|
||||
* The address in this Header (if specified).
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private $address;
|
||||
|
||||
/**
|
||||
* The strict EmailValidator.
|
||||
*
|
||||
* @var EmailValidator
|
||||
*/
|
||||
private $emailValidator;
|
||||
|
||||
private $addressEncoder;
|
||||
|
||||
/**
|
||||
* Creates a new PathHeader with the given $name.
|
||||
*
|
||||
* @param string $name
|
||||
*/
|
||||
public function __construct($name, EmailValidator $emailValidator, Swift_AddressEncoder $addressEncoder = null)
|
||||
{
|
||||
$this->setFieldName($name);
|
||||
$this->emailValidator = $emailValidator;
|
||||
$this->addressEncoder = $addressEncoder ?? new Swift_AddressEncoder_IdnAddressEncoder();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the type of Header that this instance represents.
|
||||
*
|
||||
* @see TYPE_TEXT, TYPE_PARAMETERIZED, TYPE_MAILBOX
|
||||
* @see TYPE_DATE, TYPE_ID, TYPE_PATH
|
||||
*
|
||||
* @return int
|
||||
*/
|
||||
public function getFieldType()
|
||||
{
|
||||
return self::TYPE_PATH;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the model for the field body.
|
||||
* This method takes a string for an address.
|
||||
*
|
||||
* @param string $model
|
||||
*
|
||||
* @throws Swift_RfcComplianceException
|
||||
*/
|
||||
public function setFieldBodyModel($model)
|
||||
{
|
||||
$this->setAddress($model);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the model for the field body.
|
||||
* This method returns a string email address.
|
||||
*
|
||||
* @return mixed
|
||||
*/
|
||||
public function getFieldBodyModel()
|
||||
{
|
||||
return $this->getAddress();
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the Address which should appear in this Header.
|
||||
*
|
||||
* @param string $address
|
||||
*
|
||||
* @throws Swift_RfcComplianceException
|
||||
*/
|
||||
public function setAddress($address)
|
||||
{
|
||||
if (null === $address) {
|
||||
$this->address = null;
|
||||
} elseif ('' == $address) {
|
||||
$this->address = '';
|
||||
} else {
|
||||
$this->assertValidAddress($address);
|
||||
$this->address = $address;
|
||||
}
|
||||
$this->setCachedValue(null);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the address which is used in this Header (if any).
|
||||
*
|
||||
* Null is returned if no address is set.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getAddress()
|
||||
{
|
||||
return $this->address;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the string value of the body in this Header.
|
||||
*
|
||||
* This is not necessarily RFC 2822 compliant since folding white space will
|
||||
* not be added at this stage (see {@link toString()} for that).
|
||||
*
|
||||
* @see toString()
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getFieldBody()
|
||||
{
|
||||
if (!$this->getCachedValue()) {
|
||||
if (isset($this->address)) {
|
||||
$address = $this->addressEncoder->encodeString($this->address);
|
||||
$this->setCachedValue('<'.$address.'>');
|
||||
}
|
||||
}
|
||||
|
||||
return $this->getCachedValue();
|
||||
}
|
||||
|
||||
/**
|
||||
* Throws an Exception if the address passed does not comply with RFC 2822.
|
||||
*
|
||||
* @param string $address
|
||||
*
|
||||
* @throws Swift_RfcComplianceException If address is invalid
|
||||
*/
|
||||
private function assertValidAddress($address)
|
||||
{
|
||||
if (!$this->emailValidator->isValid($address, new RFCValidation())) {
|
||||
throw new Swift_RfcComplianceException('Address set in PathHeader does not comply with addr-spec of RFC 2822.');
|
||||
}
|
||||
}
|
||||
}
|
@ -0,0 +1,109 @@
|
||||
<?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.
|
||||
*/
|
||||
|
||||
/**
|
||||
* A Simple MIME Header.
|
||||
*
|
||||
* @author Chris Corbyn
|
||||
*/
|
||||
class Swift_Mime_Headers_UnstructuredHeader extends Swift_Mime_Headers_AbstractHeader
|
||||
{
|
||||
/**
|
||||
* The value of this Header.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private $value;
|
||||
|
||||
/**
|
||||
* Creates a new SimpleHeader with $name.
|
||||
*
|
||||
* @param string $name
|
||||
*/
|
||||
public function __construct($name, Swift_Mime_HeaderEncoder $encoder)
|
||||
{
|
||||
$this->setFieldName($name);
|
||||
$this->setEncoder($encoder);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the type of Header that this instance represents.
|
||||
*
|
||||
* @see TYPE_TEXT, TYPE_PARAMETERIZED, TYPE_MAILBOX
|
||||
* @see TYPE_DATE, TYPE_ID, TYPE_PATH
|
||||
*
|
||||
* @return int
|
||||
*/
|
||||
public function getFieldType()
|
||||
{
|
||||
return self::TYPE_TEXT;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the model for the field body.
|
||||
*
|
||||
* This method takes a string for the field value.
|
||||
*
|
||||
* @param string $model
|
||||
*/
|
||||
public function setFieldBodyModel($model)
|
||||
{
|
||||
$this->setValue($model);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the model for the field body.
|
||||
*
|
||||
* This method returns a string.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getFieldBodyModel()
|
||||
{
|
||||
return $this->getValue();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the (unencoded) value of this header.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getValue()
|
||||
{
|
||||
return $this->value;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the (unencoded) value of this header.
|
||||
*
|
||||
* @param string $value
|
||||
*/
|
||||
public function setValue($value)
|
||||
{
|
||||
$this->clearCachedValueIf($this->value != $value);
|
||||
$this->value = $value;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the value of this header prepared for rendering.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getFieldBody()
|
||||
{
|
||||
if (!$this->getCachedValue()) {
|
||||
$this->setCachedValue(
|
||||
$this->encodeWords($this, $this->value)
|
||||
);
|
||||
}
|
||||
|
||||
return $this->getCachedValue();
|
||||
}
|
||||
}
|
Reference in New Issue
Block a user