Generic class for Headers with multiple occurs in the same message

category Zend
package Zend_Mail
subpackage Header

 Methods

Constructor

__construct(string $fieldName, string $fieldValue) 
Inherited

inherited_from \Zend\Mail\Header\GenericHeader::__construct()

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

Returns

\Zend\Mail\Header\self

Get header encoding

getEncoding() : string
Inherited

inherited_from \Zend\Mail\Header\GenericHeader::getEncoding()

Returns

string

Retrieve header name

getFieldName() : string
Inherited

inherited_from \Zend\Mail\Header\GenericHeader::getFieldName()

Returns

string

Retrieve header value

getFieldValue(bool $format) : string
Inherited

inherited_from \Zend\Mail\Header\GenericHeader::getFieldValue()

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
Inherited

inherited_from \Zend\Mail\Header\GenericHeader::setEncoding()

Parameters

$encoding

string

Returns

\Zend\Mail\Header\self

Set header name

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

inherited_from \Zend\Mail\Header\GenericHeader::setFieldName()

Parameters

$fieldName

string

Exceptions

\Zend\Mail\Header\Exception\InvalidArgumentException

Returns

Set header value

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

inherited_from \Zend\Mail\Header\GenericHeader::setFieldValue()

Parameters

$fieldValue

string

Returns

Cast to string

toString() : string
Inherited

Returns in form of "NAME: VALUE"

inherited_from \Zend\Mail\Header\GenericHeader::toString()

Returns

string

Cast multiple header objects to a single string header

toStringMultipleHeaders(array $headers) : string

Parameters

$headers

array

Exceptions

\Zend\Mail\Header\Exception\InvalidArgumentException

Returns

string

 Properties

 

Header encoding

$encoding : string
Inherited

inherited_from \Zend\Mail\Header\GenericHeader::$$encoding
 

$fieldName

$fieldName : string
Inherited

inherited_from \Zend\Mail\Header\GenericHeader::$$fieldName
 

$fieldValue

$fieldValue : string
Inherited

inherited_from \Zend\Mail\Header\GenericHeader::$$fieldValue

 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
inherited_from \Zend\Mail\Header\GenericHeader::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
inherited_from \Zend\Mail\Header\GenericHeader::FORMAT_RAW