This library offers an object oriented way to send email from a PHP program.
This script is distributed under the GPL
License
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
This script is a fork of libMail, originally written by
Leo West. The code was forked
from version 1.4.1 released by
Setec Astronomy. Main additions
in libMail2008 include support for composing e-mail in additional MIME formats:
multipart/alternative
(HTML and alternate text for e-mail clients without HTML support) and
multipart/related (HTML with embedded images).
Original script by Leo West - west_leo@yahoo.com
URL: http://lwest.free.fr/doc/php/lib/Mail/
Lastmod : Nov 2001
Version : 1.3
Modified by Setec Astronomy - setec@freemail.it
URL : http://digilander.iol.it/setecastronomy/
Lastmod : Jan 2004
Version : 1.4.1
Modified by Pier Luigi Pau - pigipau@gmail.com
URL : http://eregil.altervista.org/
Lastmod : Jan 2013
Version : 1.7.0
Some of the libMail functionalities are:
version 1.7.0
version 1.6.2
Beginning with this release, only the PHP 5 flavour is maintained. PHP 4 users must resort to version 1.6.1 or earlier.
version 1.6.1
Maintenance release.
version 1.6.0
Support for multipart/related MIME format introduced. It is possible to attach images and use them in the HTML body of an e-mail message, thus avoiding remote loading images from a web server.
version 1.5.0
This version is released at the same time as 1.4.2; whereas 1.4.2 attempts to be a drop-in replacement for 1.4.1 (no radical interface change), this version adds some non-trivial functionality, namely multipart/alternative support. Thus, the way you send your HTML mail will have to be changed starting with this version.
version 1.4.2
This version tries to be a drop-in replacement of 1.4.1, but in any case, testing is strongly advised rather than simply replacing your libmail.php on a production server.
version 1.4.1
version 1.4
version 1.3
version 1.2
version 1.1
include "libmail.php";
$m= new Mail; // create the mail
$m->From ("leo@isp.com");
$m->To ("destination@somewhere.fr");
$m->Subject ("the subject of the mail");
$m->Body ("Hello\nThis is a test of the Mail component"); // set the body
$m->Cc ("someone@somewhere.fr");
$m->Bcc ("someoneelse@somewhere.fr");
$m->Priority (4) ; // set the priority to Low
$m->Attach ("/home/leo/toto.gif", "image/gif", "inline") ; // attach a file of type image/gif to be displayed in the message if possible
$m->Send (); // send the mail
echo "Mail was sent:<br><pre>", $m->Get (), "</pre>";
Download Libmail2008 from the URL in the Authors section.
Content:
Please note: multiple versions of libMail may be packaged together. However, each version is to be considered as a separate work, which may be redistributed under the GPL. In other words, you may redistribute, alter (and re-release under the GPL) or deploy a single version of the script even if you received or downloaded a package containing multiple versions.
No specific configuration is required in the library itself. In php.ini:
SMTP = smtp@isp.com ; for win32 only sendmail_from = valid_address@chezmoi.fr ;for win32 only
Create an instance of a Mail.
$mail = new Mail ();
Defines the mail subject line. optional.
$mail->Subject ("Hello world!");
Defines the mail sender. call required. You can also specify the sender name.
$mail->From( "me@isp.com" ); $mail->From( "me@isp.com", "Me at ISP" );
Defines the recipient(s). call required. The address parameter can be either an address (string) or an array of addresses. You can also specify the recipient(s) name.
$mail->To ("you@isp.com");
$tos = array ("you@isp.com", "u2@isp.com");
$mail->To ($tos);
$tos = array ("you@isp.com" => "You at ISP", "u2@isp.com" => "U2 at ISP"); // DEPRECATED AS OF 1.4.2
$mail->To ($tos);
$tos = array ("You at ISP <you@isp.com>", "U2 at ISP <u2@isp.com>");
$mail->To ($tos);
Defines one or many Carbon-copy recipients. The address parameter can be either an email adress (string) or an array of addresses. You can also specify the recipient(s) name.
$mail->CC ("you@isp.com");
$ccs = array ("you@isp.com", "u2@isp.com");
$mail->CC ($ccs);
$ccs = array ("you@isp.com" => "You at ISP", "u2@isp.com" => "U2 at ISP"); // DEPRECATED AS OF 1.4.2
$mail->CC ($ccs);
$ccs = array ("You at ISP <you@isp.com>", "U2 at ISP <u2@isp.com>");
$mail->CC ($ccs);
Defines one or many invisible carbon-copy recipients. The address parameter can be either an email adress (string) or an array of addresses. You can also specify the recipient(s) name.
$mail->BCC ("you@isp.com");
$bccs = array ("you@isp.com", "u2@isp.com");
$mail->BCC ($bccs);
$bccs = array ("you@isp.com" => "You at ISP", "u2@isp.com" => "U2 at ISP"); // DEPRECATED AS OF 1.4.2
$mail->BCC ($bccs);
$bccs = array ("You at ISP <you@isp.com>", "U2 at ISP <u2@isp.com>");
$mail->BCC ($bccs);
Defines the message body. the optional charset parameter defines the character set used in the message. The default is "us-ascii". Use iso-8859-1 charset if your message includes european characters such as accents.
$mail->Body ("Message in english");
$mail->Body ("Message avé dé accents", "iso-8859-1");
Note: Don't send HTML this way. See Advices to send a mail
in HTML format.
Alias of Body(). Available since 1.5.0
Defines the message body in HTML version. See Advices for examples.
The optional charset parameter works the same as in the Body() method.
Please note that only the last specified charset, among all methods called, is used for
each e-mail; you cannot use different charsets for text and HTML.
Available since 1.5.0
Defines the character set used in the message. Can be used as an alternative to the
optional charset parameter in Body() and Html(). Please note that only the last specified
charset, among all methods called, is used for each e-mail.
Available since 1.5.0
$mail->SetCharset ("iso-8859-1");
Attach a file $filepath to the mail.
$mail->Attach ("logo.gif", "image/gif");
$mail->Attach ("C:\\My Documents\\resume.doc", "application/x-msword", "attachment");
$mail->Attach ("C:\\My Documents\\resume.doc", "application/x-msword", "attachment", "cv.doc");
Create a file from string $content and attach it to the mail (the file will not be automatically stored!). Available since 1.4.2
$some_content = "A text file containing this string will be created and attached.\n"; $mail->AttachString($some_content, "text/plain", "attachment", "some_text.txt");
Attach a file $filepath to the e-mail to be used as an embedded image in an HTML e-mail. Returns a content-id needed to form a cid: URI for the src attribute of the <img> tag (see example).
Please note: files attached with Relate() and RelateString() are ignored if the Html() method is not called. Html() should be called after attaching all the images you want to embed in the e-mail.
This method is available since version 1.6.0
$mycontentid = $mail->Relate ("logo.gif", "image/gif");
$mail->Html ("...some HTML... <img src=\"cid:$mycontentid\" alt=\"text\"> ...some HTML...");
Create a file from string $content and attach it to the mail to be used as an embedded image in an HTML e-mail (the file will not be automatically stored!). See also Relate().
RelateString should be used instead of Relate in the case of images created by GD functions. The correct way to integrate GD functions with RelateString is as follows:
See also the example.
This method is available since version 1.6.0
$im = @imagecreatetruecolor(160, 120) or die("Cannot Initialize new GD image stream");
(...some image editing with GD functions...)
ob_start();
imagepng($im);
$imagevariable = ob_get_contents();
ob_end_clean();
$cid = $mail->RelateString($imagevariable, "image/png", "image.png");
$imagevariable = null;
Defines the Organization field. Optional.
$mail->Organization ("My company");
Defines a "Reply To" address that is different than the Sender address. You can also specify the Reply To name.
Defines a "Return Path" address that is different than the Sender address. You can also specify the Return Path name.
$mail->ReturnPath ("answer@mycompany.com");
$mail->ReturnPath ("answer@mycompany.com", "My Company Support");
Defines the mail priority. Optional.
priority must be an integer between 1 (highest) and 5 (lowest). This information is usually used by mail clients, eg. by highlighting urgent messages.
$mail->Priority (1); // urgent $mail->Priority (3); // normal $mail->Priority (5); // lowest priority $mail->Priority (1, Mail::priority_full); // urgent, use all priority headers
The priority_type parameter was added in version 1.7.0. It is used in the same way as in UsePriority(). See UsePriority() for its usage. The default value is Mail::priority_xpr.
Defines which priority headers will be used. Optional.
Parameter priority_type should be one of the following constants, which correspond to using one or more priority headers.
Please note that X-MSMail-Priority and Importance make no difference between priority 1 and 2 (higher than normal), or between priority 4 and 5 (lower than normal).
It is possible to combine single headers by using the bitwise-or operator, e.g. the following sets libmail2008 to use the X-Priority and X-MSMail-Priority headers:
Mail::priority_xpr | Mail::priority_msm
Examples of use:
$mail->UsePriority (Mail::priority_xpr); // use X-Priority only $mail->UsePriority (Mail::priority_full); // use all headers $mail->UsePriority (Mail::priority_xpr | Mail::priority_msm); // use X-Priority and X-MSMail-Priority
Recommended for use are Mail::priority_xpr (uses only X-Priority) or Mail::priority_full (uses all priority headers).
This method is available since version 1.7.0
Add a receipt to the mail. This is a mechanism that sends a receipt back to
sender when the message is opened by a recipient. The receipt is sent to the
address defined in From field, unless if ReplyTo field is defined.
The flag parameter was added in version 1.5.0; it defaults to true. If set to false,
it cancels any previous call of the Receipt() method, i.e. no longer sends a receipt request.
$mail->Receipt (); $mail->Receipt (false); // I changed my mind (1.5.0 and up)Warning: this mechanism is not standardised, thus not fully supported by mail clients.
This method is used to set X-Headers according to information from $_SERVER. These add the originating client IP address, proxy server and user agent as X-HTTP-Posting-Host, X-HTTP-Proxy-Server and X-HTTP-Posting-UserAgent, respectively.
These X-Headers may be useful if you, as the webmaster, are to receive mail and want this information to be in the headers for whatever reason.
If used in a context where the $_SERVER superglobal is present, this method should simply be called without parameters:
$mail->AntiSpaming ();
Otherwise, you can write values yourself by passing strings as arguments. Use false (or a non-string) as an argument to unset the respective X-Header.
Please note:
If you deploy libmail2008 you are strongly encouraged not to misuse
this feature.
Website visitors should not be entrusted with control
over these X-Headers.
Do not pass user input, e.g. from $_GET or $_POST,
as parameters to this method.
If you receive e-mail with these X-Headers set, please note that, not unlike the From header, they can be forged, and as such they represent no proof of the real origin of the e-mail.
Send the mail. Don't forget to call this method :)
$mail->Send ();
Return the whole email (headers + message + attachments) in raw format. Can be used to display the mail, or to save it in a File or DB.
In version 1.4.2 and below, the full_headers parameter is not available; Subject and To headers are not included in the return value.
In version 1.5.0 and above, the full_headers parameter determines whether
Subject and To headers should be included in the return value.
true: Subject and To headers are included in the return value (this is the default).
false: they are not included (1.4.x-like behaviour).
In other words, starting with version 1.5.0, Subject and To are included in the return value, but you can call Get(false) to force 1.4.x-like behaviour.
$msg = $mail->Get ();
// display the message on the page echo "Your message has been sent:<br><pre>", nl2br( $msg ) , "</pre>";
// log it in a database
$msg = str_replace ("'", "''", $msg);
$bdd->exec ("insert into Mailbox( user, folder, message, senttime ) values ( 'toto', 'Sent', '$msg', $FCT_CURRENT_TIME");
Please note: some users hate receiving e-mail in HTML format.
To send a HTML mail with libMail 1.4.x and below, you must attach your HTML source as a file:
$file = "mail.html";
$mail->Body ("This mail is formatted in HTML - shame on me");
// inline intructs the mail client to display the HTML if it can
$mail->Attach ($file, "text/html", "inline");
With libMail 1.4.2, you don't need to save your HTML as a file first; you can take advantage of the new AttachString method:
$html_content = "<html>...</html>";
$mail->Body ("This mail is formatted in HTML - shame on me");
$mail->AttachString ($html_content, "text/html", "inline");
A bug in libMail 1.4.1 and below also allowed users to send HTML mail like this:
$html_content = "<html>...</html>";
$mail->Body ($html_content);
$mail->Attach ("noattach"); // or any non-existent file
This resulted in a broken e-mail message, which some clients and webmails were
able to display "correctly" nonetheless, while other clients failed.
As version 1.4.2 tries to be a drop-in replacement for 1.4.1, it includes a kludge
so that this broken functionality is kept, so long as the e-mail begins with an <html>
tag (or <? or <!); this kludge is removed in version 1.5.0. You should not rely on this method to
send HTML mail, as the resulting e-mails will not be displayed correctly
by some users, even if they have an HTML-enabled e-mail client.
Starting with libMail 1.5.0, the methods described above are deprecated (including the "good" ones). You should instead take advantage of the new Html() method, as well as include a plain text alternative:
$text_content = "Hello, world!\n"; $html_content = "<html><body><p>Hello, world!</p></body></html>"; $mail->Body ($text_content); $mail->Html ($html_content);
This will create an e-mail with a multipart/alternative section that includes the two versions of your content. While you may use Html() alone without setting a plain text Body(), this is not recommended. Also, don't use Body() for HTML content.
If your HTML page contains some images or links don't forget either to:
<head> <base href="http://chez.moi.com/"> </head>
| Name | libmail2008 |
| Lang | php5 |
| Version | 1.7.0 |
| Lastmod | Mon Jan 21 14:04 GMT 2013 |
| Authors | Leo West, Setec Astronomy, Pier Luigi Pau |