MDL-57474 mailer: Make sure that our exlicit MessageID is trimmed
[moodle.git] / lib / phpmailer / README.md
1 ![PHPMailer](https://raw.github.com/PHPMailer/PHPMailer/master/examples/images/phpmailer.png)
3 # PHPMailer - A full-featured email creation and transfer class for PHP
5 Build status: [![Build Status](https://travis-ci.org/PHPMailer/PHPMailer.svg)](https://travis-ci.org/PHPMailer/PHPMailer)
6 [![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/PHPMailer/PHPMailer/badges/quality-score.png?s=3758e21d279becdf847a557a56a3ed16dfec9d5d)](https://scrutinizer-ci.com/g/PHPMailer/PHPMailer/)
7 [![Code Coverage](https://scrutinizer-ci.com/g/PHPMailer/PHPMailer/badges/coverage.png?s=3fe6ca5fe8cd2cdf96285756e42932f7ca256962)](https://scrutinizer-ci.com/g/PHPMailer/PHPMailer/)
9 [![Latest Stable Version](https://poser.pugx.org/phpmailer/phpmailer/v/stable.svg)](https://packagist.org/packages/phpmailer/phpmailer) [![Total Downloads](https://poser.pugx.org/phpmailer/phpmailer/downloads)](https://packagist.org/packages/phpmailer/phpmailer) [![Latest Unstable Version](https://poser.pugx.org/phpmailer/phpmailer/v/unstable.svg)](https://packagist.org/packages/phpmailer/phpmailer) [![License](https://poser.pugx.org/phpmailer/phpmailer/license.svg)](https://packagist.org/packages/phpmailer/phpmailer)
11 ## Class Features
13 - Probably the world's most popular code for sending email from PHP!
14 - Used by many open-source projects: WordPress, Drupal, 1CRM, SugarCRM, Yii, Joomla! and many more
15 - Integrated SMTP support - send without a local mail server
16 - Send emails with multiple TOs, CCs, BCCs and REPLY-TOs
17 - Multipart/alternative emails for mail clients that do not read HTML email
18 - Support for UTF-8 content and 8bit, base64, binary, and quoted-printable encodings
19 - SMTP authentication with LOGIN, PLAIN, NTLM, CRAM-MD5 and Google's XOAUTH2 mechanisms over SSL and TLS transports
20 - Error messages in 47 languages!
21 - DKIM and S/MIME signing support
22 - Compatible with PHP 5.0 and later
23 - Much more!
25 ## Why you might need it
27 Many PHP developers utilize email in their code. The only PHP function that supports this is the mail() function. However, it does not provide any assistance for making use of popular features such as HTML-based emails and attachments.
29 Formatting email correctly is surprisingly difficult. There are myriad overlapping RFCs, requiring tight adherence to horribly complicated formatting and encoding rules - the vast majority of code that you'll find online that uses the mail() function directly is just plain wrong!
30 *Please* don't be tempted to do it yourself - if you don't use PHPMailer, there are many other excellent libraries that you should look at before rolling your own - try SwiftMailer, Zend_Mail, eZcomponents etc.
32 The PHP mail() function usually sends via a local mail server, typically fronted by a `sendmail` binary on Linux, BSD and OS X platforms, however, Windows usually doesn't include a local mail server; PHPMailer's integrated SMTP implementation allows email sending on Windows platforms without a local mail server.
34 ## License
36 This software is distributed under the [LGPL 2.1](http://www.gnu.org/licenses/lgpl-2.1.html) license. Please read LICENSE for information on the
37 software availability and distribution.
39 ## Installation & loading
41 PHPMailer is available via [Composer/Packagist](https://packagist.org/packages/phpmailer/phpmailer) (using semantic versioning), so just add this line to your `composer.json` file:
43 ```json
44 "phpmailer/phpmailer": "~5.2"
45 ```
47 or
49 ```sh
50 composer require phpmailer/phpmailer
51 ```
53 If you want to use the Gmail XOAUTH2 authentication class, you will also need to add a dependency on the `league/oauth2-client` package.
55 Alternatively, copy the contents of the PHPMailer folder into somewhere that's in your PHP `include_path` setting. If you don't speak git or just want a tarball, click the 'zip' button at the top of the page in GitHub.
57 If you're not using composer's autoloader, PHPMailer provides an SPL-compatible autoloader, and that is the preferred way of loading the library - just `require '/path/to/PHPMailerAutoload.php';` and everything should work. The autoloader does not throw errors if it can't find classes so it prepends itself to the SPL list, allowing your own (or your framework's) autoloader to catch errors. SPL autoloading was introduced in PHP 5.1.0, so if you are using a version older than that you will need to require/include each class manually.
59 PHPMailer does *not* declare a namespace because namespaces were only introduced in PHP 5.3.
61 If you want to use Google's XOAUTH2 authentication mechanism, you need to be running at least PHP 5.4, and load the dependencies listed in `composer.json`.
63 ### Minimal installation
65 While installing the entire package manually or with composer is simple, convenient and reliable, you may want to include only vital files in your project. At the very least you will need [class.phpmailer.php](class.phpmailer.php). If you're using SMTP, you'll need [class.smtp.php](class.smtp.php), and if you're using POP-before SMTP, you'll need [class.pop3.php](class.pop3.php). For all of these, we recommend you use [the autoloader](PHPMailerAutoload.php) too as otherwise you will either have to `require` all classes manually or use some other autoloader. You can skip the [language](language/) folder if you're not showing errors to users and can make do with English-only errors. You may need the additional classes in the [extras](extras/) folder if you are using those features, including NTLM authentication and ics generation. If you're using Google XOAUTH2 you will need `class.phpmaileroauth.php` and `class.oauth.php` classes too, as well as the composer dependencies.
67 ## A Simple Example
69 ```php
70 <?php
71 require 'PHPMailerAutoload.php';
73 $mail = new PHPMailer;
75 //$mail->SMTPDebug = 3;                               // Enable verbose debug output
77 $mail->isSMTP();                                      // Set mailer to use SMTP
78 $mail->Host = 'smtp1.example.com;smtp2.example.com';  // Specify main and backup SMTP servers
79 $mail->SMTPAuth = true;                               // Enable SMTP authentication
80 $mail->Username = 'user@example.com';                 // SMTP username
81 $mail->Password = 'secret';                           // SMTP password
82 $mail->SMTPSecure = 'tls';                            // Enable TLS encryption, `ssl` also accepted
83 $mail->Port = 587;                                    // TCP port to connect to
85 $mail->setFrom('from@example.com', 'Mailer');
86 $mail->addAddress('joe@example.net', 'Joe User');     // Add a recipient
87 $mail->addAddress('ellen@example.com');               // Name is optional
88 $mail->addReplyTo('info@example.com', 'Information');
89 $mail->addCC('cc@example.com');
90 $mail->addBCC('bcc@example.com');
92 $mail->addAttachment('/var/tmp/file.tar.gz');         // Add attachments
93 $mail->addAttachment('/tmp/image.jpg', 'new.jpg');    // Optional name
94 $mail->isHTML(true);                                  // Set email format to HTML
96 $mail->Subject = 'Here is the subject';
97 $mail->Body    = 'This is the HTML message body <b>in bold!</b>';
98 $mail->AltBody = 'This is the body in plain text for non-HTML mail clients';
100 if(!$mail->send()) {
101     echo 'Message could not be sent.';
102     echo 'Mailer Error: ' . $mail->ErrorInfo;
103 } else {
104     echo 'Message has been sent';
106 ```
108 You'll find plenty more to play with in the [examples](examples/) folder.
110 That's it. You should now be ready to use PHPMailer!
112 ## Localization
113 PHPMailer defaults to English, but in the [language](language/) folder you'll find numerous (46 at the time of writing!) translations for PHPMailer error messages that you may encounter. Their filenames contain [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the translations, for example `fr` for French. To specify a language, you need to tell PHPMailer which one to use, like this:
115 ```php
116 // To load the French version
117 $mail->setLanguage('fr', '/optional/path/to/language/directory/');
118 ```
120 We welcome corrections and new languages - if you're looking for corrections to do, run the [phpmailerLangTest.php](test/phpmailerLangTest.php) script in the tests folder and it will show any missing translations.
122 ## Documentation
124 Examples of how to use PHPMailer for common scenarios can be found in the [examples](examples/) folder. If you're looking for a good starting point, we recommend you start with [the gmail example](examples/gmail.phps).
126 There are tips and a troubleshooting guide in the [GitHub wiki](https://github.com/PHPMailer/PHPMailer/wiki). If you're having trouble, this should be the first place you look as it's the most frequently updated.
128 Complete generated API documentation is [available online](http://phpmailer.github.io/PHPMailer/).
130 You'll find some basic user-level docs in the [docs](docs/) folder, and you can generate complete API-level documentation using the [generatedocs.sh](docs/generatedocs.sh) shell script in the docs folder, though you'll need to install [PHPDocumentor](http://www.phpdoc.org) first. You may find [the unit tests](test/phpmailerTest.php) a good source of how to do various operations such as encryption.
132 If the documentation doesn't cover what you need, search the [many questions on StackOverflow](http://stackoverflow.com/questions/tagged/phpmailer), and before you ask a question about "SMTP Error: Could not connect to SMTP host.", [read the troubleshooting guide](https://github.com/PHPMailer/PHPMailer/wiki/Troubleshooting).
134 ## Tests
136 There is a PHPUnit test script in the [test](test/) folder.
138 Build status: [![Build Status](https://travis-ci.org/PHPMailer/PHPMailer.svg)](https://travis-ci.org/PHPMailer/PHPMailer)
140 If this isn't passing, is there something you can do to help?
142 ## Contributing
144 Please submit bug reports, suggestions and pull requests to the [GitHub issue tracker](https://github.com/PHPMailer/PHPMailer/issues).
146 We're particularly interested in fixing edge-cases, expanding test coverage and updating translations.
148 With the move to the PHPMailer GitHub organisation, you'll need to update any remote URLs referencing the old GitHub location with a command like this from within your clone:
150 ```sh
151 git remote set-url upstream https://github.com/PHPMailer/PHPMailer.git
152 ```
154 Please *don't* use the SourceForge or Google Code projects any more.
156 ## Sponsorship
158 Development time and resources for PHPMailer are provided by [Smartmessages.net](https://info.smartmessages.net/), a powerful email marketing system.
160 <a href="https://info.smartmessages.net/"><img src="https://www.smartmessages.net/img/smartmessages-logo.svg" width="250" height="28" alt="Smartmessages email marketing"></a>
162 Other contributions are gladly received, whether in beer 🍺, T-shirts 👕, Amazon wishlist raids, or cold, hard cash 💰.
164 ## Changelog
166 See [changelog](changelog.md).
168 ## History
169 - PHPMailer was originally written in 2001 by Brent R. Matzelle as a [SourceForge project](http://sourceforge.net/projects/phpmailer/).
170 - Marcus Bointon (coolbru on SF) and Andy Prevost (codeworxtech) took over the project in 2004.
171 - Became an Apache incubator project on Google Code in 2010, managed by Jim Jagielski.
172 - Marcus created his fork on [GitHub](https://github.com/Synchro/PHPMailer).
173 - Jim and Marcus decide to join forces and use GitHub as the canonical and official repo for PHPMailer.
174 - PHPMailer moves to the [PHPMailer organisation](https://github.com/PHPMailer) on GitHub.
176 ### What's changed since moving from SourceForge?
177 - Official successor to the SourceForge and Google Code projects.
178 - Test suite.
179 - Continuous integration with Travis-CI.
180 - Composer support.
181 - Public development.
182 - Additional languages and language strings.
183 - CRAM-MD5 authentication support.
184 - Preserves full repo history of authors, commits and branches from the original SourceForge project.