mirror of
https://github.com/the-djmaze/snappymail.git
synced 2025-01-11 01:07:39 +08:00
362 lines
7.6 KiB
PHP
362 lines
7.6 KiB
PHP
<?php
|
|
|
|
namespace MailSo\Mime;
|
|
|
|
/**
|
|
* @category MailSo
|
|
* @package Mime
|
|
*/
|
|
class HeaderCollection extends \MailSo\Base\Collection
|
|
{
|
|
/**
|
|
* @return string
|
|
*/
|
|
protected $sRawHeaders;
|
|
|
|
/**
|
|
* @var strign
|
|
*/
|
|
protected $sParentCharset;
|
|
|
|
/**
|
|
* @access protected
|
|
*
|
|
* @param string $sRawHeaders = ''
|
|
* @param bool $bStoreRawHeaders = true
|
|
*/
|
|
protected function __construct($sRawHeaders = '', $bStoreRawHeaders = true)
|
|
{
|
|
parent::__construct();
|
|
|
|
$this->sRawHeaders = '';
|
|
$this->sParentCharset = \MailSo\Base\Enumerations\Charset::ISO_8859_1;
|
|
|
|
if (0 < \strlen($sRawHeaders))
|
|
{
|
|
$this->Parse($sRawHeaders, $bStoreRawHeaders);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param string $sRawHeaders = ''
|
|
* @param bool $bStoreRawHeaders = true
|
|
*
|
|
* @return \MailSo\Mime\HeaderCollection
|
|
*/
|
|
public static function NewInstance($sRawHeaders = '', $bStoreRawHeaders = true)
|
|
{
|
|
return new self($sRawHeaders, $bStoreRawHeaders);
|
|
}
|
|
|
|
/**
|
|
* @param string $sName
|
|
* @param string $sValue
|
|
* @param bool $bToTop = false
|
|
*
|
|
* @return \MailSo\Mime\HeaderCollection
|
|
*
|
|
* @throws \MailSo\Base\Exceptions\InvalidArgumentException
|
|
*/
|
|
public function AddByName($sName, $sValue, $bToTop = false)
|
|
{
|
|
return $this->Add(Header::NewInstance($sName, $sValue), $bToTop);
|
|
}
|
|
|
|
/**
|
|
* @param string $sName
|
|
* @param string $sValue
|
|
* @param bool $bToTop = false
|
|
*
|
|
* @return \MailSo\Mime\HeaderCollection
|
|
*
|
|
* @throws \MailSo\Base\Exceptions\InvalidArgumentException
|
|
*/
|
|
public function SetByName($sName, $sValue, $bToTop = false)
|
|
{
|
|
return $this->RemoveByName($sName)->Add(Header::NewInstance($sName, $sValue), $bToTop);
|
|
}
|
|
|
|
/**
|
|
* @return \MailSo\Mime\Header | null
|
|
*/
|
|
public function &GetByIndex($iIndex)
|
|
{
|
|
$mResult = null;
|
|
$mResult =& parent::GetByIndex($iIndex);
|
|
return $mResult;
|
|
}
|
|
|
|
/**
|
|
* @param string $sHeaderName
|
|
* @param bool $bCharsetAutoDetect = false
|
|
* @return string
|
|
*/
|
|
public function ValueByName($sHeaderName, $bCharsetAutoDetect = false)
|
|
{
|
|
$oHeader = null;
|
|
$oHeader =& $this->GetByName($sHeaderName);
|
|
return (null !== $oHeader) ? ($bCharsetAutoDetect ? $oHeader->ValueWithCharsetAutoDetect() : $oHeader->Value()) : '';
|
|
}
|
|
|
|
/**
|
|
* @param string $sHeaderName
|
|
* @param bool $bCharsetAutoDetect = false
|
|
* @return array
|
|
*/
|
|
public function ValuesByName($sHeaderName, $bCharsetAutoDetect = false)
|
|
{
|
|
$aResult = array();
|
|
$oHeader = null;
|
|
|
|
$sHeaderNameLower = \strtolower($sHeaderName);
|
|
$aHeaders =& $this->GetAsArray();
|
|
foreach ($aHeaders as /* @var $oHeader \MailSo\Mime\Header */ &$oHeader)
|
|
{
|
|
if ($sHeaderNameLower === \strtolower($oHeader->Name()))
|
|
{
|
|
$aResult[] = $bCharsetAutoDetect ? $oHeader->ValueWithCharsetAutoDetect() : $oHeader->Value();
|
|
}
|
|
}
|
|
|
|
return $aResult;
|
|
}
|
|
|
|
/**
|
|
* @param string $sHeaderName
|
|
*
|
|
* @return \MailSo\Mime\HeaderCollection
|
|
*/
|
|
public function RemoveByName($sHeaderName)
|
|
{
|
|
$aResult = $this->FilterList(function ($oHeader) use ($sHeaderName) {
|
|
return $oHeader && \strtolower($oHeader->Name()) !== \strtolower($sHeaderName);
|
|
});
|
|
|
|
return $this->SetAsArray($aResult);
|
|
}
|
|
|
|
/**
|
|
* @param string $sHeaderName
|
|
* @param bool $bCharsetAutoDetect = false
|
|
* @return string
|
|
*/
|
|
public function GetAsEmailCollection($sHeaderName, $bCharsetAutoDetect = false)
|
|
{
|
|
$oResult = null;
|
|
$sValue = $this->ValueByName($sHeaderName, $bCharsetAutoDetect);
|
|
if (0 < \strlen($sValue))
|
|
{
|
|
$oResult = \MailSo\Mime\EmailCollection::NewInstance($sValue);
|
|
}
|
|
|
|
return $oResult && 0 < $oResult->Count() ? $oResult : null;
|
|
}
|
|
|
|
/**
|
|
* @param string $sHeaderName
|
|
* @return \MailSo\Mime\ParameterCollection | null
|
|
*/
|
|
public function ParametersByName($sHeaderName)
|
|
{
|
|
$oParameters = $oHeader = null;
|
|
$oHeader =& $this->GetByName($sHeaderName);
|
|
if ($oHeader)
|
|
{
|
|
$oParameters = $oHeader->Parameters();
|
|
}
|
|
|
|
return $oParameters;
|
|
}
|
|
|
|
/**
|
|
* @param string $sHeaderName
|
|
* @param string $sParamName
|
|
* @return string
|
|
*/
|
|
public function ParameterValue($sHeaderName, $sParamName)
|
|
{
|
|
$oParameters = $this->ParametersByName($sHeaderName);
|
|
return (null !== $oParameters) ? $oParameters->ParameterValueByName($sParamName) : '';
|
|
}
|
|
|
|
/**
|
|
* @param string $sHeaderName
|
|
* @return \MailSo\Mime\Header | false
|
|
*/
|
|
public function &GetByName($sHeaderName)
|
|
{
|
|
$oResult = $oHeader = null;
|
|
|
|
$sHeaderNameLower = \strtolower($sHeaderName);
|
|
$aHeaders =& $this->GetAsArray();
|
|
foreach ($aHeaders as /* @var $oHeader \MailSo\Mime\Header */ &$oHeader)
|
|
{
|
|
if ($sHeaderNameLower === \strtolower($oHeader->Name()))
|
|
{
|
|
$oResult =& $oHeader;
|
|
break;
|
|
}
|
|
}
|
|
|
|
return $oResult;
|
|
}
|
|
|
|
/**
|
|
* @param array $aList
|
|
* @return \MailSo\Mime\HeaderCollection
|
|
*
|
|
* @throws \MailSo\Base\Exceptions\InvalidArgumentException
|
|
*/
|
|
public function SetAsArray($aList)
|
|
{
|
|
parent::SetAsArray($aList);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @param string $sParentCharset
|
|
* @return \MailSo\Mime\HeaderCollection
|
|
*/
|
|
public function SetParentCharset($sParentCharset)
|
|
{
|
|
if (0 < \strlen($sParentCharset))
|
|
{
|
|
if ($this->sParentCharset !== $sParentCharset)
|
|
{
|
|
$oHeader = null;
|
|
$aHeaders =& $this->GetAsArray();
|
|
|
|
foreach ($aHeaders as /* @var $oHeader \MailSo\Mime\Header */ &$oHeader)
|
|
{
|
|
$oHeader->SetParentCharset($sParentCharset);
|
|
}
|
|
|
|
$this->sParentCharset = $sParentCharset;
|
|
}
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @return void
|
|
*/
|
|
public function Clear()
|
|
{
|
|
parent::Clear();
|
|
|
|
$this->sRawHeaders = '';
|
|
}
|
|
|
|
/**
|
|
* @param string $sRawHeaders
|
|
* @param bool $bStoreRawHeaders = false
|
|
* @param string $sParentCharset = ''
|
|
*
|
|
* @return \MailSo\Mime\HeaderCollection
|
|
*/
|
|
public function Parse($sRawHeaders, $bStoreRawHeaders = false, $sParentCharset = '')
|
|
{
|
|
$this->Clear();
|
|
|
|
if ($bStoreRawHeaders)
|
|
{
|
|
$this->sRawHeaders = $sRawHeaders;
|
|
}
|
|
|
|
if (0 === \strlen($this->sParentCharset))
|
|
{
|
|
$this->sParentCharset = $sParentCharset;
|
|
}
|
|
|
|
$aHeaders = \explode("\n", \str_replace("\r", '', $sRawHeaders));
|
|
|
|
$sName = null;
|
|
$sValue = null;
|
|
foreach ($aHeaders as $sHeadersValue)
|
|
{
|
|
if (0 === strlen($sHeadersValue))
|
|
{
|
|
continue;
|
|
}
|
|
|
|
$sFirstChar = \substr($sHeadersValue, 0, 1);
|
|
if ($sFirstChar !== ' ' && $sFirstChar !== "\t" && false === \strpos($sHeadersValue, ':'))
|
|
{
|
|
continue;
|
|
}
|
|
else if (null !== $sName && ($sFirstChar === ' ' || $sFirstChar === "\t"))
|
|
{
|
|
$sValue = \is_null($sValue) ? '' : $sValue;
|
|
|
|
if ('?=' === \substr(\rtrim($sHeadersValue), -2))
|
|
{
|
|
$sHeadersValue = \rtrim($sHeadersValue);
|
|
}
|
|
|
|
if ('=?' === \substr(\ltrim($sHeadersValue), 0, 2))
|
|
{
|
|
$sHeadersValue = \ltrim($sHeadersValue);
|
|
}
|
|
|
|
if ('=?' === \substr($sHeadersValue, 0, 2))
|
|
{
|
|
$sValue .= $sHeadersValue;
|
|
}
|
|
else
|
|
{
|
|
$sValue .= "\n".$sHeadersValue;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
if (null !== $sName)
|
|
{
|
|
$oHeader = Header::NewInstanceFromEncodedString($sName.': '.$sValue, $this->sParentCharset);
|
|
if ($oHeader)
|
|
{
|
|
$this->Add($oHeader);
|
|
}
|
|
$sName = null;
|
|
$sValue = null;
|
|
}
|
|
|
|
$aHeaderParts = \explode(':', $sHeadersValue, 2);
|
|
$sName = $aHeaderParts[0];
|
|
$sValue = isset($aHeaderParts[1]) ? $aHeaderParts[1] : '';
|
|
|
|
if ('?=' === \substr(\rtrim($sValue), -2))
|
|
{
|
|
$sValue = \rtrim($sValue);
|
|
}
|
|
}
|
|
}
|
|
|
|
if (null !== $sName)
|
|
{
|
|
$oHeader = Header::NewInstanceFromEncodedString($sName.': '.$sValue, $this->sParentCharset);
|
|
if ($oHeader)
|
|
{
|
|
$this->Add($oHeader);
|
|
}
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
public function ToEncodedString()
|
|
{
|
|
$aResult = array();
|
|
$aHeaders =& $this->GetAsArray();
|
|
foreach ($aHeaders as /* @var $oHeader \MailSo\Mime\Header */ &$oHeader)
|
|
{
|
|
$aResult[] = $oHeader->EncodedValue();
|
|
}
|
|
|
|
return \implode(\MailSo\Mime\Enumerations\Constants::CRLF, $aResult);
|
|
}
|
|
}
|