Message
in package
FinalYes
Represents the email message that you're sending. The `Message` object consists of a subject line and a message body.
Table of Contents
Properties
- $body : Body
- The body of the message. You can specify an HTML version of the message, a text-only version of the message, or both.
- $headers : array<string|int, MessageHeader>|null
- The list of message headers that will be added to the email message.
- $subject : Content
- The subject line of the email. The subject line can only contain 7-bit ASCII characters. However, you can specify non-ASCII characters in the subject line by using encoded-word syntax, as described in RFC 2047 [^1].
Methods
- __construct() : mixed
- create() : self
- getBody() : Body
- getHeaders() : array<string|int, MessageHeader>
- getSubject() : Content
- throwException() : never
Properties
$body
The body of the message. You can specify an HTML version of the message, a text-only version of the message, or both.
private
Body
$body
$headers
The list of message headers that will be added to the email message.
private
array<string|int, MessageHeader>|null
$headers
$subject
The subject line of the email. The subject line can only contain 7-bit ASCII characters. However, you can specify non-ASCII characters in the subject line by using encoded-word syntax, as described in RFC 2047 [^1].
private
Content
$subject
Methods
__construct()
public
__construct(MessageHeader|array)[]} $input) : mixed
Parameters
- $input : MessageHeader|array)[]}
create()
public
static create(MessageHeader|array)[]}|Message $input) : self
Parameters
- $input : MessageHeader|array)[]}|Message
Return values
selfgetBody()
public
getBody() : Body
Return values
BodygetHeaders()
public
getHeaders() : array<string|int, MessageHeader>
Return values
array<string|int, MessageHeader>getSubject()
public
getSubject() : Content
Return values
ContentthrowException()
private
throwException(Throwable $exception) : never
Parameters
- $exception : Throwable