lib/phpmailer/README.md

   1 ![PHPMailer](https://raw.github.com/PHPMailer/PHPMailer/master/examples/images/phpmailer.png)
   2
   3 # PHPMailer - A full-featured email creation and transfer class for PHP
   4
   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/)
   8
   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)
  10
  11 ## Class Features
  12 - Probably the world's most popular code for sending email from PHP!
  13 - Used by many open-source projects: WordPress, Drupal, 1CRM, SugarCRM, Yii, Joomla! and many more
  14 - Integrated SMTP support - send without a local mail server
  15 - Send emails with multiple To, CC, BCC and Reply-to addresses
  16 - Multipart/alternative emails for mail clients that do not read HTML email
  17 - Add attachments, including inline
  18 - Support for UTF-8 content and 8bit, base64, binary, and quoted-printable encodings
  19 - SMTP authentication with LOGIN, PLAIN, CRAM-MD5 and XOAUTH2 mechanisms over SSL and SMTP+STARTTLS transports
  20 - Validates email addresses automatically
  21 - Protect against header injection attacks
  22 - Error messages in 47 languages!
  23 - DKIM and S/MIME signing support
  24 - Compatible with PHP 5.5 and later
  25 - Namespaced to prevent name clashes
  26 - Much more!
  27
  28 ## Why you might need it
  29 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.
  30
  31 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!
  32 *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.
  33
  34 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.
  35
  36 ## License
  37 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
  38 software availability and distribution.
  39
  40 ## Installation & loading
  41 PHPMailer is available on [Packagist](https://packagist.org/packages/phpmailer/phpmailer) (using semantic versioning), and installation via composer is the recommended way to install PHPMailer. Just add this line to your `composer.json` file:
  42
  43 ```json
  44 "phpmailer/phpmailer": "~6.0"
  45 ```
  46
  47 or run
  48
  49 ```sh
  50 composer require phpmailer/phpmailer
  51 ```
  52
  53 PHPMailer declares the namespace `PHPMailer\PHPMailer`.
  54
  55 If you want to use the Gmail XOAUTH2 authentication class, you will also need to add a dependency on the `league/oauth2-client` package in your `composer.json`.
  56
  57 Alternatively, if you're not using composer, copy the contents of the PHPMailer folder into one of the `include_path` directories specified in your PHP configuration and load each one manually.
  58
  59 If you don't speak git or just want a tarball, click the 'zip' button on the right of the project page in GitHub.
  60
  61 ## Upgrading from 5.2
  62 [Read the upgrade guide](https://github.com/PHPMailer/PHPMailer/tree/master/UPGRADING.md).
  63
  64 ## Legacy versions
  65 PHPMailer 5.2 (which is compatible with PHP 5.0 - 7.0) is no longer being supported for feature updates, and will only be receiving security updates from now on. You will find the latest version of 5.2 in the [5.2-stable branch](https://github.com/PHPMailer/PHPMailer/tree/5.2-stable), and future versions of 5.2 will be tagged with 5.2.x version numbers, so existing composer configs should remain working. If you're using PHP 5.5 or later, we recommend you make the necessary changes to switch to the 6.0 release.
  66
  67 ### Minimal installation
  68 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 [src/PHPMailer.php](https://github.com/PHPMailer/PHPMailer/tree/master/src/PHPMailer.php). If you're using SMTP, you'll need [src/SMTP.php](https://github.com/PHPMailer/PHPMailer/tree/master/src/SMTP.php), and if you're using POP-before SMTP, you'll need [src/POP3.php](https://github.com/PHPMailer/PHPMailer/tree/master/src/POP3.php). You can skip the [language](https://github.com/PHPMailer/PHPMailer/tree/master/language/) folder if you're not showing errors to users and can make do with English-only errors. If you're using XOAUTH2 you will need [src/OAuth.php](https://github.com/PHPMailer/PHPMailer/tree/master/src/OAuth.php) as well as the composer dependencies for the services you wish to authenticate with. Really, it's much easier to use composer!
  69
  70 ## A Simple Example
  71
  72 ```php
  73 <?php
  74 //Import PHPMailer classes into the global namespace
  75 use PHPMailer\PHPMailer\PHPMailer;
  76 use PHPMailer\PHPMailer\Exception;
  77
  78 require 'vendor/autoload.php';
  79
  80 $mail = new PHPMailer(true);
  81 try {
  82     //Server settings
  83     $mail->SMTPDebug = 2;                                 // Enable verbose debug output
  84     $mail->isSMTP();                                      // Set mailer to use SMTP
  85     $mail->Host = 'smtp1.example.com;smtp2.example.com';  // Specify main and backup SMTP servers
  86     $mail->SMTPAuth = true;                               // Enable SMTP authentication
  87     $mail->Username = 'user@example.com';                 // SMTP username
  88     $mail->Password = 'secret';                           // SMTP password
  89     $mail->SMTPSecure = 'tls';                            // Enable TLS encryption, `ssl` also accepted
  90     $mail->Port = 587;                                    // TCP port to connect to
  91
  92     //Recipients
  93     $mail->setFrom('from@example.com', 'Mailer');
  94     $mail->addAddress('joe@example.net', 'Joe User');     // Add a recipient
  95     $mail->addAddress('ellen@example.com');               // Name is optional
  96     $mail->addReplyTo('info@example.com', 'Information');
  97     $mail->addCC('cc@example.com');
  98     $mail->addBCC('bcc@example.com');
  99
 100     //Attachments
 101     $mail->addAttachment('/var/tmp/file.tar.gz');         // Add attachments
 102     $mail->addAttachment('/tmp/image.jpg', 'new.jpg');    // Optional name
 103
 104     //Content
 105     $mail->isHTML(true);                                  // Set email format to HTML
 106     $mail->Subject = 'Here is the subject';
 107     $mail->Body    = 'This is the HTML message body <b>in bold!</b>';
 108     $mail->AltBody = 'This is the body in plain text for non-HTML mail clients';
 109
 110     $mail->send();
 111     echo 'Message has been sent';
 112 } catch (Exception $e) {
 113     echo 'Message could not be sent.';
 114     echo 'Mailer Error: ' . $mail->ErrorInfo;
 115 }
 116 ```
 117
 118 You'll find plenty more to play with in the [examples](https://github.com/PHPMailer/PHPMailer/tree/master/examples) folder.
 119
 120 That's it. You should now be ready to use PHPMailer!
 121
 122 ## Localization
 123 PHPMailer defaults to English, but in the [language](https://github.com/PHPMailer/PHPMailer/tree/master/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:
 124
 125 ```php
 126 // To load the French version
 127 $mail->setLanguage('fr', '/optional/path/to/language/directory/');
 128 ```
 129
 130 We welcome corrections and new languages - if you're looking for corrections to do, run the [phpmailerLangTest.php](https://github.com/PHPMailer/PHPMailer/tree/master/test/phpmailerLangTest.php) script in the tests folder and it will show any missing translations.
 131
 132 ## Documentation
 133 Start reading at 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.
 134
 135 Examples of how to use PHPMailer for common scenarios can be found in the [examples](https://github.com/PHPMailer/PHPMailer/tree/master/examples) folder. If you're looking for a good starting point, we recommend you start with [the Gmail example](https://github.com/PHPMailer/PHPMailer/tree/master/examples/gmail.phps).
 136
 137 Note that in order to reduce PHPMailer's deployed code footprint, the examples are no longer included if you load PHPMailer via composer or via [GitHub's zip file download](https://github.com/PHPMailer/PHPMailer/archive/master.zip), so you'll need to either clone the git repository or use the above links to get to the examples directly.
 138
 139 Complete generated API documentation is [available online](http://phpmailer.github.io/PHPMailer/).
 140
 141 You can generate complete API-level documentation by running `phpdoc` in the top-level folder, and documentation will appear in teh `docs` folder, though you'll need to have [PHPDocumentor](http://www.phpdoc.org) installed. You may find [the unit tests](https://github.com/PHPMailer/PHPMailer/tree/master/test/phpmailerTest.php) a good source of how to do various operations such as encryption.
 142
 143 If the documentation doesn't cover what you need, search the [many questions on Stack Overflow](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).
 144
 145 ## Tests
 146 There is a PHPUnit test script in the [test](https://github.com/PHPMailer/PHPMailer/tree/master/test/) folder. PHPMailer uses PHPUnit 4.8 - we would use 5.x but we need to run on PHP 5.5.
 147
 148 Build status: [![Build Status](https://travis-ci.org/PHPMailer/PHPMailer.svg)](https://travis-ci.org/PHPMailer/PHPMailer)
 149
 150 If this isn't passing, is there something you can do to help?
 151
 152 ## Security
 153
 154 Please disclose any vulnerabilities found responsibly - report any security problems found to the maintainers privately.
 155
 156 PHPMailer versions prior to 5.2.22 (released January 9th 2017) have a local file disclosure vulnerability, [CVE-2017-5223](https://web.nvd.nist.gov/view/vuln/detail?vulnId=CVE-2017-5223). If content passed into `msgHTML()` is sourced from unfiltered user input, relative paths can map to absolute local file paths and added as attachments. Also note that `addAttachment` (just like `file_get_contents`, `passthru`, `unlink`, etc) should not be passed user-sourced params either! Reported by Yongxiang Li of Asiasecurity.
 157
 158 PHPMailer versions prior to 5.2.20 (released December 28th 2016) are vulnerable to [CVE-2016-10045](https://web.nvd.nist.gov/view/vuln/detail?vulnId=CVE-2016-10045) a remote code execution vulnerability, responsibly reported by [Dawid Golunski](https://legalhackers.com/advisories/PHPMailer-Exploit-Remote-Code-Exec-CVE-2016-10045-Vuln-Patch-Bypass.html), and patched by Paul Buonopane (@Zenexer).
 159
 160 PHPMailer versions prior to 5.2.18 (released December 2016) are vulnerable to [CVE-2016-10033](https://web.nvd.nist.gov/view/vuln/detail?vulnId=CVE-2016-10033) a critical remote code execution vulnerability, responsibly reported by [Dawid Golunski](http://legalhackers.com/advisories/PHPMailer-Exploit-Remote-Code-Exec-CVE-2016-10033-Vuln.html).
 161
 162 See [SECURITY](https://github.com/PHPMailer/PHPMailer/tree/master/SECURITY.md) for more detail on security issues.
 163
 164 ## Contributing
 165 Please submit bug reports, suggestions and pull requests to the [GitHub issue tracker](https://github.com/PHPMailer/PHPMailer/issues).
 166
 167 We're particularly interested in fixing edge-cases, expanding test coverage and updating translations.
 168
 169 If you found a mistake in the docs, or want to add something, go ahead and amend the wiki - anyone can edit it.
 170
 171 If you have git clones from prior to 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:
 172
 173 ```sh
 174 git remote set-url upstream https://github.com/PHPMailer/PHPMailer.git
 175 ```
 176
 177 Please *don't* use the SourceForge or Google Code projects any more; they are obsolete and no longer maintained.
 178
 179 ## Sponsorship
 180 Development time and resources for PHPMailer are provided by [Smartmessages.net](https://info.smartmessages.net/), a powerful email marketing system.
 181
 182 <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>
 183
 184 Other contributions are gladly received, whether in beer 🍺, T-shirts 👕, Amazon wishlist raids, or cold, hard cash 💰.
 185
 186 ## Changelog
 187 See [changelog](changelog.md).
 188
 189 ## History
 190 - PHPMailer was originally written in 2001 by Brent R. Matzelle as a [SourceForge project](http://sourceforge.net/projects/phpmailer/).
 191 - Marcus Bointon (coolbru on SF) and Andy Prevost (codeworxtech) took over the project in 2004.
 192 - Became an Apache incubator project on Google Code in 2010, managed by Jim Jagielski.
 193 - Marcus created his fork on [GitHub](https://github.com/Synchro/PHPMailer) in 2008.
 194 - Jim and Marcus decide to join forces and use GitHub as the canonical and official repo for PHPMailer in 2013.
 195 - PHPMailer moves to the [PHPMailer organisation](https://github.com/PHPMailer) on GitHub in 2013.
 196
 197 ### What's changed since moving from SourceForge?
 198 - Official successor to the SourceForge and Google Code projects.
 199 - Test suite.
 200 - Continuous integration with Travis-CI.
 201 - Composer support.
 202 - Public development.
 203 - Additional languages and language strings.
 204 - CRAM-MD5 authentication support.
 205 - Preserves full repo history of authors, commits and branches from the original SourceForge project.