Zend Framework
Back to top  

 Methods

Constructor

__construct(string $fieldName, string $fieldValue) 

Parameters

$fieldName

string

Optional

$fieldValue

string

Optional

Factory to generate a header object from a string

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

Parameters

$headerLine

string

Exceptions

\Zend\Mail\Header\Exception\InvalidArgumentException If the header does not match with RFC 2822 definition.

Returns

\Zend\Mail\Header\self

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 header encoding

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

Parameters

$encoding

string

Returns

\Zend\Mail\Header\self

Set header name

setFieldName(string $fieldName) : \Zend\Mail\Header\GenericHeader

Parameters

$fieldName

string

Exceptions

\Zend\Mail\Header\Exception\InvalidArgumentException;

Returns

\Zend\Mail\Header\GenericHeader

Set header value

setFieldValue(string $fieldValue) : \Zend\Mail\Header\GenericHeader

Parameters

$fieldValue

string

Exceptions

\Zend\Mail\Header\Exception\InvalidArgumentException;

Returns

\Zend\Mail\Header\GenericHeader

Splits the header line in `name` and `value` parts.

splitHeaderLine(string $headerLine) : string[]

Parameters

$headerLine

string

Exceptions

\Zend\Mail\Header\Exception\InvalidArgumentException If header does not match with the format ``name:value``

Returns

string[]`name` in the first index and `value` in the second.

Cast to string

toString() : string

Returns in form of "NAME: VALUE"

Returns

string

 Properties

 

Header encoding

$encoding : null | string

 

$fieldName

$fieldName : string

 

$fieldValue

$fieldValue : 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