Merge branch 'w39_MDL-37324_m26_phpmailer' of https://github.com/skodak/moodle
[moodle.git] / lib / phpmailer / changelog.md
1 # ChangeLog
3 ## Version 5.2.7 (September 12th 2013)
4 * Add Ukranian translation from @Krezalis
5 * Support for do_verp
6 * Fix bug in CRAM-MD5 AUTH
7 * Propagate Debugoutput option to SMTP class (@Reblutus)
8 * Determine MIME type of attachments automatically
9 * Add cross-platform, multibyte-safe pathinfo replacement (with tests) and use it
10 * Add a new 'html' Debugoutput type
11 * Clean up SMTP debug output, remove embedded HTML
12 * Some small changes in header formatting to improve IETF msglint test results
13 * Update test_script to use some recently changed features, rename to code_generator
14 * Generated code actually works!
15 * Update SyntaxHighlighter
16 * Major overhaul and cleanup of example code
17 * New PHPMailer graphic
18 * msgHTML now uses RFC2392-compliant content ids
19 * Add line break normalization function and use it in msgHTML
20 * Don't set unnecessary reply-to addresses
21 * Make fakesendmail.sh a bit cleaner and safer
22 * Set a content-transfer-encoding on multiparts (fixes msglint error)
23 * Fix cid generation in msgHTML (Thanks to @digitalthought)
24 * Fix handling of multiple SMTP servers (Thanks to @NanoCaiordo)
25 * SMTP->connect() now supports stream context options (Thanks to @stanislavdavid)
26 * Add support for iCal event alternatives (Thanks to @reblutus)
27 * Update to Polish language file (Thanks to Krzysztof Kowalewski)
28 * Update to Norwegian language file (Thanks to @datagutten)
29 * Update to Hungarian language file (Thanks to @dominicus-75)
30 * Add Persian/Farsi translation from @jaii
31 * Make SMTPDebug property type match type in SMTP class
32 * Add unit tests for DKIM
33 * Major refactor of SMTP class
34 * Reformat to PSR-2 coding standard
35 * Introduce autoloader
36 * Allow overriding of SMTP class
37 * Overhaul of PHPDocs
38 * Fix broken Q-encoding
39 * Czech language update (Thanks to @nemelu)
40 * Removal of excess blank lines in messages
41 * Added fake POP server and unit tests for POP-before-SMTP
43 ## Version 5.2.6 (April 11th 2013)
44 * Reflect move to PHPMailer GitHub organisation at https://github.com/PHPMailer/PHPMailer
45 * Fix unbumped version numbers
46 * Update packagist.org with new location
47 * Clean up Changelog
49 ## Version 5.2.5 (April 6th 2013)
50 * First official release after move from Google Code
51 * Fixes for qmail when sending via mail()
52 * Merge in changes from Google code 5.2.4 release
53 * Minor coding standards cleanup in SMTP class
54 * Improved unit tests, now tests S/MIME signing
55 * Travis-CI support on GitHub, runs tests with fake SMTP server
57 ## Version 5.2.4 (February 19, 2013)
58 * Fix tag and version bug.
59 * un-deprecate isSMTP(), isMail(), IsSendmail() and isQmail().
60 * Numerous translation updates
62 ## Version 5.2.3 (February 8, 2013)
63 * Fix issue with older PCREs and ValidateAddress() (Bugz: 124)
64 * Add CRAM-MD5 authentication, thanks to Elijah madden, https://github.com/okonomiyaki3000
65 * Replacement of obsolete Quoted-Printable encoder with a much better implementation
66 * Composer package definition
67 * New language added: Hebrew
69 ## Version 5.2.2 (December 3, 2012)
70 * Some fixes and syncs from https://github.com/Synchro/PHPMailer
71 * Add Slovak translation, thanks to Michal Tinka
73 ## Version 5.2.2-rc2 (November 6, 2012)
74 * Fix SMTP server rotation (Bugz: 118)
75 * Allow override of autogen'ed 'Date' header (for Drupal's
76   og_mailinglist module)
77 * No whitespace after '-f' option (Bugz: 116)
78 * Work around potential warning (Bugz: 114)
80 ## Version 5.2.2-rc1 (September 28, 2012)
81 * Header encoding works with long lines (Bugz: 93)
82 * Turkish language update (Bugz: 94)
83 * undefined $pattern in EncodeQ bug squashed (Bugz: 98)
84 * use of mail() in safe_mode now works (Bugz: 96)
85 * ValidateAddress() now 'public static' so people can override the
86   default and use their own validation scheme.
87 * ValidateAddress() no longer uses broken FILTER_VALIDATE_EMAIL
88 * Added in AUTH PLAIN SMTP authentication
90 ## Version 5.2.2-beta2 (August 17, 2012)
91 * Fixed Postfix VERP support (Bugz: 92)
92 * Allow action_function callbacks to pass/use
93   the From address (passed as final param)
94 * Prevent inf look for get_lines() (Bugz: 77)
95 * New public var ($UseSendmailOptions). Only pass sendmail()
96   options iff we really are using sendmail or something sendmail
97   compatible. (Bugz: 75)
98 * default setting for LE returned to "\n" due to popular demand.
100 ## Version 5.2.2-beta1 (July 13, 2012)
101 * Expose PreSend() and PostSend() as public methods to allow
102   for more control if serializing message sending.
103 * GetSentMIMEMessage() only constructs the message copy when
104  needed. Save memory.
105 * Only pass params to mail() if the underlying MTA is
106   "sendmail" (as defined as "having the string sendmail
107   in its pathname") [#69]
108 * Attachments now work with Amazon SES and others [Bugz#70]
109 * Debug output now sent to stdout (via echo) or error_log [Bugz#5]
110 * New var: Debugoutput (for above) [Bugz#5]
111 * SMTP reads now Timeout aware (new var: Timeout=15) [Bugz#71]
112 * SMTP reads now can have a Timelimit associated with them
113   (new var: Timelimit=30)[Bugz#71]
114 * Fix quoting issue associated with charsets
115 * default setting for LE is now RFC compliant: "\r\n"
116 * Return-Path can now be user defined (new var: ReturnPath)
117   (the default is "" which implies no change from previous
118   behavior, which was to use either From or Sender) [Bugz#46]
119 * X-Mailer header can now be disabled (by setting to a
120   whitespace string, eg "  ") [Bugz#66]
121 * Bugz closed: #68, #60, #42, #43, #59, #55, #66, #48, #49,
122                #52, #31, #41, #5. #70, #69
124 ## Version 5.2.1 (January 16, 2012)
125 * Closed several bugs#5
126 * Performance improvements
127 * MsgHTML() now returns the message as required.
128 * New method: GetSentMIMEMessage() (returns full copy of sent message)
130 ## Version 5.2 (July 19, 2011)
131 * protected MIME body and header
132 * better DKIM DNS Resource Record support
133 * better aly handling
134 * htmlfilter class added to extras
135 * moved to Apache Extras
137 ## Version 5.1 (October 20, 2009)
138 * fixed filename issue with AddStringAttachment (thanks to Tony)
139 * fixed "SingleTo" property, now works with Senmail, Qmail, and SMTP in
140   addition to PHP mail()
141 * added DKIM digital signing functionality, new properties:
142   - DKIM_domain (sets the domain name)
143   - DKIM_private (holds DKIM private key)
144   - DKIM_passphrase (holds your DKIM passphrase)
145   - DKIM_selector (holds the DKIM "selector")
146   - DKIM_identity (holds the identifying email address)
147 * added callback function support
148   - callback function parameters include:
149     result, to, cc, bcc, subject and body
150   - see the test/test_callback.php file for usage.
151 * added "auto" identity functionality
152   - can automatically add:
153     - Return-path (if Sender not set)
154     - Reply-To (if ReplyTo not set)
155   - can be disabled:
156     - $mail->SetFrom('yourname@yourdomain.com','First Last',false);
157     - or by adding the $mail->Sender and/or $mail->ReplyTo properties
159 Note: "auto" identity added to help with emails ending up in spam or junk boxes because of missing headers
161 ## Version 5.0.2 (May 24, 2009)
162 * Fix for missing attachments when inline graphics are present
163 * Fix for missing Cc in header when using SMTP (mail was sent,
164   but not displayed in header -- Cc receiver only saw email To:
165   line and no Cc line, but did get the email (To receiver
166   saw same)
168 ## Version 5.0.1 (April 05, 2009)
169 * Temporary fix for missing attachments
171 ## Version 5.0.0 (April 02, 2009)
172 With the release of this version, we are initiating a new version numbering
173 system to differentiate from the PHP4 version of PHPMailer.
174 Most notable in this release is fully object oriented code.
176 ### class.smtp.php:
177 * Refactored class.smtp.php to support new exception handling
178 * code size reduced from 29.2 Kb to 25.6 Kb
179 * Removed unnecessary functions from class.smtp.php:
180   - public function Expand($name) {
181   - public function Help($keyword="") {
182   - public function Noop() {
183   - public function Send($from) {
184   - public function SendOrMail($from) {
185   - public function Verify($name) {
187 ###  class.phpmailer.php:
188 * Refactored class.phpmailer.php with new exception handling
189 * Changed processing functionality of Sendmail and Qmail so they cannot be
190   inadvertently used
191 * removed getFile() function, just became a simple wrapper for
192   file_get_contents()
193 * added check for PHP version (will gracefully exit if not at least PHP 5.0)
194 * enhanced code to check if an attachment source is the same as an embedded or
195   inline graphic source to eliminate duplicate attachments
197 ### New /test_script
198 We have written a test script you can use to test the script as part of your
199 installation. Once you press submit, the test script will send a multi-mime
200 email with either the message you type in or an HTML email with an inline
201 graphic. Two attachments are included in the email (one of the attachments
202 is also the inline graphic so you can see that only one copy of the graphic
203 is sent in the email). The test script will also display the functional
204 script that you can copy/paste to your editor to duplicate the functionality.
206 ### New examples
207 All new examples in both basic and advanced modes. Advanced examples show
208    Exception handling.
210 ### PHPDocumentator (phpdocs) documentation for PHPMailer version 5.0.0
211 All new documentation
213 ## Version 2.3 (November 06, 2008)
214 * added Arabic language (many thanks to Bahjat Al Mostafa)
215 * removed English language from language files and made it a default within
216   class.phpmailer.php - if no language is found, it will default to use
217   the english language translation
218 * fixed public/private declarations
219 * corrected line 1728, $basedir to $directory
220 * added $sign_cert_file to avoid improper duplicate use of $sign_key_file
221 * corrected $this->Hello on line 612 to $this->Helo
222 * changed default of $LE to "\r\n" to comply with RFC 2822. Can be set by the user
223   if default is not acceptable
224 * removed trim() from return results in EncodeQP
225 * /test and three files it contained are removed from version 2.3
226 * fixed phpunit.php for compliance with PHP5
227 * changed $this->AltBody = $textMsg; to $this->AltBody = html_entity_decode($textMsg);
228 * We have removed the /phpdoc from the downloads. All documentation is now on
229   the http://phpmailer.codeworxtech.com website.
231 ## Version 2.2.1 () July 19 2008
232 * fixed line 1092 in class.smtp.php (my apologies, error on my part)
234 ## Version 2.2 () July 15 2008
235 * Fixed redirect issue (display of UTF-8 in thank you redirect)
236 * fixed error in getResponse function declaration (class.pop3.php)
237 * PHPMailer now PHP6 compliant
238 * fixed line 1092 in class.smtp.php (endless loop from missing = sign)
240 ## Version 2.1 (Wed, June 04 2008)
241 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.
243 * added S/MIME functionality (ability to digitally sign emails)
244   BIG THANKS TO "sergiocambra" for posting this patch back in November 2007.
245   The "Signed Emails" functionality adds the Sign method to pass the private key
246   filename and the password to read it, and then email will be sent with
247   content-type multipart/signed and with the digital signature attached.
248 * fully compatible with E_STRICT error level
249   - Please note:
250     In about half the test environments this development version was subjected
251     to, an error was thrown for the date() functions used (line 1565 and 1569).
252     This is NOT a PHPMailer error, it is the result of an incorrectly configured
253     PHP5 installation. The fix is to modify your 'php.ini' file and include the
254     date.timezone = America/New York
255     directive, to your own server timezone
256   - If you do get this error, and are unable to access your php.ini file:
257     In your PHP script, add
258     `date_default_timezone_set('America/Toronto');`
259   - do not try to use
260     `$myVar = date_default_timezone_get();`
261     as a test, it will throw an error.
262 * added ability to define path (mainly for embedded images)
263   function `MsgHTML($message,$basedir='')` ... where:
264   `$basedir` is the fully qualified path
265 * fixed `MsgHTML()` function:
266   - Embedded Images where images are specified by `<protocol>://` will not be altered or embedded
267 * fixed the return value of SMTP exit code ( pclose )
268 * addressed issue of multibyte characters in subject line and truncating
269 * added ability to have user specified Message ID
270   (default is still that PHPMailer create a unique Message ID)
271 * corrected unidentified message type to 'application/octet-stream'
272 * fixed chunk_split() multibyte issue (thanks to Colin Brown, et al).
273 * added check for added attachments
274 * enhanced conversion of HTML to text in MsgHTML (thanks to "brunny")
276 ## Version 2.1.0beta2 (Sun, Dec 02 2007)
277 * implemented updated EncodeQP (thanks to coolbru, aka Marcus Bointon)
278 * finished all testing, all known bugs corrected, enhancements tested
280 Note: will NOT work with PHP4.
282 Please note, this is BETA software **DO NOT USE THIS IN PRODUCTION OR LIVE PROJECTS; INTENDED STRICTLY FOR TESTING**
284 ## Version 2.1.0beta1
285 Please note, this is BETA software
286 ** DO NOT USE THIS IN PRODUCTION OR LIVE PROJECTS
287  INTENDED STRICTLY FOR TESTING
289 ## Version 2.0.0 rc2 (Fri, Nov 16 2007), interim release
290 * implements new property to control VERP in class.smtp.php
291   example (requires instantiating class.smtp.php):
292   $mail->do_verp = true;
293 * POP-before-SMTP functionality included, thanks to Richard Davey
294   (see class.pop3.php & pop3_before_smtp_test.php for examples)
295 * included example showing how to use PHPMailer with GMAIL
296 * fixed the missing Cc in SendMail() and Mail()
298 ******************
299 A note on sending bulk emails:
301 If the email you are sending is not personalized, consider using the
302 "undisclosed-recipient:;" strategy. That is, put all of your recipients
303 in the Bcc field and set the To field to "undisclosed-recipients:;".
304 It's a lot faster (only one send) and saves quite a bit on resources.
305 Contrary to some opinions, this will not get you listed in spam engines -
306 it's a legitimate way for you to send emails.
308 A partial example for use with PHPMailer:
310 ```
311 $mail->AddAddress("undisclosed-recipients:;");
312 $mail->AddBCC("email1@anydomain.com,email2@anyotherdomain.com,email3@anyalternatedomain.com");
313 ```
315 Many email service providers restrict the number of emails that can be sent
316 in any given time period. Often that is between 50 - 60 emails maximum
317 per hour or per send session.
319 If that's the case, then break up your Bcc lists into chunks that are one
320 less than your limit, and put a pause in your script.
321 *******************
323 ## Version 2.0.0 rc1 (Thu, Nov 08 2007), interim release
324 * dramatically simplified using inline graphics ... it's fully automated and requires no user input
325 * added automatic document type detection for attachments and pictures
326 * added MsgHTML() function to replace Body tag for HTML emails
327 * fixed the SendMail security issues (input validation vulnerability)
328 * enhanced the AddAddresses functionality so that the "Name" portion is used in the email address
329 * removed the need to use the AltBody method (set from the HTML, or default text used)
330 * set the PHP Mail() function as the default (still support SendMail, SMTP Mail)
331 * removed the need to set the IsHTML property (set automatically)
332 * added Estonian language file by Indrek P&auml;ri
333 * added header injection patch
334 * added "set" method to permit users to create their own pseudo-properties like 'X-Headers', etc.
335   example of use:
337 ```
338 $mail->set('X-Priority', '3');
339 $mail->set('X-MSMail-Priority', 'Normal');
340 ```
342 * fixed warning message in SMTP get_lines method
343 * added TLS/SSL SMTP support. Example of use:
345 ```
346 $mail = new PHPMailer();
347 $mail->Mailer = "smtp";
348 $mail->Host = "smtp.example.com";
349 $mail->SMTPSecure   = "tls"; // option
350 //$mail->SMTPSecure   = "ssl";  // option
351 ...
352 $mail->Send();
353 ```
355 * PHPMailer has been tested with PHP4 (4.4.7) and PHP5 (5.2.7)
356 * Works with PHP installed as a module or as CGI-PHP
357 NOTE: will NOT work with PHP5 in E_STRICT error mode
359 ## Version 1.73 (Sun, Jun 10 2005)
360 * Fixed denial of service bug: http://www.cybsec.com/vuln/PHPMailer-DOS.pdf
361 * Now has a total of 20 translations
362 * Fixed alt attachments bug: http://tinyurl.com/98u9k
364 ## Version 1.72 (Wed, May 25 2004)
365 * Added Dutch, Swedish, Czech, Norwegian, and Turkish translations.
366 * Received: Removed this method because spam filter programs like
367   SpamAssassin reject this header.
368 * Fixed error count bug.
369 * SetLanguage default is now "language/".
370 * Fixed magic_quotes_runtime bug.
372 ## Version 1.71 (Tue, Jul 28 2003)
373 * Made several speed enhancements
374 * Added German and Italian translation files
375 * Fixed HELO/AUTH bugs on keep-alive connects
376 * Now provides an error message if language file does not load
377 * Fixed attachment EOL bug
378 * Updated some unclear documentation
379 * Added additional tests and improved others
381 ## Version 1.70 (Mon, Jun 20 2003)
382 * Added SMTP keep-alive support
383 * Added IsError method for error detection
384 * Added error message translation support (SetLanguage)
385 * Refactored many methods to increase library performance
386 * Hello now sends the newer EHLO message before HELO as per RFC 2821
387 * Removed the boundary class and replaced it with GetBoundary
388 * Removed queue support methods
389 * New $Hostname variable
390 * New Message-ID header
391 * Received header reformat
392 * Helo variable default changed to $Hostname
393 * Removed extra spaces in Content-Type definition (#667182)
394 * Return-Path should be set to Sender when set
395 * Adds Q or B encoding to headers when necessary
396 * quoted-encoding should now encode NULs \000
397 * Fixed encoding of body/AltBody (#553370)
398 * Adds "To: undisclosed-recipients:;" when all recipients are hidden (BCC)
399 * Multiple bug fixes
401 ## Version 1.65 (Fri, Aug 09 2002)
402 * Fixed non-visible attachment bug (#585097) for Outlook
403 * SMTP connections are now closed after each transaction
404 * Fixed SMTP::Expand return value
405 * Converted SMTP class documentation to phpDocumentor format
407 ## Version 1.62 (Wed, Jun 26 2002)
408 * Fixed multi-attach bug
409 * Set proper word wrapping
410 * Reduced memory use with attachments
411 * Added more debugging
412 * Changed documentation to phpDocumentor format
414 ## Version 1.60 (Sat, Mar 30 2002)
415 * Sendmail pipe and address patch (Christian Holtje)
416 * Added embedded image and read confirmation support (A. Ognio)
417 * Added unit tests
418 * Added SMTP timeout support (*nix only)
419 * Added possibly temporary PluginDir variable for SMTP class
420 * Added LE message line ending variable
421 * Refactored boundary and attachment code
422 * Eliminated SMTP class warnings
423 * Added SendToQueue method for future queuing support
425 ## Version 1.54 (Wed, Dec 19 2001)
426 * Add some queuing support code
427 * Fixed a pesky multi/alt bug
428 * Messages are no longer forced to have "To" addresses
430 ## Version 1.50 (Thu, Nov 08 2001)
431 * Fix extra lines when not using SMTP mailer
432 * Set WordWrap variable to int with a zero default
434 ## Version 1.47 (Tue, Oct 16 2001)
435 * Fixed Received header code format
436 * Fixed AltBody order error
437 * Fixed alternate port warning
439 ## Version 1.45 (Tue, Sep 25 2001)
440 * Added enhanced SMTP debug support
441 * Added support for multiple ports on SMTP
442 * Added Received header for tracing
443 * Fixed AddStringAttachment encoding
444 * Fixed possible header name quote bug
445 * Fixed wordwrap() trim bug
446 * Couple other small bug fixes
448 ## Version 1.41 (Wed, Aug 22 2001)
449 * Fixed AltBody bug w/o attachments
450 * Fixed rfc_date() for certain mail servers
452 ## Version 1.40 (Sun, Aug 12 2001)
453 * Added multipart/alternative support (AltBody)
454 * Documentation update
455 * Fixed bug in Mercury MTA
457 ## Version 1.29 (Fri, Aug 03 2001)
458 * Added AddStringAttachment() method
459 * Added SMTP authentication support
461 ## Version 1.28 (Mon, Jul 30 2001)
462 * Fixed a typo in SMTP class
463 * Fixed header issue with Imail (win32) SMTP server
464 * Made fopen() calls for attachments use "rb" to fix win32 error
466 ## Version 1.25 (Mon, Jul 02 2001)
467 * Added RFC 822 date fix (Patrice)
468 * Added improved error handling by adding a $ErrorInfo variable
469 * Removed MailerDebug variable (obsolete with new error handler)
471 ## Version 1.20 (Mon, Jun 25 2001)
472 * Added quoted-printable encoding (Patrice)
473 * Set Version as public and removed PrintVersion()
474 * Changed phpdoc to only display public variables and methods
476 ## Version 1.19 (Thu, Jun 21 2001)
477 * Fixed MS Mail header bug
478 * Added fix for Bcc problem with mail(). *Does not work on Win32*
479   (See PHP bug report: http://www.php.net/bugs.php?id=11616)
480 * mail() no longer passes a fifth parameter when not needed
482 ## Version 1.15 (Fri, Jun 15 2001)
483 Note: these changes contributed by Patrice Fournier
484 * Changed all remaining \n to \r\n
485 * Bcc: header no longer writen to message except
486   when sent directly to sendmail
487 * Added a small message to non-MIME compliant mail reader
488 * Added Sender variable to change the Sender email
489   used in -f for sendmail/mail and in 'MAIL FROM' for smtp mode
490 * Changed boundary setting to a place it will be set only once
491 * Removed transfer encoding for whole message when using multipart
492 * Message body now uses Encoding in multipart messages
493 * Can set encoding and type to attachments 7bit, 8bit
494   and binary attachment are sent as is, base64 are encoded
495 * Can set Encoding to base64 to send 8 bits body
496   through 7 bits servers
498 ## Version 1.10 (Tue, Jun 12 2001)
499 * Fixed win32 mail header bug (printed out headers in message body)
501 ## Version 1.09 (Fri, Jun 08 2001)
502 * Changed date header to work with Netscape mail programs
503 * Altered phpdoc documentation
505 ## Version 1.08 (Tue, Jun 05 2001)
506 * Added enhanced error-checking
507 * Added phpdoc documentation to source
509 ## Version 1.06 (Fri, Jun 01 2001)
510 * Added optional name for file attachments
512 ## Version 1.05 (Tue, May 29 2001)
513 * Code cleanup
514 * Eliminated sendmail header warning message
515 * Fixed possible SMTP error
517 ## Version 1.03 (Thu, May 24 2001)
518 * Fixed problem where qmail sends out duplicate messages
520 ## Version 1.02 (Wed, May 23 2001)
521 * Added multiple recipient and attachment Clear* methods
522 * Added Sendmail public variable
523 * Fixed problem with loading SMTP library multiple times
525 ## Version 0.98 (Tue, May 22 2001)
526 * Fixed problem with redundant mail hosts sending out multiple messages
527 * Added additional error handler code
528 * Added AddCustomHeader() function
529 * Added support for Microsoft mail client headers (affects priority)
530 * Fixed small bug with Mailer variable
531 * Added PrintVersion() function
533 ## Version 0.92 (Tue, May 15 2001)
534 * Changed file names to class.phpmailer.php and class.smtp.php to match
535   current PHP class trend.
536 * Fixed problem where body not being printed when a message is attached
537 * Several small bug fixes
539 ## Version 0.90 (Tue, April 17 2001)
540 * Initial public release