ppMailer_Message Class Reference
Public Member Functions | |
| add_part ($content, $mime='text/plain') | |
| add_html_part ($content) | |
| add_text_part ($content) | |
| add_recipient ($email, $name='') | |
| add_to ($email, $name='') | |
| add_cc ($email, $name='') | |
| add_bcc ($email, $name='') | |
| set_from ($email, $name='') | |
| set_reply_to ($email, $name='') | |
| add_attachment ($filepath, $filename='', $mime='application/octet-stream') | |
| add_embedded_image ($filepath, $filename='', $cid=null, $mime='application/octet-stream') | |
| add_header ($name, $value) | |
| get_header ($name) | |
| set_display_callback ($fn) | |
| send () | |
| batch_send () | |
Public Attributes | |
| $swift | |
| $message | |
| $recipients | |
| $callback | |
| $from | |
| $reply_to | |
| $charset | |
Detailed Description
An instance of a mail message. This object will be returned from a ppMailer::create() call. You can then operate on the object before calling send().
Definition at line 105 of file mailer.php.
Member Function Documentation
| ppMailer_Message::add_attachment | ( | $ | filepath, | |
| $ | filename = '', |
|||
| $ | mime = 'application/octet-stream' | |||
| ) |
Add attachments
Definition at line 192 of file mailer.php.
| ppMailer_Message::add_bcc | ( | $ | email, | |
| $ | name = '' | |||
| ) |
Definition at line 156 of file mailer.php.
| ppMailer_Message::add_cc | ( | $ | email, | |
| $ | name = '' | |||
| ) |
Definition at line 148 of file mailer.php.
| ppMailer_Message::add_embedded_image | ( | $ | filepath, | |
| $ | filename = '', |
|||
| $ | cid = null, |
|||
| $ | mime = 'application/octet-stream' | |||
| ) |
Add an embedded image.
- Returns:
- string The content ID (CID), which should be placed in the img tag like so:
Definition at line 204 of file mailer.php.
| ppMailer_Message::add_header | ( | $ | name, | |
| $ | value | |||
| ) |
Manipulate headers
Definition at line 214 of file mailer.php.
| ppMailer_Message::add_html_part | ( | $ | content | ) |
Definition at line 124 of file mailer.php.
References add_part().
| ppMailer_Message::add_part | ( | $ | content, | |
| $ | mime = 'text/plain' | |||
| ) |
Add message parts (text, HTML, etc)
Definition at line 120 of file mailer.php.
Referenced by add_html_part(), and add_text_part().
| ppMailer_Message::add_recipient | ( | $ | email, | |
| $ | name = '' | |||
| ) |
| ppMailer_Message::add_text_part | ( | $ | content | ) |
Definition at line 128 of file mailer.php.
References add_part().
| ppMailer_Message::add_to | ( | $ | email, | |
| $ | name = '' | |||
| ) |
Definition at line 144 of file mailer.php.
References add_recipient().
| ppMailer_Message::batch_send | ( | ) |
Batch-send the email message. This is used to send out mass mails (newsletter, mailing lists, etc to multiple recipients) but obscure the recipient list so recipients can't see each others' email addresses.
Definition at line 260 of file mailer.php.
References DS.
| ppMailer_Message::get_header | ( | $ | name | ) |
Definition at line 218 of file mailer.php.
| ppMailer_Message::send | ( | ) |
| ppMailer_Message::set_display_callback | ( | $ | fn | ) |
Set a callback function that will be called for each recipient in the delivery list.
Callback prototype: function(string $address, bool $result);
You can also pass in the function as an object/method array, just as you would when calling call_user_func().
Definition at line 232 of file mailer.php.
| ppMailer_Message::set_from | ( | $ | email, | |
| $ | name = '' | |||
| ) |
Set "From:" address
Definition at line 168 of file mailer.php.
| ppMailer_Message::set_reply_to | ( | $ | email, | |
| $ | name = '' | |||
| ) |
Set "Reply-To:" address
Definition at line 180 of file mailer.php.
Member Data Documentation
| ppMailer_Message::$callback |
Definition at line 111 of file mailer.php.
| ppMailer_Message::$charset |
Definition at line 115 of file mailer.php.
| ppMailer_Message::$from |
Definition at line 113 of file mailer.php.
| ppMailer_Message::$message |
Definition at line 108 of file mailer.php.
| ppMailer_Message::$recipients |
Definition at line 109 of file mailer.php.
| ppMailer_Message::$reply_to |
Definition at line 114 of file mailer.php.
| ppMailer_Message::$swift |
Definition at line 107 of file mailer.php.
The documentation for this class was generated from the following file:
- pronto/plugins/page/mailer.php
