Methods

Factory to generate a header object from a string

fromString(string $headerLine) : \Zend\Mail\Header\self

Parameters

$headerLine

string

Returns

\Zend\Mail\Header\self

Retrieve the internal address from this header

getAddress() : \Zend\Mail\Address\AddressInterface | null

Get header encoding

getEncoding() : string

Returns

string

Retrieve header name

getFieldName() : string

Returns

string

Retrieve header value

getFieldValue(bool $format) : string

Parameters

$format

bool

Return the value in Mime::Encoded or in Raw format

Returns

string

Set the address used in this header

setAddress(string | \Zend\Mail\Address\AddressInterface $emailOrAddress, null | string $name) : \Zend\Mail\Header\Sender

Set header encoding

setEncoding(string $encoding) : \Zend\Mail\Header\self

Parameters

$encoding

string

Returns

\Zend\Mail\Header\self

Cast to string

toString() : string

Returns in form of "NAME: VALUE"

Returns

string

 Properties

 

$address

$address : \Zend\Mail\Address\AddressInterface

 

Header encoding

$encoding : string

 Constants

 

Format value in Mime-Encoding if not US-ASCII encoding is used

FORMAT_ENCODED : bool
Inherited

inherited_from \Zend\Mail\Header\HeaderInterface::FORMAT_ENCODED
 

Return value with the interval ZF2 value (UTF-8 non-encoded)

FORMAT_RAW : bool
Inherited

inherited_from \Zend\Mail\Header\HeaderInterface::FORMAT_RAW