AbstractMessage
in package
implements
MessageInterface
AbstractYes
Abstract mail message class
Tags
Table of Contents
Interfaces
- MessageInterface
- Mail message interface
Properties
- $charSet : string|null
- Character set
- $contentType : string|null
- Content type
- $headers : array<string|int, mixed>
- Headers
- $id : string|null
- Message or part ID
- $idHeader : string|null
- Message or part ID header name
Methods
- __construct() : mixed
- Constructor
- __toString() : string
- Render message to string
- addHeader() : AbstractMessage
- Add message part header
- addHeaders() : AbstractMessage
- Add message part headers
- generateId() : string
- Generate a new ID
- getBody() : string|null
- Get body
- getCharSet() : string|null
- Get message part character set
- getContentType() : string|null
- Get message part content type
- getHeader() : string|null
- Get message part header
- getHeaderAsString() : string|null
- Get header as string
- getHeaders() : array<string|int, mixed>
- Get all message part headers
- getHeadersAsString() : string
- Get all message headers as string
- getId() : string|null
- Get the ID
- getIdHeader() : string|null
- Get the ID
- hasHeader() : bool
- Determine if message part has header
- render() : string
- Render
- renderAsLines() : array<string|int, mixed>
- Render as an array of lines
- setCharSet() : AbstractMessage
- Set message part character set
- setContentType() : AbstractMessage
- Set message part content type
- setId() : AbstractMessage
- Set the ID
- setIdHeader() : AbstractMessage
- Set the ID header name
- getRandomId() : string
- Returns a random ID
Properties
$charSet
Character set
protected
string|null
$charSet
= null
$contentType
Content type
protected
string|null
$contentType
= null
$headers
Headers
protected
array<string|int, mixed>
$headers
= []
$id
Message or part ID
protected
string|null
$id
= null
$idHeader
Message or part ID header name
protected
string|null
$idHeader
= null
Methods
__construct()
Constructor
public
__construct() : mixed
Instantiate the message object
__toString()
Render message to string
public
__toString() : string
Return values
stringaddHeader()
Add message part header
public
addHeader(string $header, string $value) : AbstractMessage
Parameters
- $header : string
- $value : string
Return values
AbstractMessageaddHeaders()
Add message part headers
public
addHeaders(array<string|int, mixed> $headers) : AbstractMessage
Parameters
- $headers : array<string|int, mixed>
Return values
AbstractMessagegenerateId()
Generate a new ID
public
generateId([string|null $domain = null ]) : string
Parameters
- $domain : string|null = null
Tags
Return values
stringgetBody()
Get body
public
abstract getBody() : string|null
Return values
string|nullgetCharSet()
Get message part character set
public
getCharSet() : string|null
Return values
string|nullgetContentType()
Get message part content type
public
getContentType() : string|null
Return values
string|nullgetHeader()
Get message part header
public
getHeader(string $header) : string|null
Parameters
- $header : string
Return values
string|nullgetHeaderAsString()
Get header as string
public
getHeaderAsString(string $header) : string|null
Parameters
- $header : string
Return values
string|nullgetHeaders()
Get all message part headers
public
getHeaders() : array<string|int, mixed>
Return values
array<string|int, mixed>getHeadersAsString()
Get all message headers as string
public
getHeadersAsString([array<string|int, mixed> $omitHeaders = [] ]) : string
Parameters
- $omitHeaders : array<string|int, mixed> = []
Return values
stringgetId()
Get the ID
public
getId() : string|null
Return values
string|nullgetIdHeader()
Get the ID
public
getIdHeader() : string|null
Return values
string|nullhasHeader()
Determine if message part has header
public
hasHeader(string $header) : bool
Parameters
- $header : string
Return values
boolrender()
Render
public
abstract render() : string
Return values
stringrenderAsLines()
Render as an array of lines
public
abstract renderAsLines() : array<string|int, mixed>
Return values
array<string|int, mixed>setCharSet()
Set message part character set
public
setCharSet([string|null $charSet = null ]) : AbstractMessage
Parameters
- $charSet : string|null = null
Return values
AbstractMessagesetContentType()
Set message part content type
public
setContentType(string $contentType) : AbstractMessage
Parameters
- $contentType : string
Return values
AbstractMessagesetId()
Set the ID
public
setId(string $id) : AbstractMessage
Parameters
- $id : string
Return values
AbstractMessagesetIdHeader()
Set the ID header name
public
setIdHeader(string $header) : AbstractMessage
Parameters
- $header : string
Return values
AbstractMessagegetRandomId()
Returns a random ID
protected
getRandomId([string|null $idRight = null ]) : string
Parameters
- $idRight : string|null = null