Class Mail

Summary

File
Package hierarchy IO\Mail
Class hierarchy \Mail

package
IO
subpackage
Mail
copyright
© 2005-2020 PHPBoost
license
https://www.gnu.org/licenses/gpl-3.0.html GNU/GPL-3.0
author
Benoit SAUTEL ben.popeye@phpboost.com
version
PHPBoost 6.0 - last update: 2016 10 24
since
PHPBoost 3.0 - 2010 03 08
contributor
Julien BRISWALTER j1.seth@phpboost.com
contributor
Arnaud GENET elenwii@phpboost.com

This class allows you to send mails without having to deal with the mail headers and parameters.

Methods

__construct()

__construct()

Builds a Mail subject.

Inherited from \Mail

Tags

None found

set_sender()

set_sender(string $sender, string $sender_name = self::SENDER_ADMIN)

Sets the mail sender.

Parameters

string	$sender	The mail sender address.
string	$sender_name	SENDER_ADMIN constante if the mail is sent by the administrator, SENDER_USER constante for user or string for other name

Inherited from \Mail

Tags

None found

set_reply_to()

set_reply_to(string $reply_to, string $reply_to_name = '')

Sets the mail to reply to.

Parameters

string	$reply_to	The mail address to reply to.
string	$reply_to_name	SENDER_ADMIN constante if the mail is sent by the administrator, SENDER_USER constante for user or string for other name

Inherited from \Mail

Tags

None found

add_recipient()

add_recipient(string $address, string $name = '')

Adds a recipient to the list

Parameters

string	$address	The address to which the mail must be sent
string	$name	Name of the recipient (facultative)

Inherited from \Mail

Tags

None found

clear_recipients()

clear_recipients()

Inherited from \Mail

Tags

None found

add_cc_recipient()

add_cc_recipient(string $address, string $name = '')

Adds a cc recipient to the list

Parameters

string	$address	The address to which the mail must be sent
string	$name	Name of the recipient (facultative)

Inherited from \Mail

Tags

None found

clear_cc_recipients()

clear_cc_recipients()

Inherited from \Mail

Tags

None found

add_bcc_recipient()

add_bcc_recipient(string $address, string $name = '')

Adds a bcc recipient to the list

Parameters

string	$address	The address to which the mail must be sent
string	$name	Name of the recipient (facultative)

Inherited from \Mail

Tags

None found

clear_bcc_recipients()

clear_bcc_recipients()

Inherited from \Mail

Tags

None found

get_recipients()

get_recipients() : \string[string]

Returns a map associating email addresses to the corresponding names (can be empty).

Returns

\string[string]

Inherited from \Mail

Tags

None found

get_cc_recipients()

get_cc_recipients() : \string[string]

Returns a map associating email addresses to the corresponding names (can be empty).

Returns

\string[string]

Inherited from \Mail

Tags

None found

get_bcc_recipients()

get_bcc_recipients() : \string[string]

Returns a map associating email addresses to the corresponding names (can be empty).

Returns

\string[string]

Inherited from \Mail

Tags

None found

set_subject()

set_subject(string $subject)

Sets the mail subject

Parameters

string

$subject

Mail subject

Inherited from \Mail

Tags

None found

set_content()

set_content(string $content)

The mail content.

Parameters

string

$content

The mail content

Inherited from \Mail

Tags

None found

set_headers()

set_headers(string $headers)

Sets the headers. Forces them, they won't be generated automatically.

Parameters

string

$headers

The mail headers.

Inherited from \Mail

Tags

None found

get_sender_mail()

get_sender_mail() : string

Returns the mail address of the sender.

Returns

string —

the sender's mail address

Inherited from \Mail

Tags

None found

get_sender_name()

get_sender_name() : string

Returns the mail sender's name.

Returns

string —

The mail sender's name.

Inherited from \Mail

Tags

None found

get_reply_to_mail()

get_reply_to_mail() : string

Returns the mail address to reply to.

Returns

string —

the reply to mail address

Inherited from \Mail

Tags

None found

get_reply_to_name()

get_reply_to_name() : string

Returns the reply to mail sender's name.

Returns

string —

The reply to mail sender's name.

Inherited from \Mail

Tags

None found

get_subject()

get_subject() : string

Returns the mail subject.

Returns

string —

The mail subject.

Inherited from \Mail

Tags

None found

get_content()

get_content() : string

Returns the mail content.

Returns

string —

The mail content.

Inherited from \Mail

Tags

None found

set_is_html()

set_is_html( $is)

Parameters

$is

Inherited from \Mail

Tags

None found

is_html()

is_html()

Inherited from \Mail

Tags

None found

check_mail()

check_mail( $mail)

Parameters

$mail

static

Inherited from \Mail

Tags

None found

Properties

$subject

$subject : \sting

\sting — object of the mail

Tags

None found

$content

$content : string

string — content of the mail

Tags

None found

$sender_mail

$sender_mail : string

string — Address of the mail sender.

Tags

None found

$sender_name

$sender_name : string

string — The mail sender name.

Tags

None found

$reply_to_mail

$reply_to_mail : string

string — Address of the mail to reply to.

Tags

None found

$reply_to_name

$reply_to_name : string

string — The reply to mail sender name.

Tags

None found

$headers

$headers : \The

\The — mail headers.

Tags

None found

$recipients

$recipients : array<mixed,string>

array<mixed,string> — Recipients of the mail. If they are more than one, a comma separates their addresses.

Tags

None found

$cc_recipients

$cc_recipients : array<mixed,string>

array<mixed,string> — Cc recipients of the mail. If they are more than one, a comma separates their addresses.

Tags

None found

$bcc_recipients

$bcc_recipients : array<mixed,string>

array<mixed,string> — Bcc recipients of the mail. If they are more than one, a comma separates their addresses.

Tags

None found

$is_html

$is_html : string

string — Tells whether the content contains HTML code

Tags

None found

Constants

SENDER_ADMIN

SENDER_ADMIN = 'admin'

Tags

None found

SENDER_USER

SENDER_USER = 'user'

Tags

None found