Interface StructuredInterface

Summary

Fully Qualified Name: Laminas\Mail\Header\StructuredInterface
Extends: HeaderInterface

Description

Methods

Name Description Defined By
fromString() Factory to generate a header object from a string HeaderInterface
getDelimiter() Return the delimiter at which a header line should be wrapped StructuredInterface
getEncoding() Get header encoding HeaderInterface
getFieldName() Retrieve header name HeaderInterface
getFieldValue() Retrieve header value HeaderInterface
setEncoding() Set header encoding HeaderInterface
toString() Cast to string HeaderInterface

Method Details

fromString()

Factory to generate a header object from a string

Parameter Name Type Description
$headerLine string

Returns: static

getDelimiter()

Return the delimiter at which a header line should be wrapped

Returns: string

getEncoding()

Get header encoding

Returns: string

getFieldName()

Retrieve header name

Returns: string

getFieldValue()

Retrieve header value

Parameter Name Type Description
$format bool Return

Returns: string

setEncoding()

Set header encoding

Parameter Name Type Description
$encoding string

Returns: $this

toString()

Cast to string

Returns in form of "NAME: VALUE"

Returns: string

Top