Public Member Functions | |
| __construct ($src, $dest, $subject, $encoding='UTF-8', $crlf="\n") | |
| addTextMessage ($msg) | |
| setReturnPath ($email) | |
| addHeaders ($hdrs) | |
| addHtmlMessage ($msg) | |
| addAttachment ($file, $ctype='text/plain') | |
| sendMail () | |
Public Attributes | |
| $headers = array() | |
| $message | |
| $encoding = 'utf-8' | |
| $to_address = '' | |
This class is just a small wrapper around the PEAR packages Mail and Mail/mime.
Class to easily generate multipart emails. It supports embedded images within the email. It can be used to send a text with possible attachments.
The encoding of the message is utf-8 by default.
Usage example: $email = new Pluf_Mail('from_email.com', 'to_email.com', 'Subject of the message'); $img_id = $email->addAttachment('/var/www/html/img/pic.jpg', 'image/jpg'); $email->addTextMessage('Hello world!'); $email->addHtmlMessage('<html><body>Hello world!</body></html>'); $email->sendMail();
The configuration parameters are the one for Mail::factory with the 'mail_' prefix not to conflict with the other parameters.
'mail_backend' - 'mail', 'smtp' or 'sendmail' (default 'mail').
List of parameter for the backends:
mail backend --------------
If safe mode is disabled, an array with all the 'mail_*' parameters excluding 'mail_backend' will be passed as the fifth argument to the PHP mail() function. The elements will be joined as a space-delimited string.
sendmail backend ------------------
'mail_sendmail_path' - The location of the sendmail program on the filesystem. Default is /usr/bin/sendmail 'sendmail_args' - Additional parameters to pass to the sendmail. Default is -i
smtp backend --------------
'mail_host' - The server to connect. Default is localhost 'mail_port' - The port to connect. Default is 25 'mail_auth' - Whether or not to use SMTP authentication. Default is FALSE
'mail_username' - The username to use for SMTP authentication. 'mail_password' - The password to use for SMTP authentication. 'mail_localhost' - The value to give when sending EHLO or HELO. Default is localhost 'mail_timeout' - The SMTP connection timeout. Default is NULL (no timeout) 'mail_verp' - Whether to use VERP or not. Default is FALSE 'mail_debug' - Whether to enable SMTP debug mode or not. Default is FALSE 'mail_persist' - Indicates whether or not the SMTP connection should persist over multiple calls to the send() method.
If you are doing some testing, you should use the smtp backend together with fakemail: http://www.lastcraft.com/fakemail.php
| Pluf_Mail::__construct | ( | $ | src, | |
| $ | dest, | |||
| $ | subject, | |||
| $ | encoding = 'UTF-8', |
|||
| $ | crlf = "\n" | |||
| ) |
Construct the base email.
| string | The email of the sender. | |
| string | The destination email. | |
| string | The subject of the message. | |
| string | Encoding of the message ('UTF-8') | |
| string | End of line type ("\n") |
| Pluf_Mail::addTextMessage | ( | $ | msg | ) |
Add the base plain text message to the email.
| string | The message |
| Pluf_Mail::setReturnPath | ( | $ | ) |
Set the return path for the email.
| string |
| Pluf_Mail::addHeaders | ( | $ | hdrs | ) |
Add headers to an email.
| array | Array of headers |
| Pluf_Mail::addHtmlMessage | ( | $ | msg | ) |
Add the alternate HTML message to the email.
| string | The HTML message |
| Pluf_Mail::addAttachment | ( | $ | file, | |
| $ | ctype = 'text/plain' | |||
| ) |
Add an attachment to the message.
The file to attach must be available on disk and you need to provide the mimetype of the attachment manually.
| string | Path to the file to be added. | |
| string | Mimetype of the file to be added ('text/plain'). |
| Pluf_Mail::sendMail | ( | ) |
Effectively sends the email.
| Pluf_Mail::$headers = array() |
| Pluf_Mail::$message |
| Pluf_Mail::$encoding = 'utf-8' |
| Pluf_Mail::$to_address = '' |