Base class for headers composing address lists (to, from, cc, bcc, reply-to)

package Default
inherited_from \Zend\Mail\Header\AbstractAddressList

 Methods

Factory to generate a header object from a string

fromString(string $headerLine) 
InheritedStatic
inherited_from \Zend\Mail\Header\HeaderInterface::fromString()

Parameters

$headerLine

Get address list managed by this header

getAddressList() : \Zend\Mail\AddressList
Inherited

Returns

\Zend\Mail\AddressList

Get header encoding

getEncoding() 
Inherited
inherited_from \Zend\Mail\Header\HeaderInterface::getEncoding()

Retrieve header name

getFieldName() 
Inherited
inherited_from \Zend\Mail\Header\HeaderInterface::getFieldName()

Retrieve header value

getFieldValue(boolean $format = \Zend\Mail\Header\HeaderInterface::FORMAT_RAW
Inherited
inherited_from \Zend\Mail\Header\HeaderInterface::getFieldValue()

Parameters

$format

Set address list for this header

setAddressList(\Zend\Mail\AddressList $addressList) 
Inherited

Parameters

$addressList

\Zend\Mail\AddressList

Set header encoding

setEncoding(string $encoding) 
Inherited
inherited_from \Zend\Mail\Header\HeaderInterface::setEncoding()

Parameters

$encoding

Cast to string

toString() 
Inherited

Returns in form of "NAME: VALUE"

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

 Properties

 

$addressList

$addressList : \Zend\Mail\AddressList

Default

 

Header encoding

$encoding : string

Default

'ASCII'
 

$fieldName

$fieldName 

Default

'Bcc'
inherited_from \Zend\Mail\Header\AbstractAddressList::fieldName
 

Normalized field name

$fieldName : string

Default

 

$type

$type 

Default

'bcc'
Static
inherited_from \Zend\Mail\Header\AbstractAddressList::type
 

lower case field name

$type : string

Default

Static