You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

221 lines
16 KiB

3 years ago
3 years ago
3 years ago
  1. ![PHPMailer](https://raw.github.com/PHPMailer/PHPMailer/master/examples/images/phpmailer.png)
  2. # PHPMailer - A full-featured email creation and transfer class for PHP
  3. Build status: [![Build Status](https://travis-ci.org/PHPMailer/PHPMailer.svg)](https://travis-ci.org/PHPMailer/PHPMailer)
  4. [![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/PHPMailer/PHPMailer/badges/quality-score.png?s=3758e21d279becdf847a557a56a3ed16dfec9d5d)](https://scrutinizer-ci.com/g/PHPMailer/PHPMailer/)
  5. [![Code Coverage](https://scrutinizer-ci.com/g/PHPMailer/PHPMailer/badges/coverage.png?s=3fe6ca5fe8cd2cdf96285756e42932f7ca256962)](https://scrutinizer-ci.com/g/PHPMailer/PHPMailer/)
  6. [![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) [![API Docs](https://github.com/phpmailer/phpmailer/workflows/Docs/badge.svg)](http://phpmailer.github.io/PHPMailer/)
  7. ## Class Features
  8. - Probably the world's most popular code for sending email from PHP!
  9. - Used by many open-source projects: WordPress, Drupal, 1CRM, SugarCRM, Yii, Joomla! and many more
  10. - Integrated SMTP support - send without a local mail server
  11. - Send emails with multiple To, CC, BCC and Reply-to addresses
  12. - Multipart/alternative emails for mail clients that do not read HTML email
  13. - Add attachments, including inline
  14. - Support for UTF-8 content and 8bit, base64, binary, and quoted-printable encodings
  15. - SMTP authentication with LOGIN, PLAIN, CRAM-MD5, and XOAUTH2 mechanisms over SSL and SMTP+STARTTLS transports
  16. - Validates email addresses automatically
  17. - Protect against header injection attacks
  18. - Error messages in over 50 languages!
  19. - DKIM and S/MIME signing support
  20. - Compatible with PHP 5.5 and later
  21. - Namespaced to prevent name clashes
  22. - Much more!
  23. ## Why you might need it
  24. Many PHP developers need to send email from their code. The only PHP function that supports this is [`mail()`](https://www.php.net/manual/en/function.mail.php). However, it does not provide any assistance for making use of popular features such as encryption, authentication, HTML messages, and attachments.
  25. 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!
  26. *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](https://swiftmailer.symfony.com/), [Zend/Mail](https://zendframework.github.io/zend-mail/), [ZetaComponents](https://github.com/zetacomponents/Mail) etc.
  27. The PHP `mail()` function usually sends via a local mail server, typically fronted by a `sendmail` binary on Linux, BSD, and macOS 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.
  28. ## License
  29. This software is distributed under the [LGPL 2.1](http://www.gnu.org/licenses/lgpl-2.1.html) license, along with the [GPL Cooperation Commitment](https://gplcc.github.io/gplcc/). Please read LICENSE for information on the software availability and distribution.
  30. ## Installation & loading
  31. PHPMailer is available on [Packagist](https://packagist.org/packages/phpmailer/phpmailer) (using semantic versioning), and installation via [Composer](https://getcomposer.org) is the recommended way to install PHPMailer. Just add this line to your `composer.json` file:
  32. ```json
  33. "phpmailer/phpmailer": "~6.1"
  34. ```
  35. or run
  36. ```sh
  37. composer require phpmailer/phpmailer
  38. ```
  39. Note that the `vendor` folder and the `vendor/autoload.php` script are generated by Composer; they are not part of PHPMailer.
  40. 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`.
  41. 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 class file manually:
  42. ```php
  43. <?php
  44. use PHPMailer\PHPMailer\PHPMailer;
  45. use PHPMailer\PHPMailer\Exception;
  46. require 'path/to/PHPMailer/src/Exception.php';
  47. require 'path/to/PHPMailer/src/PHPMailer.php';
  48. require 'path/to/PHPMailer/src/SMTP.php';
  49. ```
  50. If you're not using the `SMTP` class explicitly (you're probably not), you don't need a `use` line for the SMTP class.
  51. If you don't speak git or just want a tarball, click the 'zip' button on the right of the project page in GitHub, though note that docs and examples are not included in the tarball.
  52. ## Legacy versions
  53. PHPMailer 5.2 (which is compatible with PHP 5.0 - 7.0) is no longer being supported, even for security updates. You will find the latest version of 5.2 in the [5.2-stable branch](https://github.com/PHPMailer/PHPMailer/tree/5.2-stable). If you're using PHP 5.5 or later (which you should be), switch to the 6.x releases.
  54. ### Upgrading from 5.2
  55. The biggest changes are that source files are now in the `src/` folder, and PHPMailer now declares the namespace `PHPMailer\PHPMailer`. This has several important effects – [read the upgrade guide](https://github.com/PHPMailer/PHPMailer/tree/master/UPGRADING.md) for more details.
  56. ### Minimal installation
  57. 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!
  58. ## A Simple Example
  59. ```php
  60. <?php
  61. // Import PHPMailer classes into the global namespace
  62. // These must be at the top of your script, not inside a function
  63. use PHPMailer\PHPMailer\PHPMailer;
  64. use PHPMailer\PHPMailer\SMTP;
  65. use PHPMailer\PHPMailer\Exception;
  66. // Load Composer's autoloader
  67. require 'vendor/autoload.php';
  68. // Instantiation and passing `true` enables exceptions
  69. $mail = new PHPMailer(true);
  70. try {
  71. //Server settings
  72. $mail->SMTPDebug = SMTP::DEBUG_SERVER; // Enable verbose debug output
  73. $mail->isSMTP(); // Send using SMTP
  74. $mail->Host = 'smtp1.example.com'; // Set the SMTP server to send through
  75. $mail->SMTPAuth = true; // Enable SMTP authentication
  76. $mail->Username = 'user@example.com'; // SMTP username
  77. $mail->Password = 'secret'; // SMTP password
  78. $mail->SMTPSecure = PHPMailer::ENCRYPTION_STARTTLS; // Enable TLS encryption; `PHPMailer::ENCRYPTION_SMTPS` encouraged
  79. $mail->Port = 587; // TCP port to connect to, use 465 for `PHPMailer::ENCRYPTION_SMTPS` above
  80. //Recipients
  81. $mail->setFrom('from@example.com', 'Mailer');
  82. $mail->addAddress('joe@example.net', 'Joe User'); // Add a recipient
  83. $mail->addAddress('ellen@example.com'); // Name is optional
  84. $mail->addReplyTo('info@example.com', 'Information');
  85. $mail->addCC('cc@example.com');
  86. $mail->addBCC('bcc@example.com');
  87. // Attachments
  88. $mail->addAttachment('/var/tmp/file.tar.gz'); // Add attachments
  89. $mail->addAttachment('/tmp/image.jpg', 'new.jpg'); // Optional name
  90. // Content
  91. $mail->isHTML(true); // Set email format to HTML
  92. $mail->Subject = 'Here is the subject';
  93. $mail->Body = 'This is the HTML message body <b>in bold!</b>';
  94. $mail->AltBody = 'This is the body in plain text for non-HTML mail clients';
  95. $mail->send();
  96. echo 'Message has been sent';
  97. } catch (Exception $e) {
  98. echo "Message could not be sent. Mailer Error: {$mail->ErrorInfo}";
  99. }
  100. ```
  101. You'll find plenty more to play with in the [examples](https://github.com/PHPMailer/PHPMailer/tree/master/examples) folder.
  102. If you are re-using the instance (e.g. when sending to a mailing list), you may need to clear the recipient list to avoid sending duplicate messages. See [the mailing list example](https://github.com/PHPMailer/PHPMailer/blob/master/examples/mailing_list.phps) for further guidance.
  103. That's it. You should now be ready to use PHPMailer!
  104. ## Localization
  105. PHPMailer defaults to English, but in the [language](https://github.com/PHPMailer/PHPMailer/tree/master/language/) folder you'll find many 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:
  106. ```php
  107. // To load the French version
  108. $mail->setLanguage('fr', '/optional/path/to/language/directory/');
  109. ```
  110. 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.
  111. ## Documentation
  112. 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.
  113. 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).
  114. 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.
  115. Complete generated API documentation is [available online](http://phpmailer.github.io/PHPMailer/).
  116. You can generate complete API-level documentation by running `phpdoc` in the top-level folder, and documentation will appear in the `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/blob/master/test/PHPMailerTest.php) a good source of how to do various operations such as encryption.
  117. 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).
  118. ## Tests
  119. 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.
  120. Build status: [![Build Status](https://travis-ci.org/PHPMailer/PHPMailer.svg)](https://travis-ci.org/PHPMailer/PHPMailer)
  121. If this isn't passing, is there something you can do to help?
  122. ## Security
  123. Please disclose any vulnerabilities found responsibly - report any security problems found to the maintainers privately.
  124. 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.
  125. 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).
  126. 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).
  127. See [SECURITY](https://github.com/PHPMailer/PHPMailer/tree/master/SECURITY.md) for more detail on security issues.
  128. ## Contributing
  129. Please submit bug reports, suggestions and pull requests to the [GitHub issue tracker](https://github.com/PHPMailer/PHPMailer/issues).
  130. We're particularly interested in fixing edge-cases, expanding test coverage and updating translations.
  131. If you found a mistake in the docs, or want to add something, go ahead and amend the wiki - anyone can edit it.
  132. 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:
  133. ```sh
  134. git remote set-url upstream https://github.com/PHPMailer/PHPMailer.git
  135. ```
  136. Please *don't* use the SourceForge or Google Code projects any more; they are obsolete and no longer maintained.
  137. ## Sponsorship
  138. Development time and resources for PHPMailer are provided by [Smartmessages.net](https://info.smartmessages.net/), a powerful email marketing system.
  139. <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>
  140. Other contributions are gladly received, whether in beer 🍺, T-shirts 👕, Amazon wishlist raids, or cold, hard cash 💰. If you'd like to donate to say "thank you" to maintainers or contributors, please contact them through individual profile pages via [the contributors page](https://github.com/PHPMailer/PHPMailer/graphs/contributors).
  141. ## Changelog
  142. See [changelog](changelog.md).
  143. ## History
  144. - PHPMailer was originally written in 2001 by Brent R. Matzelle as a [SourceForge project](http://sourceforge.net/projects/phpmailer/).
  145. - Marcus Bointon (coolbru on SF) and Andy Prevost (codeworxtech) took over the project in 2004.
  146. - Became an Apache incubator project on Google Code in 2010, managed by Jim Jagielski.
  147. - Marcus created his fork on [GitHub](https://github.com/Synchro/PHPMailer) in 2008.
  148. - Jim and Marcus decide to join forces and use GitHub as the canonical and official repo for PHPMailer in 2013.
  149. - PHPMailer moves to the [PHPMailer organisation](https://github.com/PHPMailer) on GitHub in 2013.
  150. ### What's changed since moving from SourceForge?
  151. - Official successor to the SourceForge and Google Code projects.
  152. - Test suite.
  153. - Continuous integration with Travis-CI.
  154. - Composer support.
  155. - Public development.
  156. - Additional languages and language strings.
  157. - CRAM-MD5 authentication support.
  158. - Preserves full repo history of authors, commits and branches from the original SourceForge project.