lib/phpmailer/README.md

   1 [![SWUbanner](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://supportukrainenow.org/)
   2
   3 ![PHPMailer](https://raw.github.com/PHPMailer/PHPMailer/master/examples/images/phpmailer.png)
   4
   5 # PHPMailer – A full-featured email creation and transfer class for PHP
   6
   7 [![Test status](https://github.com/PHPMailer/PHPMailer/workflows/Tests/badge.svg)](https://github.com/PHPMailer/PHPMailer/actions)
   8 [![codecov.io](https://codecov.io/gh/PHPMailer/PHPMailer/branch/master/graph/badge.svg?token=iORZpwmYmM)](https://codecov.io/gh/PHPMailer/PHPMailer)
   9 [![Latest Stable Version](https://poser.pugx.org/phpmailer/phpmailer/v/stable.svg)](https://packagist.org/packages/phpmailer/phpmailer)
  10 [![Total Downloads](https://poser.pugx.org/phpmailer/phpmailer/downloads)](https://packagist.org/packages/phpmailer/phpmailer)
  11 [![License](https://poser.pugx.org/phpmailer/phpmailer/license.svg)](https://packagist.org/packages/phpmailer/phpmailer)
  12 [![API Docs](https://github.com/phpmailer/phpmailer/workflows/Docs/badge.svg)](https://phpmailer.github.io/PHPMailer/)
  13 [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/PHPMailer/PHPMailer/badge)](https://api.securityscorecards.dev/projects/github.com/PHPMailer/PHPMailer)
  14
  15 ## Features
  16 - Probably the world's most popular code for sending email from PHP!
  17 - Used by many open-source projects: WordPress, Drupal, 1CRM, SugarCRM, Yii, Joomla! and many more
  18 - Integrated SMTP support – send without a local mail server
  19 - Send emails with multiple To, CC, BCC, and Reply-to addresses
  20 - Multipart/alternative emails for mail clients that do not read HTML email
  21 - Add attachments, including inline
  22 - Support for UTF-8 content and 8bit, base64, binary, and quoted-printable encodings
  23 - SMTP authentication with LOGIN, PLAIN, CRAM-MD5, and XOAUTH2 mechanisms over SMTPS and SMTP+STARTTLS transports
  24 - Validates email addresses automatically
  25 - Protects against header injection attacks
  26 - Error messages in over 50 languages!
  27 - DKIM and S/MIME signing support
  28 - Compatible with PHP 5.5 and later, including PHP 8.2
  29 - Namespaced to prevent name clashes
  30 - Much more!
  31
  32 ## Why you might need it
  33 Many PHP developers need to send email from their code. The only PHP function that supports this directly 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.
  34
  35 Formatting email correctly is surprisingly difficult. There are myriad overlapping (and conflicting) standards, 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, if not unsafe!
  36
  37 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 client allows email sending on all platforms without needing a local mail server. Be aware though, that the `mail()` function should be avoided when possible; it's both faster and [safer](https://exploitbox.io/paper/Pwning-PHP-Mail-Function-For-Fun-And-RCE.html) to use SMTP to localhost.
  38
  39 *Please* don't be tempted to do it yourself – if you don't use PHPMailer, there are many other excellent libraries that
  40 you should look at before rolling your own. Try [SwiftMailer](https://swiftmailer.symfony.com/)
  41 , [Laminas/Mail](https://docs.laminas.dev/laminas-mail/), [ZetaComponents](https://github.com/zetacomponents/Mail), etc.
  42
  43 ## License
  44 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](https://github.com/PHPMailer/PHPMailer/blob/master/LICENSE) for information on the software availability and distribution.
  45
  46 ## Installation & loading
  47 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:
  48
  49 ```json
  50 "phpmailer/phpmailer": "^6.9.1"
  51 ```
  52
  53 or run
  54
  55 ```sh
  56 composer require phpmailer/phpmailer
  57 ```
  58
  59 Note that the `vendor` folder and the `vendor/autoload.php` script are generated by Composer; they are not part of PHPMailer.
  60
  61 If you want to use XOAUTH2 authentication, you will also need to add a dependency on the `league/oauth2-client` and appropriate service adapters package in your `composer.json`, or take a look at
  62 by @decomplexity's [SendOauth2 wrapper](https://github.com/decomplexity/SendOauth2), especially if you're using Microsoft services.
  63
  64 Alternatively, if you're not using Composer, you
  65 can [download PHPMailer as a zip file](https://github.com/PHPMailer/PHPMailer/archive/master.zip), (note that docs and examples are not included in the zip file), then 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:
  66
  67 ```php
  68 <?php
  69 use PHPMailer\PHPMailer\PHPMailer;
  70 use PHPMailer\PHPMailer\Exception;
  71
  72 require 'path/to/PHPMailer/src/Exception.php';
  73 require 'path/to/PHPMailer/src/PHPMailer.php';
  74 require 'path/to/PHPMailer/src/SMTP.php';
  75 ```
  76
  77 If you're not using the `SMTP` class explicitly (you're probably not), you don't need a `use` line for the SMTP class. Even if you're not using exceptions, you do still need to load the `Exception` class as it is used internally.
  78
  79 ## Legacy versions
  80 PHPMailer 5.2 (which is compatible with PHP 5.0 — 7.0) is no longer 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.
  81
  82 ### Upgrading from 5.2
  83 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.
  84
  85 ### Minimal installation
  86 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 (*very* unlikely!), 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!
  87
  88 ## A Simple Example
  89
  90 ```php
  91 <?php
  92 //Import PHPMailer classes into the global namespace
  93 //These must be at the top of your script, not inside a function
  94 use PHPMailer\PHPMailer\PHPMailer;
  95 use PHPMailer\PHPMailer\SMTP;
  96 use PHPMailer\PHPMailer\Exception;
  97
  98 //Load Composer's autoloader
  99 require 'vendor/autoload.php';
 100
 101 //Create an instance; passing `true` enables exceptions
 102 $mail = new PHPMailer(true);
 103
 104 try {
 105     //Server settings
 106     $mail->SMTPDebug = SMTP::DEBUG_SERVER;                      //Enable verbose debug output
 107     $mail->isSMTP();                                            //Send using SMTP
 108     $mail->Host       = 'smtp.example.com';                     //Set the SMTP server to send through
 109     $mail->SMTPAuth   = true;                                   //Enable SMTP authentication
 110     $mail->Username   = 'user@example.com';                     //SMTP username
 111     $mail->Password   = 'secret';                               //SMTP password
 112     $mail->SMTPSecure = PHPMailer::ENCRYPTION_SMTPS;            //Enable implicit TLS encryption
 113     $mail->Port       = 465;                                    //TCP port to connect to; use 587 if you have set `SMTPSecure = PHPMailer::ENCRYPTION_STARTTLS`
 114
 115     //Recipients
 116     $mail->setFrom('from@example.com', 'Mailer');
 117     $mail->addAddress('joe@example.net', 'Joe User');     //Add a recipient
 118     $mail->addAddress('ellen@example.com');               //Name is optional
 119     $mail->addReplyTo('info@example.com', 'Information');
 120     $mail->addCC('cc@example.com');
 121     $mail->addBCC('bcc@example.com');
 122
 123     //Attachments
 124     $mail->addAttachment('/var/tmp/file.tar.gz');         //Add attachments
 125     $mail->addAttachment('/tmp/image.jpg', 'new.jpg');    //Optional name
 126
 127     //Content
 128     $mail->isHTML(true);                                  //Set email format to HTML
 129     $mail->Subject = 'Here is the subject';
 130     $mail->Body    = 'This is the HTML message body <b>in bold!</b>';
 131     $mail->AltBody = 'This is the body in plain text for non-HTML mail clients';
 132
 133     $mail->send();
 134     echo 'Message has been sent';
 135 } catch (Exception $e) {
 136     echo "Message could not be sent. Mailer Error: {$mail->ErrorInfo}";
 137 }
 138 ```
 139
 140 You'll find plenty to play with in the [examples](https://github.com/PHPMailer/PHPMailer/tree/master/examples) folder, which covers many common scenarios including sending through Gmail, building contact forms, sending to mailing lists, and more.
 141
 142 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.
 143
 144 That's it. You should now be ready to use PHPMailer!
 145
 146 ## Localization
 147 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:
 148
 149 ```php
 150 //To load the French version
 151 $mail->setLanguage('fr', '/optional/path/to/language/directory/');
 152 ```
 153
 154 We welcome corrections and new languages – if you're looking for corrections, run the [Language/TranslationCompletenessTest.php](https://github.com/PHPMailer/PHPMailer/blob/master/test/Language/TranslationCompletenessTest.php) script in the tests folder and it will show any missing translations.
 155
 156 ## Documentation
 157 Start reading at the [GitHub wiki](https://github.com/PHPMailer/PHPMailer/wiki). If you're having trouble, head for [the troubleshooting guide](https://github.com/PHPMailer/PHPMailer/wiki/Troubleshooting) as it's frequently updated.
 158
 159 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).
 160
 161 To reduce PHPMailer's deployed code footprint, examples are not 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.
 162
 163 Complete generated API documentation is [available online](https://phpmailer.github.io/PHPMailer/).
 164
 165 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 reference for how to do various operations such as encryption.
 166
 167 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).
 168
 169 ## Tests
 170 [PHPMailer tests](https://github.com/PHPMailer/PHPMailer/tree/master/test/) use PHPUnit 9, with [a polyfill](https://github.com/Yoast/PHPUnit-Polyfills) to let 9-style tests run on older PHPUnit and PHP versions.
 171
 172 [![Test status](https://github.com/PHPMailer/PHPMailer/workflows/Tests/badge.svg)](https://github.com/PHPMailer/PHPMailer/actions)
 173
 174 If this isn't passing, is there something you can do to help?
 175
 176 ## Security
 177 Please disclose any vulnerabilities found responsibly – report security issues to the maintainers privately.
 178
 179 See [SECURITY](https://github.com/PHPMailer/PHPMailer/tree/master/SECURITY.md) and [PHPMailer's security advisories on GitHub](https://github.com/PHPMailer/PHPMailer/security).
 180
 181 ## Contributing
 182 Please submit bug reports, suggestions, and pull requests to the [GitHub issue tracker](https://github.com/PHPMailer/PHPMailer/issues).
 183
 184 We're particularly interested in fixing edge cases, expanding test coverage, and updating translations.
 185
 186 If you found a mistake in the docs, or want to add something, go ahead and amend the wiki – anyone can edit it.
 187
 188 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:
 189
 190 ```sh
 191 git remote set-url upstream https://github.com/PHPMailer/PHPMailer.git
 192 ```
 193
 194 Please *don't* use the SourceForge or Google Code projects any more; they are obsolete and no longer maintained.
 195
 196 ## Sponsorship
 197 Development time and resources for PHPMailer are provided by [Smartmessages.net](https://info.smartmessages.net/), the world's only privacy-first email marketing system.
 198
 199 <a href="https://info.smartmessages.net/"><img src="https://www.smartmessages.net/img/smartmessages-logo.svg" width="550" alt="Smartmessages.net privacy-first email marketing logo"></a>
 200
 201 Donations are very welcome, whether in beer 🍺, T-shirts 👕, or cold, hard cash 💰. Sponsorship through GitHub is a simple and convenient way to say "thank you" to PHPMailer's maintainers and contributors – just click the "Sponsor" button [on the project page](https://github.com/PHPMailer/PHPMailer). If your company uses PHPMailer, consider taking part in Tidelift's enterprise support programme.
 202
 203 ## PHPMailer For Enterprise
 204
 205 Available as part of the Tidelift Subscription.
 206
 207 The maintainers of PHPMailer and thousands of other packages are working with Tidelift to deliver commercial
 208 support and maintenance for the open-source packages you use to build your applications. Save time, reduce risk, and
 209 improve code health, while paying the maintainers of the exact packages you
 210 use. [Learn more.](https://tidelift.com/subscription/pkg/packagist-phpmailer-phpmailer?utm_source=packagist-phpmailer-phpmailer&utm_medium=referral&utm_campaign=enterprise&utm_term=repo)
 211
 212 ## Changelog
 213 See [changelog](changelog.md).
 214
 215 ## History
 216 - PHPMailer was originally written in 2001 by Brent R. Matzelle as a [SourceForge project](http://sourceforge.net/projects/phpmailer/).
 217 - [Marcus Bointon](https://github.com/Synchro) (`coolbru` on SF) and Andy Prevost (`codeworxtech`) took over the project in 2004.
 218 - Became an Apache incubator project on Google Code in 2010, managed by Jim Jagielski.
 219 - Marcus created [his fork on GitHub](https://github.com/Synchro/PHPMailer) in 2008.
 220 - Jim and Marcus decide to join forces and use GitHub as the canonical and official repo for PHPMailer in 2013.
 221 - PHPMailer moves to [the PHPMailer organisation](https://github.com/PHPMailer) on GitHub in 2013.
 222
 223 ### What's changed since moving from SourceForge?
 224 - Official successor to the SourceForge and Google Code projects.
 225 - Test suite.
 226 - Continuous integration with GitHub Actions.
 227 - Composer support.
 228 - Public development.
 229 - Additional languages and language strings.
 230 - CRAM-MD5 authentication support.
 231 - Preserves full repo history of authors, commits, and branches from the original SourceForge project.