interface MessageInterface

Methods

set(string $name, mixed $val)

Global setter

get(string $name)

Global getter

clear(string $name = null)

Global variable clearer

string
getId()

Get message ID

string
getMessage()

Get the full built message

setFrom(string/array $mail = '', string/bool $name = null, bool $reply = true)

Set From field

setTo(string/array $mail = '', string/bool $name = null)

Set To field

setCc(string/array $mail = '', string/bool $name = null)

Set Cc field

setBcc(string/array $mail = '', string/bool $name = null)

Set Bcc field

setAttachment(string|array $file = '', bool $clear = false)

Set mail file attachment

setSubject(string $subject = '', bool $clear = false)

Set mail object

setText(string $text = '', bool $clear = false)

Set plain text version

setHtml(string $html = '', bool $clear = false)

Set HTML version

setReplyTo(string/array $mail = '', string/bool $name = null)

Set Reply-To header field

Details

at line 37
set(string $name, mixed $val)

Global setter

Parameters

string $name
mixed $val

at line 44
get(string $name)

Global getter

Parameters

string $name

at line 51
clear(string $name = null)

Global variable clearer

Parameters

string $name

at line 58
string getId()

Get message ID

Return Value

string

at line 65
string getMessage()

Get the full built message

Return Value

string

at line 74
setFrom(string/array $mail = '', string/bool $name = null, bool $reply = true)

Set From field

Parameters

string/array $mail The email address to add, or an array of name=>email pairs
string/bool $name The name to show for the email address if there is just one
bool $reply Set the "reply-to" to the same address ? (default is TRUE)

at line 82
setTo(string/array $mail = '', string/bool $name = null)

Set To field

Parameters

string/array $mail The email address to add, or an array of name=>email pairs
string/bool $name The name to show for the email address if there is just one

at line 90
setCc(string/array $mail = '', string/bool $name = null)

Set Cc field

Parameters

string/array $mail The email address to add, or an array of name=>email pairs
string/bool $name The name to show for the email address if there is just one

at line 98
setBcc(string/array $mail = '', string/bool $name = null)

Set Bcc field

Parameters

string/array $mail The email address to add, or an array of name=>email pairs
string/bool $name The name to show for the email address if there is just one

at line 106
setAttachment(string|array $file = '', bool $clear = false)

Set mail file attachment

Parameters

string|array $file The file or files to attach
bool $clear Clear a set content first ? (default is to append a content)

at line 114
setSubject(string $subject = '', bool $clear = false)

Set mail object

Parameters

string $subject The subject content
bool $clear Clear a set content first ? (default is to append a content)

at line 124
setText(string $text = '', bool $clear = false)

Set plain text version

If $text='auto', the text version will be generated from the HTML content

Parameters

string $text The plain text content or keyword 'auto' to auto-generate it from the HTML content
bool $clear Clear a set content first ? (default is to append a content)

at line 132
setHtml(string $html = '', bool $clear = false)

Set HTML version

Parameters

string $html The HTML content
bool $clear Clear a set content first ? (default is to append a content)

at line 140
setReplyTo(string/array $mail = '', string/bool $name = null)

Set Reply-To header field

Parameters

string/array $mail The email address to add, or an array of name=>email pairs
string/bool $name The name to show for the email address if there is just one