1. class
  2. Nette
  3. \
  4. Mail
  5. \
  6. Message

Message

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

Message
setFrom(string $email, string|null $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.

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

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

Message
setSubject(string $subject)

Sets the subject of the message.

string|null
getSubject()

Returns the subject of the message.

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

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

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

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

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

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

Message
setReturnPath(string $email)

Sets the Return-Path header of the message.

string|null
getReturnPath()

Returns the Return-Path header.

Message
setPriority(int $priority)

Sets email priority.

int|null
getPriority()

Returns email priority.

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

Sets HTML body.

string
getHtmlBody()

Gets HTML body.

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

Adds embedded file.

Message
addInlinePart(MimePart $part)

Adds inlined Mime Part.

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

Adds attachment.

array
getAttachments()

Gets all email attachments.

string
generateMessage()

Returns encoded message.

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()

No description

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

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

Parameters

string $email
string|null $name

Return Value

Message

at line 70
array|null getFrom()

Returns the sender of the message.

Return Value

array|null

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

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

Parameters

string $email
string|null $name

Return Value

Message

at line 91
Message setSubject(string $subject)

Sets the subject of the message.

Parameters

string $subject

Return Value

Message

at line 101
string|null getSubject()

Returns the subject of the message.

Return Value

string|null

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

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

Parameters

string $email
string|null $name

Return Value

Message

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

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

Parameters

string $email
string|null $name

Return Value

Message

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

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

Parameters

string $email
string|null $name

Return Value

Message

at line 162
Message setReturnPath(string $email)

Sets the Return-Path header of the message.

Parameters

string $email

Return Value

Message

at line 172
string|null getReturnPath()

Returns the Return-Path header.

Return Value

string|null

at line 182
Message setPriority(int $priority)

Sets email priority.

Parameters

int $priority

Return Value

Message

at line 192
int|null getPriority()

Returns email priority.

Return Value

int|null

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

Sets HTML body.

Parameters

string $html
string|null $basePath

Return Value

Message

at line 253
string getHtmlBody()

Gets HTML body.

Return Value

string

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

Adds embedded file.

Parameters

string $file
string|null $content
string|null $contentType

Return Value

MimePart

at line 273
Message addInlinePart(MimePart $part)

Adds inlined Mime Part.

Parameters

MimePart $part

Return Value

Message

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

Adds attachment.

Parameters

string $file
string|null $content
string|null $contentType

Return Value

MimePart

at line 293
array getAttachments()

Gets all email attachments.

Return Value

array

at line 339
string generateMessage()

Returns encoded message.

Return Value

string

at line 349
Message build()

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

Return Value

Message

at line 397
protected string buildText(string $html)

Builds text content.

Parameters

string $html

Return Value

string