Class Symfony\Component\Mime\Header\MailboxListHeader

`final`
`extends`	`AbstractHeader`

A Mailbox list MIME Header for something like From, To, Cc, and Bcc (one or more named addresses).

Symfony\Component\Mime\Header\AbstractHeader implements HeaderInterface
- Symfony\Component\Mime\Header\MailboxListHeader

Methods


					
	public

__construct(string $name, Address[] $addresses)

Overrides

Symfony\Component\Mime\Header\AbstractHeader::__construct()


					
	public

setBody(Address[] $body): void

Sets the body.

The type depends on the Header concrete class.

Throws

Symfony\Component\Mime\Exception\RfcComplianceException

Implements

Symfony\Component\Mime\Header\HeaderInterface::setBody()


					
	public

getBody(): Address[]

Gets the body.

The return type depends on the Header concrete class.

Throws

Symfony\Component\Mime\Exception\RfcComplianceException

Implements

Symfony\Component\Mime\Header\HeaderInterface::getBody()


					
	public

setAddresses(Address[] $addresses): void

Sets a list of addresses to be shown in this Header.

Throws

Symfony\Component\Mime\Exception\RfcComplianceException


					
	public

addAddresses(Address[] $addresses): void

Sets a list of addresses to be shown in this Header.

Throws

Symfony\Component\Mime\Exception\RfcComplianceException


					
	public

addAddress(Address $address): void

Throws

Symfony\Component\Mime\Exception\RfcComplianceException


					
	public

getAddresses(): Address[]


					
	public

getAddressStrings(): string[]

Gets the full mailbox list of this Header as an array of valid RFC 2822 strings.

Throws

Symfony\Component\Mime\Exception\RfcComplianceException


					
	public

getBodyAsString(): string

Gets the header's body, prepared for folding into a final header value.

This is not necessarily RFC 2822 compliant since folding white space is not added at this stage (see {@link toString()} for that).

Implements

Symfony\Component\Mime\Header\HeaderInterface::getBodyAsString()


					
	protected

tokenNeedsEncoding(string $token): bool

Redefine the encoding requirements for addresses.

All "specials" must be encoded as the full header value will not be quoted

Overrides

Symfony\Component\Mime\Header\AbstractHeader::tokenNeedsEncoding()

Methods inherited from Symfony\Component\Mime\Header\AbstractHeader
`setCharset(), getCharset(), setLanguage(), getLanguage(), getName(), setMaxLineLength(), getMaxLineLength(), toString(), createPhrase(), encodeWords(), getEncodableWordTokens(), getTokenAsEncodedWord(), generateTokenLines(), toTokens(),`

Constants inherited from Symfony\Component\Mime\Header\AbstractHeader
`PHRASE_PATTERN`

Properties
`private`	`array`	`$addresses = []`	#

Properties inherited from Symfony\Component\Mime\Header\AbstractHeader
`$encoder, $name, $lineLength, $lang, $charset`

Namespaces

Classes

Interfaces

Class Symfony\Component\Mime\Header\MailboxListHeader

Overrides

Throws

Implements

Throws

Implements

Throws

Throws

Throws

Throws

Implements

Overrides