| Next revision | Previous revision |
| scriptlog:lib:core:mailer [2026/09/26 09:09] – admin admin | scriptlog:lib:core:mailer [2026/09/26 09:34] (current) – admin admin |
|---|
| ======= Docblock Metadata ======= | ======= Docblock Metadata ======= |
| |
| ^ Tag ^ Value ^ | ^ Tag ^ Value ^ |
| | ''@category'' | Core Class | | | ''@category'' | Core Class | |
| | ''@author'' | M.Noermoehammad | | | ''@author'' | M.Noermoehammad | |
| | ''@license'' | MIT | | | ''@license'' | MIT | |
| | ''@version'' | 1.0 | | | ''@version'' | 1.0 | |
| | ''@since'' | Since Release 1.0 | | | ''@since'' | Since Release 1.0 | |
| |
| ======= Inheritance ======= | ======= Inheritance ======= |
| //None.// | //None.// |
| |
| ======= Properties (0) ======= | ======= Properties (9) ======= |
| |
| //None declared.// | ^ 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) ======= | ======= Methods (12) ======= |
| |
| ^ Visibility ^ Method ^ Summary ^ Line ^ | ^ Visibility ^ Method ^ Summary ^ Line ^ |
| | public | ''__construct()'' | Initialize the message parts with blank or default values | 85 | | | public | ''__construct()'' | Initialize the message parts with blank or default values | 85 | |
| | public | ''setSendTo()'' | set send to | 102 | | | public | ''setSendTo()'' | set send to | 102 | |
| | public | ''setSendCc()'' | set send CC | 111 | | | public | ''setSendCc()'' | set send CC | 111 | |
| | public | ''setSendBcc()'' | set send BCC | 120 | | | public | ''setSendBcc()'' | set send BCC | 120 | |
| | public | ''setFrom()'' | set email's sender | 129 | | | public | ''setFrom()'' | set email's sender | 129 | |
| | public | ''setSubject()'' | set email's subject | 138 | | | public | ''setSubject()'' | set email's subject | 138 | |
| | public | ''setSendText()'' | set whether to send email as text | 147 | | | public | ''setSendText()'' | set whether to send email as text | 147 | |
| | public | ''setTextBody()'' | set text email message body | 156 | | | public | ''setTextBody()'' | set text email message body | 156 | |
| | public | ''setSendHTML()'' | set whether to send email as HTML | 166 | | | public | ''setSendHTML()'' | set whether to send email as HTML | 166 | |
| | public | ''setHTMLBody()'' | set text HTML message body | 175 | | | public | ''setHTMLBody()'' | set text HTML message body | 175 | |
| | public | ''send()'' | Send | 191 | | | public | ''send()'' | Send | 191 | |
| | private static | ''getAppEmail()'' | getAppEmail | 250 | | | private static | ''getAppEmail()'' | getAppEmail | 250 | |
| |
| |
| set send to | set send to |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$value'' | ''(untyped)'' | //required// | //none// | | | ''$value'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| set send CC | set send CC |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$value'' | ''(untyped)'' | //required// | //none// | | | ''$value'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| set send BCC | set send BCC |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$value'' | ''(untyped)'' | //required// | //none// | | | ''$value'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| set email's sender | set email's sender |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$value'' | ''(untyped)'' | //required// | //none// | | | ''$value'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| set email's subject | set email's subject |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$value'' | ''(untyped)'' | //required// | //none// | | | ''$value'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| set whether to send email as text | set whether to send email as text |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$value'' | ''(untyped)'' | //required// | //none// | | | ''$value'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| set text email message body | set text email message body |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$value'' | ''(untyped)'' | //required// | //none// | | | ''$value'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| set whether to send email as HTML | set whether to send email as HTML |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$value'' | ''(untyped)'' | //required// | //none// | | | ''$value'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| set text HTML message body | set text HTML message body |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$value'' | ''(untyped)'' | //required// | //none// | | | ''$value'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| sending email | sending email |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$to'' | ''(untyped)'' | ''null'' | //none// | | | ''$to'' | ''(untyped)'' | ''null'' | //none// | |
| | ''$subject'' | ''(untyped)'' | ''null'' | //none// | | | ''$subject'' | ''(untyped)'' | ''null'' | //none// | |
| | ''$message'' | ''(untyped)'' | ''null'' | //none// | | | ''$message'' | ''(untyped)'' | ''null'' | //none// | |
| | ''$headers'' | ''(untyped)'' | ''null'' | //none// | | | ''$headers'' | ''(untyped)'' | ''null'' | //none// | |
| |
| **Returns:** ''(none declared)'' — boolean | **Returns:** ''(none declared)'' — boolean |