class Message extends MimePart

Mail provides functionality to compose and send both text and MIME-compliant multipart email messages.

Constants

HIGH

Priority

NORMAL

Priority

LOW

Priority

Properties

static array $defaultHeaders
string $subject
string $htmlBody

Methods

__construct()

No description

setFrom(string $email, string $name = null)

Sets the sender of the message. Email or format "John Doe" doe@example.com

array|null
getFrom()

Returns the sender of the message.

addReplyTo(string $email, string $name = null)

Adds the reply-to address. Email or format "John Doe" doe@example.com

setSubject(string $subject)

Sets the subject of the message.

string|null
getSubject()

Returns the subject of the message.

addTo(string $email, string $name = null)

Adds email recipient. Email or format "John Doe" doe@example.com

addCc(string $email, string $name = null)

Adds carbon copy email recipient. Email or format "John Doe" doe@example.com

addBcc(string $email, string $name = null)

Adds blind carbon copy email recipient. Email or format "John Doe" doe@example.com

setReturnPath(string $email)

Sets the Return-Path header of the message.

string|null
getReturnPath()

Returns the Return-Path header.

setPriority(int $priority)

Sets email priority.

int|null
getPriority()

Returns email priority.

setHtmlBody(string $html, string $basePath = null)

Sets HTML body.

string
getHtmlBody()

Gets HTML body.

addEmbeddedFile(string $file, string $content = null, string $contentType = null)

Adds embedded file.

addInlinePart(MimePart $part)

Adds inlined Mime Part.

addAttachment(string $file, string $content = null, string $contentType = null)

Adds attachment.

array
getAttachments()

Gets all email attachments.

string
generateMessage()

Returns encoded message.

build()

Builds email. Does not modify itself, but returns a new object.

string
buildText(string $html)

Builds text content.

Details

at line 46
__construct()

at line 59
Message setFrom(string $email, string $name = null)

Sets the sender of the message. Email or format "John Doe" doe@example.com

Parameters

string $email
string $name

Return Value

Message

at line 69
array|null getFrom()

Returns the sender of the message.

Return Value

array|null

at line 79
Message addReplyTo(string $email, string $name = null)

Adds the reply-to address. Email or format "John Doe" doe@example.com

Parameters

string $email
string $name

Return Value

Message

at line 90
Message setSubject(string $subject)

Sets the subject of the message.

Parameters

string $subject

Return Value

Message

at line 100
string|null getSubject()

Returns the subject of the message.

Return Value

string|null

at line 110
Message addTo(string $email, string $name = null)

Adds email recipient. Email or format "John Doe" doe@example.com

Parameters

string $email
string $name

Return Value

Message

at line 121
Message addCc(string $email, string $name = null)

Adds carbon copy email recipient. Email or format "John Doe" doe@example.com

Parameters

string $email
string $name

Return Value

Message

at line 132
Message addBcc(string $email, string $name = null)

Adds blind carbon copy email recipient. Email or format "John Doe" doe@example.com

Parameters

string $email
string $name

Return Value

Message

at line 160
Message setReturnPath(string $email)

Sets the Return-Path header of the message.

Parameters

string $email

Return Value

Message

at line 170
string|null getReturnPath()

Returns the Return-Path header.

Return Value

string|null

at line 180
Message setPriority(int $priority)

Sets email priority.

Parameters

int $priority

Return Value

Message

at line 190
int|null getPriority()

Returns email priority.

Return Value

int|null

at line 200
Message setHtmlBody(string $html, string $basePath = null)

Sets HTML body.

Parameters

string $html
string $basePath

Return Value

Message

at line 247
string getHtmlBody()

Gets HTML body.

Return Value

string

at line 256
MimePart addEmbeddedFile(string $file, string $content = null, string $contentType = null)

Adds embedded file.

Parameters

string $file
string $content
string $contentType

Return Value

MimePart

at line 267
Message addInlinePart(MimePart $part)

Adds inlined Mime Part.

Parameters

MimePart $part

Return Value

Message

at line 277
MimePart addAttachment(string $file, string $content = null, string $contentType = null)

Adds attachment.

Parameters

string $file
string $content
string $contentType

Return Value

MimePart

at line 287
array getAttachments()

Gets all email attachments.

Return Value

array

at line 325
string generateMessage()

Returns encoded message.

Return Value

string

at line 335
Message build()

Builds email. Does not modify itself, but returns a new object.

Return Value

Message

at line 382
protected string buildText(string $html)

Builds text content.

Parameters

string $html

Return Value

string