This is an old revision of the document!
Table of Contents
Mailer
Layer: Core · Source: lib/core/Mailer.php:19 (lines 19–257)
class Mailer
Send e-mail via mail php function
Docblock Metadata
| Tag | Value |
|---|---|
@category | Core Class |
@author | M.Noermoehammad |
@license | MIT |
@version | 1.0 |
@since | Since Release 1.0 |
Inheritance
No parent, interface or trait. This is a root type.
Constants (0)
None.
Properties (0)
None declared.
Methods (12)
| Visibility | Method | Summary | Line |
|---|---|---|---|
| public | __construct() | Initialize the message parts with blank or default values | 85 |
| public | setSendTo() | set send to | 102 |
| public | setSendCc() | set send CC | 111 |
| public | setSendBcc() | set send BCC | 120 |
| public | setFrom() | set email's sender | 129 |
| public | setSubject() | set email's subject | 138 |
| public | setSendText() | set whether to send email as text | 147 |
| public | setTextBody() | set text email message body | 156 |
| public | setSendHTML() | set whether to send email as HTML | 166 |
| public | setHTMLBody() | set text HTML message body | 175 |
| public | send() | Send | 191 |
| private static | getAppEmail() | getAppEmail | 250 |
__construct()
public function __construct()
lines 85–96 (12)
Initialize the message parts with blank or default values
Takes no parameters.
setSendTo()
public function setSendTo($value)
lines 102–105 (4)
set send to
| Parameter | Type | Default | Description |
|---|---|---|---|
$value | (untyped) | required | none |
Returns: (none declared)
setSendCc()
public function setSendCc($value)
lines 111–114 (4)
set send CC
| Parameter | Type | Default | Description |
|---|---|---|---|
$value | (untyped) | required | none |
Returns: (none declared)
setSendBcc()
public function setSendBcc($value)
lines 120–123 (4)
set send BCC
| Parameter | Type | Default | Description |
|---|---|---|---|
$value | (untyped) | required | none |
Returns: (none declared)
setFrom()
public function setFrom($value)
lines 129–132 (4)
set email's sender
| Parameter | Type | Default | Description |
|---|---|---|---|
$value | (untyped) | required | none |
Returns: (none declared)
setSubject()
public function setSubject($value)
lines 138–141 (4)
set email's subject
| Parameter | Type | Default | Description |
|---|---|---|---|
$value | (untyped) | required | none |
Returns: (none declared)
setSendText()
public function setSendText($value)
lines 147–150 (4)
set whether to send email as text
| Parameter | Type | Default | Description |
|---|---|---|---|
$value | (untyped) | required | none |
Returns: (none declared)
setTextBody()
public function setTextBody($value)
lines 156–160 (5)
set text email message body
| Parameter | Type | Default | Description |
|---|---|---|---|
$value | (untyped) | required | none |
Returns: (none declared)
setSendHTML()
public function setSendHTML($value)
lines 166–169 (4)
set whether to send email as HTML
| Parameter | Type | Default | Description |
|---|---|---|---|
$value | (untyped) | required | none |
Returns: (none declared)
setHTMLBody()
public function setHTMLBody($value)
lines 175–179 (5)
set text HTML message body
| Parameter | Type | Default | Description |
|---|---|---|---|
$value | (untyped) | required | none |
Returns: (none declared)
send()
public function send($to = null, $subject = null, $message = null, $headers = null)
lines 191–240 (50)
Send
sending email
| Parameter | Type | Default | Description |
|---|---|---|---|
$to | (untyped) | null | none |
$subject | (untyped) | null | none |
$message | (untyped) | null | none |
$headers | (untyped) | null | none |
Returns: (none declared) — boolean
getAppEmail()
private static function getAppEmail()
lines 250–256 (7)
getAppEmail
Takes no parameters.
Returns: (none declared) — string
This page is generated from source by 'tools/gendoc'. Edits will be overwritten.