eol-style set #3
[core.git] / inc / classes / third_party / php_mailer / README
index f2e2b795fc1710a26f9ba7d92d04fc7cebedfa6c..3f0ee3fa3478ccdbcdcb530671218087f73a5189 100644 (file)
-/*******************************************************************\r
-* The http://phpmailer.codeworxtech.com/ website now carries a few *\r
-* advertisements through the Google Adsense network. Please visit  *\r
-* the advertiser sites and help us offset some of our costs.       *\r
-* Thanks ....                                                      *\r
-********************************************************************/\r
-\r
-PHPMailer\r
-Full Featured Email Transfer Class for PHP\r
-==========================================\r
-\r
-Version 2.3 (November 08, 2008)\r
-\r
-We have removed the /phpdoc from the downloads. All documentation is now on\r
-the http://phpmailer.codeworxtech.com website.\r
-\r
-The phpunit.php has been updated to support PHP5.\r
-\r
-For all other changes and notes, please see the changelog.\r
-\r
-Donations are accepted at PayPal with our id "paypal@worxteam.com".\r
-\r
-Version 2.2 (July 15 2008)\r
-\r
-- see the changelog.\r
-\r
-Version 2.1 (June 04 2008)\r
-\r
-With this release, we are announcing that the development of PHPMailer for PHP5\r
-will be our focus from this date on. We have implemented all the enhancements\r
-and fixes from the latest release of PHPMailer for PHP4.\r
-\r
-Far more important, though, is that this release of PHPMailer (v2.1) is\r
-fully tested with E_STRICT error checking enabled.\r
-\r
-** NOTE: WE HAVE A NEW LANGUAGE VARIABLE FOR DIGITALLY SIGNED S/MIME EMAILS.\r
-   IF YOU CAN HELP WITH LANGUAGES OTHER THAN ENGLISH AND SPANISH, IT WOULD BE\r
-   APPRECIATED.\r
-\r
-We have now added S/MIME functionality (ability to digitally sign emails).\r
-BIG THANKS TO "sergiocambra" for posting this patch back in November 2007.\r
-The "Signed Emails" functionality adds the Sign method to pass the private key\r
-filename and the password to read it, and then email will be sent with\r
-content-type multipart/signed and with the digital signature attached.\r
-\r
-A quick note on E_STRICT:\r
-\r
-- In about half the test environments the development version was subjected\r
-  to, an error was thrown for the date() functions (used at line 1565 and 1569).\r
-  This is NOT a PHPMailer error, it is the result of an incorrectly configured\r
-  PHP5 installation. The fix is to modify your 'php.ini' file and include the\r
-  date.timezone = America/New York\r
-  directive, (for your own server timezone)\r
-- If you do get this error, and are unable to access your php.ini file, there is\r
-  a workaround. In your PHP script, add\r
-  date_default_timezone_set('America/Toronto');\r
-\r
-  * do NOT try to use\r
-  $myVar = date_default_timezone_get();\r
-  as a test, it will throw an error.\r
-\r
-We have also included more example files to show the use of "sendmail", "mail()",\r
-"smtp", and "gmail".\r
-\r
-We are also looking for more programmers to join the volunteer development team.\r
-If you have an interest in this, please let us know.\r
-\r
-Enjoy!\r
-\r
-\r
-Version 2.1.0beta1 & beta2\r
-\r
-please note, this is BETA software\r
-** DO NOT USE THIS IN PRODUCTION OR LIVE PROJECTS\r
-INTENDED STRICTLY FOR TESTING\r
-\r
-** NOTE:\r
-\r
-As of November 2007, PHPMailer has a new project team headed by industry\r
-veteran Andy Prevost (codeworxtech). The first release in more than two\r
-years will focus on fixes, adding ease-of-use enhancements, provide\r
-basic compatibility with PHP4 and PHP5 using PHP5 backwards compatibility\r
-features. A new release is planned before year-end 2007 that will provide\r
-full compatiblity with PHP4 and PHP5, as well as more bug fixes.\r
-\r
-We are looking for project developers to assist in restoring PHPMailer to\r
-its leadership position. Our goals are to simplify use of PHPMailer, provide\r
-good documentation and examples, and retain backward compatibility to level\r
-1.7.3 standards.\r
-\r
-If you are interested in helping out, visit http://sourceforge.net/projects/phpmailer\r
-and indicate your interest.\r
-\r
-**\r
-\r
-http://phpmailer.sourceforge.net/\r
-\r
-This software is licenced under the LGPL.  Please read LICENSE for information on the\r
-software availability and distribution.\r
-\r
-Class Features:\r
-- Send emails with multiple TOs, CCs, BCCs and REPLY-TOs\r
-- Redundant SMTP servers\r
-- Multipart/alternative emails for mail clients that do not read HTML email\r
-- Support for 8bit, base64, binary, and quoted-printable encoding\r
-- Uses the same methods as the very popular AspEmail active server (COM) component\r
-- SMTP authentication\r
-- Native language support\r
-- Word wrap, and more!\r
-\r
-Why you might need it:\r
-\r
-Many PHP developers utilize email in their code.  The only PHP function\r
-that supports this is the mail() function.  However, it does not expose\r
-any of the popular features that many email clients use nowadays like\r
-HTML-based emails and attachments. There are two proprietary\r
-development tools out there that have all the functionality built into\r
-easy to use classes: AspEmail(tm) and AspMail.  Both of these\r
-programs are COM components only available on Windows.  They are also a\r
-little pricey for smaller projects.\r
-\r
-Since I do Linux development I\92ve missed these tools for my PHP coding.\r
-So I built a version myself that implements the same methods (object\r
-calls) that the Windows-based components do. It is open source and the\r
-LGPL license allows you to place the class in your proprietary PHP\r
-projects.\r
-\r
-\r
-Installation:\r
-\r
-Copy class.phpmailer.php into your php.ini include_path. If you are\r
-using the SMTP mailer then place class.smtp.php in your path as well.\r
-In the language directory you will find several files like\r
-phpmailer.lang-en.php.  If you look right before the .php extension\r
-that there are two letters.  These represent the language type of the\r
-translation file.  For instance "en" is the English file and "br" is\r
-the Portuguese file.  Chose the file that best fits with your language\r
-and place it in the PHP include path.  If your language is English\r
-then you have nothing more to do.  If it is a different language then\r
-you must point PHPMailer to the correct translation.  To do this, call\r
-the PHPMailer SetLanguage method like so:\r
-\r
-// To load the Portuguese version\r
-$mail->SetLanguage("br", "/optional/path/to/language/directory/");\r
-\r
-That's it.  You should now be ready to use PHPMailer!\r
-\r
-\r
-A Simple Example:\r
-\r
-<?php\r
-require("class.phpmailer.php");\r
-\r
-$mail = new PHPMailer();\r
-\r
-$mail->IsSMTP();                                      // set mailer to use SMTP\r
-$mail->Host = "smtp1.example.com;smtp2.example.com";  // specify main and backup server\r
-$mail->SMTPAuth = true;     // turn on SMTP authentication\r
-$mail->Username = "jswan";  // SMTP username\r
-$mail->Password = "secret"; // SMTP password\r
-\r
-$mail->From = "from@example.com";\r
-$mail->FromName = "Mailer";\r
-$mail->AddAddress("josh@example.net", "Josh Adams");\r
-$mail->AddAddress("ellen@example.com");                  // name is optional\r
-$mail->AddReplyTo("info@example.com", "Information");\r
-\r
-$mail->WordWrap = 50;                                 // set word wrap to 50 characters\r
-$mail->AddAttachment("/var/tmp/file.tar.gz");         // add attachments\r
-$mail->AddAttachment("/tmp/image.jpg", "new.jpg");    // optional name\r
-$mail->IsHTML(true);                                  // set email format to HTML\r
-\r
-$mail->Subject = "Here is the subject";\r
-$mail->Body    = "This is the HTML message body <b>in bold!</b>";\r
-$mail->AltBody = "This is the body in plain text for non-HTML mail clients";\r
-\r
-if(!$mail->Send())\r
-{\r
-   echo "Message could not be sent. <p>";\r
-   echo "Mailer Error: " . $mail->ErrorInfo;\r
-   exit;\r
-}\r
-\r
-echo "Message has been sent";\r
-?>\r
-\r
-CHANGELOG\r
-\r
-See ChangeLog.txt\r
-\r
-Download: http://sourceforge.net/project/showfiles.php?group_id=26031\r
-\r
-Andy Prevost\r
+/*******************************************************************
+* The http://phpmailer.codeworxtech.com/ website now carries a few *
+* advertisements through the Google Adsense network. Please visit  *
+* the advertiser sites and help us offset some of our costs.       *
+* Thanks ....                                                      *
+********************************************************************/
+
+PHPMailer
+Full Featured Email Transfer Class for PHP
+==========================================
+
+Version 2.3 (November 08, 2008)
+
+We have removed the /phpdoc from the downloads. All documentation is now on
+the http://phpmailer.codeworxtech.com website.
+
+The phpunit.php has been updated to support PHP5.
+
+For all other changes and notes, please see the changelog.
+
+Donations are accepted at PayPal with our id "paypal@worxteam.com".
+
+Version 2.2 (July 15 2008)
+
+- see the changelog.
+
+Version 2.1 (June 04 2008)
+
+With this release, we are announcing that the development of PHPMailer for PHP5
+will be our focus from this date on. We have implemented all the enhancements
+and fixes from the latest release of PHPMailer for PHP4.
+
+Far more important, though, is that this release of PHPMailer (v2.1) is
+fully tested with E_STRICT error checking enabled.
+
+** NOTE: WE HAVE A NEW LANGUAGE VARIABLE FOR DIGITALLY SIGNED S/MIME EMAILS.
+   IF YOU CAN HELP WITH LANGUAGES OTHER THAN ENGLISH AND SPANISH, IT WOULD BE
+   APPRECIATED.
+
+We have now added S/MIME functionality (ability to digitally sign emails).
+BIG THANKS TO "sergiocambra" for posting this patch back in November 2007.
+The "Signed Emails" functionality adds the Sign method to pass the private key
+filename and the password to read it, and then email will be sent with
+content-type multipart/signed and with the digital signature attached.
+
+A quick note on E_STRICT:
+
+- In about half the test environments the development version was subjected
+  to, an error was thrown for the date() functions (used at line 1565 and 1569).
+  This is NOT a PHPMailer error, it is the result of an incorrectly configured
+  PHP5 installation. The fix is to modify your 'php.ini' file and include the
+  date.timezone = America/New York
+  directive, (for your own server timezone)
+- If you do get this error, and are unable to access your php.ini file, there is
+  a workaround. In your PHP script, add
+  date_default_timezone_set('America/Toronto');
+
+  * do NOT try to use
+  $myVar = date_default_timezone_get();
+  as a test, it will throw an error.
+
+We have also included more example files to show the use of "sendmail", "mail()",
+"smtp", and "gmail".
+
+We are also looking for more programmers to join the volunteer development team.
+If you have an interest in this, please let us know.
+
+Enjoy!
+
+
+Version 2.1.0beta1 & beta2
+
+please note, this is BETA software
+** DO NOT USE THIS IN PRODUCTION OR LIVE PROJECTS
+INTENDED STRICTLY FOR TESTING
+
+** NOTE:
+
+As of November 2007, PHPMailer has a new project team headed by industry
+veteran Andy Prevost (codeworxtech). The first release in more than two
+years will focus on fixes, adding ease-of-use enhancements, provide
+basic compatibility with PHP4 and PHP5 using PHP5 backwards compatibility
+features. A new release is planned before year-end 2007 that will provide
+full compatiblity with PHP4 and PHP5, as well as more bug fixes.
+
+We are looking for project developers to assist in restoring PHPMailer to
+its leadership position. Our goals are to simplify use of PHPMailer, provide
+good documentation and examples, and retain backward compatibility to level
+1.7.3 standards.
+
+If you are interested in helping out, visit http://sourceforge.net/projects/phpmailer
+and indicate your interest.
+
+**
+
+http://phpmailer.sourceforge.net/
+
+This software is licenced under the LGPL.  Please read LICENSE for information on the
+software availability and distribution.
+
+Class Features:
+- Send emails with multiple TOs, CCs, BCCs and REPLY-TOs
+- Redundant SMTP servers
+- Multipart/alternative emails for mail clients that do not read HTML email
+- Support for 8bit, base64, binary, and quoted-printable encoding
+- Uses the same methods as the very popular AspEmail active server (COM) component
+- SMTP authentication
+- Native language support
+- Word wrap, and more!
+
+Why you might need it:
+
+Many PHP developers utilize email in their code.  The only PHP function
+that supports this is the mail() function.  However, it does not expose
+any of the popular features that many email clients use nowadays like
+HTML-based emails and attachments. There are two proprietary
+development tools out there that have all the functionality built into
+easy to use classes: AspEmail(tm) and AspMail.  Both of these
+programs are COM components only available on Windows.  They are also a
+little pricey for smaller projects.
+
+Since I do Linux development I\92ve missed these tools for my PHP coding.
+So I built a version myself that implements the same methods (object
+calls) that the Windows-based components do. It is open source and the
+LGPL license allows you to place the class in your proprietary PHP
+projects.
+
+
+Installation:
+
+Copy class.phpmailer.php into your php.ini include_path. If you are
+using the SMTP mailer then place class.smtp.php in your path as well.
+In the language directory you will find several files like
+phpmailer.lang-en.php.  If you look right before the .php extension
+that there are two letters.  These represent the language type of the
+translation file.  For instance "en" is the English file and "br" is
+the Portuguese file.  Chose the file that best fits with your language
+and place it in the PHP include path.  If your language is English
+then you have nothing more to do.  If it is a different language then
+you must point PHPMailer to the correct translation.  To do this, call
+the PHPMailer SetLanguage method like so:
+
+// To load the Portuguese version
+$mail->SetLanguage("br", "/optional/path/to/language/directory/");
+
+That's it.  You should now be ready to use PHPMailer!
+
+
+A Simple Example:
+
+<?php
+require("class.phpmailer.php");
+
+$mail = new PHPMailer();
+
+$mail->IsSMTP();                                      // set mailer to use SMTP
+$mail->Host = "smtp1.example.com;smtp2.example.com";  // specify main and backup server
+$mail->SMTPAuth = true;     // turn on SMTP authentication
+$mail->Username = "jswan";  // SMTP username
+$mail->Password = "secret"; // SMTP password
+
+$mail->From = "from@example.com";
+$mail->FromName = "Mailer";
+$mail->AddAddress("josh@example.net", "Josh Adams");
+$mail->AddAddress("ellen@example.com");                  // name is optional
+$mail->AddReplyTo("info@example.com", "Information");
+
+$mail->WordWrap = 50;                                 // set word wrap to 50 characters
+$mail->AddAttachment("/var/tmp/file.tar.gz");         // add attachments
+$mail->AddAttachment("/tmp/image.jpg", "new.jpg");    // optional name
+$mail->IsHTML(true);                                  // set email format to HTML
+
+$mail->Subject = "Here is the subject";
+$mail->Body    = "This is the HTML message body <b>in bold!</b>";
+$mail->AltBody = "This is the body in plain text for non-HTML mail clients";
+
+if(!$mail->Send())
+{
+   echo "Message could not be sent. <p>";
+   echo "Mailer Error: " . $mail->ErrorInfo;
+   exit;
+}
+
+echo "Message has been sent";
+?>
+
+CHANGELOG
+
+See ChangeLog.txt
+
+Download: http://sourceforge.net/project/showfiles.php?group_id=26031
+
+Andy Prevost