====== Mailer ======

**Layer:** ''Core'' · **Source:** ''lib/core/Mailer.php:19'' (lines 19–257)

----
<code>
class Mailer
</code>

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

^ Visibility ^ Type ^ Name ^ Default ^ Line ^
| ''private'' | ''(untyped)'' | ''$to'' |  | 26 |
| ''private'' | ''(untyped)'' | ''$cc'' |  | 33 |
| ''private'' | ''(untyped)'' | ''$bcc'' |  | 40 |
| ''private'' | ''(untyped)'' | ''$from'' |  | 46 |
| ''private'' | ''(untyped)'' | ''$subject'' |  | 52 |
| ''private'' | ''(untyped)'' | ''$sendText'' |  | 59 |
| ''private'' | ''(untyped)'' | ''$textBody'' |  | 66 |
| ''private'' | ''(untyped)'' | ''$sendHTML'' |  | 73 |
| ''private'' | ''(untyped)'' | ''$HTMLBody'' |  | 80 |

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

<code>
public function __construct()
</code>

//lines 85–96 (12)//

Initialize the message parts with blank or default values

//Takes no parameters.//


======== setSendTo() ========

<code>
public function setSendTo($value)
</code>

//lines 102–105 (4)//

set send to

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$value'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== setSendCc() ========

<code>
public function setSendCc($value)
</code>

//lines 111–114 (4)//

set send CC

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$value'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== setSendBcc() ========

<code>
public function setSendBcc($value)
</code>

//lines 120–123 (4)//

set send BCC

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$value'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== setFrom() ========

<code>
public function setFrom($value)
</code>

//lines 129–132 (4)//

set email's sender

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$value'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== setSubject() ========

<code>
public function setSubject($value)
</code>

//lines 138–141 (4)//

set email's subject

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$value'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== setSendText() ========

<code>
public function setSendText($value)
</code>

//lines 147–150 (4)//

set whether to send email as text

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$value'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== setTextBody() ========

<code>
public function setTextBody($value)
</code>

//lines 156–160 (5)//

set text email message body

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$value'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== setSendHTML() ========

<code>
public function setSendHTML($value)
</code>

//lines 166–169 (4)//

set whether to send email as HTML

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$value'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== setHTMLBody() ========

<code>
public function setHTMLBody($value)
</code>

//lines 175–179 (5)//

set text HTML message body

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$value'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== send() ========

<code>
public function send($to = null, $subject = null, $message = null, $headers = null)
</code>

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

<code>
private static function getAppEmail()
</code>

//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.//