123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136 |
- <?php
- /*
- * This file is part of the Symfony package.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
- namespace Symfony\Component\Mime\Header;
- use Symfony\Component\Mime\Address;
- use Symfony\Component\Mime\Exception\RfcComplianceException;
- /**
- * A Mailbox list MIME Header for something like From, To, Cc, and Bcc (one or more named addresses).
- *
- * @author Chris Corbyn
- */
- final class MailboxListHeader extends AbstractHeader
- {
- private $addresses = [];
- /**
- * @param Address[] $addresses
- */
- public function __construct(string $name, array $addresses)
- {
- parent::__construct($name);
- $this->setAddresses($addresses);
- }
- /**
- * @param Address[] $body
- *
- * @throws RfcComplianceException
- */
- public function setBody($body)
- {
- $this->setAddresses($body);
- }
- /**
- * @throws RfcComplianceException
- *
- * @return Address[]
- */
- public function getBody(): array
- {
- return $this->getAddresses();
- }
- /**
- * Sets a list of addresses to be shown in this Header.
- *
- * @param Address[] $addresses
- *
- * @throws RfcComplianceException
- */
- public function setAddresses(array $addresses)
- {
- $this->addresses = [];
- $this->addAddresses($addresses);
- }
- /**
- * Sets a list of addresses to be shown in this Header.
- *
- * @param Address[] $addresses
- *
- * @throws RfcComplianceException
- */
- public function addAddresses(array $addresses)
- {
- foreach ($addresses as $address) {
- $this->addAddress($address);
- }
- }
- /**
- * @throws RfcComplianceException
- */
- public function addAddress(Address $address)
- {
- $this->addresses[] = $address;
- }
- /**
- * @return Address[]
- */
- public function getAddresses(): array
- {
- return $this->addresses;
- }
- /**
- * Gets the full mailbox list of this Header as an array of valid RFC 2822 strings.
- *
- * @throws RfcComplianceException
- *
- * @return string[]
- */
- public function getAddressStrings(): array
- {
- $strings = [];
- foreach ($this->addresses as $address) {
- $str = $address->getEncodedAddress();
- if ($name = $address->getName()) {
- $str = $this->createPhrase($this, $name, $this->getCharset(), !$strings).' <'.$str.'>';
- }
- $strings[] = $str;
- }
- return $strings;
- }
- public function getBodyAsString(): string
- {
- return implode(', ', $this->getAddressStrings());
- }
- /**
- * Redefine the encoding requirements for addresses.
- *
- * All "specials" must be encoded as the full header value will not be quoted
- *
- * @see RFC 2822 3.2.1
- */
- protected function tokenNeedsEncoding(string $token): bool
- {
- return preg_match('/[()<>\[\]:;@\,."]/', $token) || parent::tokenNeedsEncoding($token);
- }
- }
|