MessageInterface
in
Mail message interface
Tags
Table of Contents
- __toString() : string
- Render to string
- addHeader() : AbstractPart
- Add header
- addHeaders() : AbstractPart
- Add headers
- getBody() : string
- Get body
- getCharSet() : string
- Get character set
- getContentType() : string
- Get content type
- getHeader() : string
- Get header
- getHeaderAsString() : string
- Get header as string
- getHeaders() : array<string|int, mixed>
- Get all headers
- getHeadersAsString() : string
- Get all headers as string
- hasHeader() : bool
- Determine if message has header
- render() : string
- Render
- renderAsLines() : array<string|int, mixed>
- Render as an array of lines
- setCharSet() : MessageInterface
- Set character set
- setContentType() : MessageInterface
- Set content type
Methods
__toString()
Render to string
public
__toString() : string
Return values
string —addHeader()
Add header
public
addHeader(string $header, string $value) : AbstractPart
Parameters
- $header : string
- $value : string
Return values
AbstractPart —addHeaders()
Add headers
public
addHeaders(array<string|int, mixed> $headers) : AbstractPart
Parameters
- $headers : array<string|int, mixed>
Return values
AbstractPart —getBody()
Get body
public
getBody() : string
Return values
string —getCharSet()
Get character set
public
getCharSet() : string
Return values
string —getContentType()
Get content type
public
getContentType() : string
Return values
string —getHeader()
Get header
public
getHeader(string $header) : string
Parameters
- $header : string
Return values
string —getHeaderAsString()
Get header as string
public
getHeaderAsString(string $header) : string
Parameters
- $header : string
Return values
string —getHeaders()
Get all headers
public
getHeaders() : array<string|int, mixed>
Return values
array<string|int, mixed> —getHeadersAsString()
Get all headers as string
public
getHeadersAsString([array<string|int, mixed> $omit = [] ]) : string
Parameters
- $omit : array<string|int, mixed> = []
Return values
string —hasHeader()
Determine if message has header
public
hasHeader(string $header) : bool
Parameters
- $header : string
Return values
bool —render()
Render
public
render() : string
Return values
string —renderAsLines()
Render as an array of lines
public
renderAsLines() : array<string|int, mixed>
Return values
array<string|int, mixed> —setCharSet()
Set character set
public
setCharSet(string $charSet) : MessageInterface
Parameters
- $charSet : string
Return values
MessageInterface —setContentType()
Set content type
public
setContentType(string $contentType) : MessageInterface
Parameters
- $contentType : string