\apex\app\msg\objectsemail_message

Allows e-mail messages to be properly defined with all necessary variables and information.

Summary

Methods
Properties
Constants
to_email()
from_email()
to_name()
from_name()
reply_to()
cc()
bcc()
subject()
message()
content_type()
add_attachment()
get_from_email()
get_to_email()
get_sender_line()
get_recipient_line()
get_subject()
get_headers()
get_message()
format_message()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$to_email
$to_name
$from_email
$from_name
$reply_to
$cc
$bcc
$subject
$headers
$message
$content_type
$attachments
N/A

Properties

$to_email

$to_email :

Type

$to_name

$to_name :

Type

$from_email

$from_email :

Type

$from_name

$from_name :

Type

$reply_to

$reply_to :

Type

$cc

$cc :

Type

$bcc

$bcc :

Type

$subject

$subject :

Type

$headers

$headers :

Type

$message

$message :

Type

$content_type

$content_type :

Type

$attachments

$attachments :

Type

Methods

to_email()

to_email(string  $email)

Set to e-mail

Parameters

string $email

The recipient e-mail address to send to

from_email()

from_email(string  $email)

set from e-mail address

Parameters

string $email

The e-mail address the e-mail is from.

to_name()

to_name(string  $name)

Set recipient name

Parameters

string $name

The full name of the recipient

from_name()

from_name(string  $name)

Set the sender name

Parameters

string $name

The name of the e-mail sender

reply_to()

reply_to(string  $email)

Set the reply-to e-mail address

Parameters

string $email

The e-mail address.

cc()

cc(string  $email)

Set the CC e-mail address

Parameters

string $email

The e-mail address.

bcc()

bcc(string  $email)

Set the BCC e-mail address

Parameters

string $email

The e-mail address.

subject()

subject(string  $subject)

Set the subject of the e-mail

Parameters

string $subject

The subject of the e-mail address

message()

message(string  $message)

Set the conents of the e-mail message

Parameters

string $message

The contents of the e-mail message.

content_type()

content_type(string  $type)

Set the content type of the -email message.

Parameters

string $type

The content type

add_attachment()

add_attachment(string  $filename,string  $contents)

Add a file attachment to the e-mail message

Parameters

string $filename

The filename of the file attachment.

string $contents

The contents of the file attachment.

get_from_email()

get_from_email(): string

Get the sender e-mail address

@return string The sender e-mail address

Returns

string —

The sender e-mail address

get_to_email()

get_to_email(): string

Get the to e-mail address

@return string The to / recipient e-mail address

Returns

string —

The to / recipient e-mail address

get_sender_line()

get_sender_line(): string

Get the sender line

@return string The recipient line (NAME format)

Returns

string —

The sender line (NAME format)

get_recipient_line()

get_recipient_line(): string

Get the recipient line

@return string The recipient line (NAME format)

Returns

string —

The recipient line (NAME format)

get_subject()

get_subject(): string

Get the subject

@return string The e-mail subject

Returns

string —

The e-mail subject

get_headers()

get_headers(): string

Get the header of the e-mail message.

@return string Headers of the email message

Returns

string —

Headers of the email message

get_message()

get_message()

Get the contents of the e-mail message.

@param string The contents of the e-mail message

format_message()

format_message()

Format the e-mail message as necessary