Merge branch 'MDL-41311-master' of git://github.com/danpoltawski/moodle
[moodle.git] / lib / phpmailer / changelog.txt
1 ChangeLog
3 NOTE: THIS VERSION OF PHPMAILER IS DESIGNED FOR PHP5/PHP6.
4       IT WILL NOT WORK WITH PHP4.
6 Version 5.2.1 (January 16, 2012)
7 * Closed several bugs
8 * Performance improvements
9 * MsgHTML() now returns the message as required.
10 * New method: GetSentMIMEMessage() (returns full copy of sent message)
12 Version 5.2 (July 19, 2011)
13 * protected MIME body and header
14 * better DKIM DNS Resource Record support
15 * better aly handling
16 * htmlfilter class added to extras
17 * moved to Apache Extras
19 Version 5.1 (October 20, 2009)
20 * fixed filename issue with AddStringAttachment (thanks to Tony)
21 * fixed "SingleTo" property, now works with Senmail, Qmail, and SMTP in
22   addition to PHP mail()
23 * added DKIM digital signing functionality
24   New properties:
25   - DKIM_domain (sets the domain name)
26   - DKIM_private (holds DKIM private key)
27   - DKIM_passphrase (holds your DKIM passphrase)
28   - DKIM_selector (holds the DKIM "selector")
29   - DKIM_identity (holds the identifying email address)
30 * added callback function support
31   - callback function parameters include:
32     result, to, cc, bcc, subject and body
33   * see the test/test_callback.php file for usage.
34 * added "auto" identity functionality
35   - can automatically add:
36     - Return-path (if Sender not set)
37     - Reply-To (if ReplyTo not set)
38   - can be disabled:
39     - $mail->SetFrom('yourname@yourdomain.com','First Last',false);
40     - or by adding the $mail->Sender and/or $mail->ReplyTo properties
41   Note: "auto" identity added to help with emails ending up in spam
42   or junk boxes because of missing headers
44 Version 5.0.2 (May 24, 2009)
45 * Fix for missing attachments when inline graphics are present
46 * Fix for missing Cc in header when using SMTP (mail was sent,
47   but not displayed in header -- Cc receiver only saw email To: 
48   line and no Cc line, but did get the email (To receiver
49   saw same)
51 Version 5.0.1 (April 05, 2009)
52 * Temporary fix for missing attachments
54 Version 5.0.0 (April 02, 2009)
56 * With the release of this version, we are initiating a new version numbering
57   system to differentiate from the PHP4 version of PHPMailer.
58 * Most notable in this release is fully object oriented code.
59 class.smtp.php:
60 * Refactored class.smtp.php to support new exception handling
61   code size reduced from 29.2 Kb to 25.6 Kb
62 * Removed unnecessary functions from class.smtp.php:
63   public function Expand($name) {
64   public function Help($keyword="") {
65   public function Noop() {
66   public function Send($from) {
67   public function SendOrMail($from) {
68   public function Verify($name) {
69 class.phpmailer.php:
70 * Refactored class.phpmailer.php with new exception handling
71 * Changed processing functionality of Sendmail and Qmail so they cannot be
72   inadvertently used
73 * removed getFile() function, just became a simple wrapper for
74   file_get_contents()
75 * added check for PHP version (will gracefully exit if not at least PHP 5.0)
76 class.phpmailer.php enhancements
77 * enhanced code to check if an attachment source is the same as an embedded or
78   inline graphic source to eliminate duplicate attachments
79 New /test_script
80 * We have written a test script you can use to test the script as part of your
81   installation. Once you press submit, the test script will send a multi-mime
82   email with either the message you type in or an HTML email with an inline
83   graphic. Two attachments are included in the email (one of the attachments
84   is also the inline graphic so you can see that only one copy of the graphic
85   is sent in the email). The test script will also display the functional
86   script that you can copy/paste to your editor to duplicate the functionality.
87 New examples
88 * All new examples in both basic and advanced modes. Advanced examples show
89   Exception handling.
90 PHPDocumentator (phpdocs) documentation for PHPMailer version 5.0.0
91 * all new documentation
93 Please note: the website has been updated to reflect the changes in PHPMailer
94 version 5.0.0. http://phpmailer.codeworxtech.com/
96 Version 2.3 (November 06, 2008)
98 * added Arabic language (many thanks to Bahjat Al Mostafa)
99 * removed English language from language files and made it a default within
100   class.phpmailer.php - if no language is found, it will default to use
101   the english language translation
102 * fixed public/private declarations
103 * corrected line 1728, $basedir to $directory
104 * added $sign_cert_file to avoid improper duplicate use of $sign_key_file
105 * corrected $this->Hello on line 612 to $this->Helo
106 * changed default of $LE to "\r\n" to comply with RFC 2822. Can be set by the user
107   if default is not acceptable
108 * removed trim() from return results in EncodeQP
109 * /test and three files it contained are removed from version 2.3
110 * fixed phpunit.php for compliance with PHP5
111 * changed $this->AltBody = $textMsg; to $this->AltBody = html_entity_decode($textMsg);
112 * We have removed the /phpdoc from the downloads. All documentation is now on
113   the http://phpmailer.codeworxtech.com website.
115 Version 2.2.1 () July 19 2008
117 * fixed line 1092 in class.smtp.php (my apologies, error on my part)
119 Version 2.2 () July 15 2008
121 * Fixed redirect issue (display of UTF-8 in thank you redirect)
122 * fixed error in getResponse function declaration (class.pop3.php)
123 * PHPMailer now PHP6 compliant
124 * fixed line 1092 in class.smtp.php (endless loop from missing = sign)
126 Version 2.1 (Wed, June 04 2008)
128 ** NOTE: WE HAVE A NEW LANGUAGE VARIABLE FOR DIGITALLY SIGNED S/MIME EMAILS.
129    IF YOU CAN HELP WITH LANGUAGES OTHER THAN ENGLISH AND SPANISH, IT WOULD BE
130    APPRECIATED.
132 * added S/MIME functionality (ability to digitally sign emails)
133   BIG THANKS TO "sergiocambra" for posting this patch back in November 2007.
134   The "Signed Emails" functionality adds the Sign method to pass the private key
135   filename and the password to read it, and then email will be sent with
136   content-type multipart/signed and with the digital signature attached.
137 * fully compatible with E_STRICT error level
138   - Please note:
139     In about half the test environments this development version was subjected
140     to, an error was thrown for the date() functions used (line 1565 and 1569).
141     This is NOT a PHPMailer error, it is the result of an incorrectly configured
142     PHP5 installation. The fix is to modify your 'php.ini' file and include the
143     date.timezone = America/New York
144     directive, to your own server timezone
145   - If you do get this error, and are unable to access your php.ini file:
146     In your PHP script, add
147     date_default_timezone_set('America/Toronto');
148     - do not try to use
149     $myVar = date_default_timezone_get();
150     as a test, it will throw an error.
151 * added ability to define path (mainly for embedded images)
152   function MsgHTML($message,$basedir='') ... where:
153   $basedir is the fully qualified path
154 * fixed MsgHTML() function:
155   - Embedded Images where images are specified by <protocol>:// will not be altered or embedded
156 * fixed the return value of SMTP exit code ( pclose )
157 * addressed issue of multibyte characters in subject line and truncating
158 * added ability to have user specified Message ID
159   (default is still that PHPMailer create a unique Message ID)
160 * corrected unidentified message type to 'application/octet-stream'
161 * fixed chunk_split() multibyte issue (thanks to Colin Brown, et al).
162 * added check for added attachments
163 * enhanced conversion of HTML to text in MsgHTML (thanks to "brunny")
165 Version 2.1.0beta2 (Sun, Dec 02 2007)
166 * implemented updated EncodeQP (thanks to coolbru, aka Marcus Bointon)
167 * finished all testing, all known bugs corrected, enhancements tested
168 - note: will NOT work with PHP4.
170 please note, this is BETA software
171 ** DO NOT USE THIS IN PRODUCTION OR LIVE PROJECTS
172 INTENDED STRICTLY FOR TESTING
174 Version 2.1.0beta1
175 please note, this is BETA software
176 ** DO NOT USE THIS IN PRODUCTION OR LIVE PROJECTS
177 INTENDED STRICTLY FOR TESTING
179 Version 2.0.0 rc2 (Fri, Nov 16 2007), interim release
180 * implements new property to control VERP in class.smtp.php
181   example (requires instantiating class.smtp.php):
182   $mail->do_verp = true;
183 * POP-before-SMTP functionality included, thanks to Richard Davey
184   (see class.pop3.php & pop3_before_smtp_test.php for examples)
185 * included example showing how to use PHPMailer with GMAIL
186 * fixed the missing Cc in SendMail() and Mail()
188 ******************
189 A note on sending bulk emails:
191 If the email you are sending is not personalized, consider using the
192 "undisclosed-recipient:;" strategy. That is, put all of your recipients
193 in the Bcc field and set the To field to "undisclosed-recipients:;".
194 It's a lot faster (only one send) and saves quite a bit on resources.
195 Contrary to some opinions, this will not get you listed in spam engines -
196 it's a legitimate way for you to send emails.
198 A partial example for use with PHPMailer:
200 $mail->AddAddress("undisclosed-recipients:;");
201 $mail->AddBCC("email1@anydomain.com,email2@anyotherdomain.com,email3@anyalternatedomain.com");
203 Many email service providers restrict the number of emails that can be sent
204 in any given time period. Often that is between 50 - 60 emails maximum
205 per hour or per send session.
207 If that's the case, then break up your Bcc lists into chunks that are one
208 less than your limit, and put a pause in your script.
209 *******************
211 Version 2.0.0 rc1 (Thu, Nov 08 2007), interim release
212 * dramatically simplified using inline graphics ... it's fully automated and requires no user input
213 * added automatic document type detection for attachments and pictures
214 * added MsgHTML() function to replace Body tag for HTML emails
215 * fixed the SendMail security issues (input validation vulnerability)
216 * enhanced the AddAddresses functionality so that the "Name" portion is used in the email address
217 * removed the need to use the AltBody method (set from the HTML, or default text used)
218 * set the PHP Mail() function as the default (still support SendMail, SMTP Mail)
219 * removed the need to set the IsHTML property (set automatically)
220 * added Estonian language file by Indrek P&auml;ri
221 * added header injection patch
222 * added "set" method to permit users to create their own pseudo-properties like 'X-Headers', etc.
223   example of use:
224   $mail->set('X-Priority', '3');
225   $mail->set('X-MSMail-Priority', 'Normal');
226 * fixed warning message in SMTP get_lines method
227 * added TLS/SSL SMTP support
228   example of use:
229   $mail = new PHPMailer();
230   $mail->Mailer = "smtp";
231   $mail->Host = "smtp.example.com";
232   $mail->SMTPSecure   = "tls"; // option
233   //$mail->SMTPSecure   = "ssl";  // option
234   ...
235   $mail->Send();
236 * PHPMailer has been tested with PHP4 (4.4.7) and PHP5 (5.2.7)
237 * Works with PHP installed as a module or as CGI-PHP
238 - NOTE: will NOT work with PHP5 in E_STRICT error mode
240 Version 1.73 (Sun, Jun 10 2005)
241 * Fixed denial of service bug: http://www.cybsec.com/vuln/PHPMailer-DOS.pdf
242 * Now has a total of 20 translations
243 * Fixed alt attachments bug: http://tinyurl.com/98u9k
245 Version 1.72 (Wed, May 25 2004)
246 * Added Dutch, Swedish, Czech, Norwegian, and Turkish translations.
247 * Received: Removed this method because spam filter programs like
248 SpamAssassin reject this header.
249 * Fixed error count bug.
250 * SetLanguage default is now "language/".
251 * Fixed magic_quotes_runtime bug.
253 Version 1.71 (Tue, Jul 28 2003)
254 * Made several speed enhancements
255 * Added German and Italian translation files
256 * Fixed HELO/AUTH bugs on keep-alive connects
257 * Now provides an error message if language file does not load
258 * Fixed attachment EOL bug
259 * Updated some unclear documentation
260 * Added additional tests and improved others
262 Version 1.70 (Mon, Jun 20 2003)
263 * Added SMTP keep-alive support
264 * Added IsError method for error detection
265 * Added error message translation support (SetLanguage)
266 * Refactored many methods to increase library performance
267 * Hello now sends the newer EHLO message before HELO as per RFC 2821
268 * Removed the boundary class and replaced it with GetBoundary
269 * Removed queue support methods
270 * New $Hostname variable
271 * New Message-ID header
272 * Received header reformat
273 * Helo variable default changed to $Hostname
274 * Removed extra spaces in Content-Type definition (#667182)
275 * Return-Path should be set to Sender when set
276 * Adds Q or B encoding to headers when necessary
277 * quoted-encoding should now encode NULs \000
278 * Fixed encoding of body/AltBody (#553370)
279 * Adds "To: undisclosed-recipients:;" when all recipients are hidden (BCC)
280 * Multiple bug fixes
282 Version 1.65 (Fri, Aug 09 2002)
283 * Fixed non-visible attachment bug (#585097) for Outlook
284 * SMTP connections are now closed after each transaction
285 * Fixed SMTP::Expand return value
286 * Converted SMTP class documentation to phpDocumentor format
288 Version 1.62 (Wed, Jun 26 2002)
289 * Fixed multi-attach bug
290 * Set proper word wrapping
291 * Reduced memory use with attachments
292 * Added more debugging
293 * Changed documentation to phpDocumentor format
295 Version 1.60 (Sat, Mar 30 2002)
296 * Sendmail pipe and address patch (Christian Holtje)
297 * Added embedded image and read confirmation support (A. Ognio)
298 * Added unit tests
299 * Added SMTP timeout support (*nix only)
300 * Added possibly temporary PluginDir variable for SMTP class
301 * Added LE message line ending variable
302 * Refactored boundary and attachment code
303 * Eliminated SMTP class warnings
304 * Added SendToQueue method for future queuing support
306 Version 1.54 (Wed, Dec 19 2001)
307 * Add some queuing support code
308 * Fixed a pesky multi/alt bug
309 * Messages are no longer forced to have "To" addresses
311 Version 1.50 (Thu, Nov 08 2001)
312 * Fix extra lines when not using SMTP mailer
313 * Set WordWrap variable to int with a zero default
315 Version 1.47 (Tue, Oct 16 2001)
316 * Fixed Received header code format
317 * Fixed AltBody order error
318 * Fixed alternate port warning
320 Version 1.45 (Tue, Sep 25 2001)
321 * Added enhanced SMTP debug support
322 * Added support for multiple ports on SMTP
323 * Added Received header for tracing
324 * Fixed AddStringAttachment encoding
325 * Fixed possible header name quote bug
326 * Fixed wordwrap() trim bug
327 * Couple other small bug fixes
329 Version 1.41 (Wed, Aug 22 2001)
330 * Fixed AltBody bug w/o attachments
331 * Fixed rfc_date() for certain mail servers
333 Version 1.40 (Sun, Aug 12 2001)
334 * Added multipart/alternative support (AltBody)
335 * Documentation update
336 * Fixed bug in Mercury MTA
338 Version 1.29 (Fri, Aug 03 2001)
339 * Added AddStringAttachment() method
340 * Added SMTP authentication support
342 Version 1.28 (Mon, Jul 30 2001)
343 * Fixed a typo in SMTP class
344 * Fixed header issue with Imail (win32) SMTP server
345 * Made fopen() calls for attachments use "rb" to fix win32 error
347 Version 1.25 (Mon, Jul 02 2001)
348 * Added RFC 822 date fix (Patrice)
349 * Added improved error handling by adding a $ErrorInfo variable
350 * Removed MailerDebug variable (obsolete with new error handler)
352 Version 1.20 (Mon, Jun 25 2001)
353 * Added quoted-printable encoding (Patrice)
354 * Set Version as public and removed PrintVersion()
355 * Changed phpdoc to only display public variables and methods
357 Version 1.19 (Thu, Jun 21 2001)
358 * Fixed MS Mail header bug
359 * Added fix for Bcc problem with mail(). *Does not work on Win32*
360   (See PHP bug report: http://www.php.net/bugs.php?id=11616)
361 * mail() no longer passes a fifth parameter when not needed
363 Version 1.15 (Fri, Jun 15 2001)
364 [Note: these changes contributed by Patrice Fournier]
365 * Changed all remaining \n to \r\n
366 * Bcc: header no longer writen to message except
367 when sent directly to sendmail
368 * Added a small message to non-MIME compliant mail reader
369 * Added Sender variable to change the Sender email
370 used in -f for sendmail/mail and in 'MAIL FROM' for smtp mode
371 * Changed boundary setting to a place it will be set only once
372 * Removed transfer encoding for whole message when using multipart
373 * Message body now uses Encoding in multipart messages
374 * Can set encoding and type to attachments 7bit, 8bit
375 and binary attachment are sent as is, base64 are encoded
376 * Can set Encoding to base64 to send 8 bits body
377 through 7 bits servers
379 Version 1.10 (Tue, Jun 12 2001)
380 * Fixed win32 mail header bug (printed out headers in message body)
382 Version 1.09 (Fri, Jun 08 2001)
383 * Changed date header to work with Netscape mail programs
384 * Altered phpdoc documentation
386 Version 1.08 (Tue, Jun 05 2001)
387 * Added enhanced error-checking
388 * Added phpdoc documentation to source
390 Version 1.06 (Fri, Jun 01 2001)
391 * Added optional name for file attachments
393 Version 1.05 (Tue, May 29 2001)
394 * Code cleanup
395 * Eliminated sendmail header warning message
396 * Fixed possible SMTP error
398 Version 1.03 (Thu, May 24 2001)
399 * Fixed problem where qmail sends out duplicate messages
401 Version 1.02 (Wed, May 23 2001)
402 * Added multiple recipient and attachment Clear* methods
403 * Added Sendmail public variable
404 * Fixed problem with loading SMTP library multiple times
406 Version 0.98 (Tue, May 22 2001)
407 * Fixed problem with redundant mail hosts sending out multiple messages
408 * Added additional error handler code
409 * Added AddCustomHeader() function
410 * Added support for Microsoft mail client headers (affects priority)
411 * Fixed small bug with Mailer variable
412 * Added PrintVersion() function
414 Version 0.92 (Tue, May 15 2001)
415 * Changed file names to class.phpmailer.php and class.smtp.php to match
416   current PHP class trend.
417 * Fixed problem where body not being printed when a message is attached
418 * Several small bug fixes
420 Version 0.90 (Tue, April 17 2001)
421 * Intial public release