README.md 11.5 KB
Newer Older
1
2
![PHPMailer](https://raw.github.com/PHPMailer/PHPMailer/master/examples/images/phpmailer.png)

Aaron Wells's avatar
Aaron Wells committed
3
4
# PHPMailer - A full-featured email creation and transfer class for PHP

5
6
7
Build status: [![Build Status](https://travis-ci.org/PHPMailer/PHPMailer.svg)](https://travis-ci.org/PHPMailer/PHPMailer)
[![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/PHPMailer/PHPMailer/badges/quality-score.png?s=3758e21d279becdf847a557a56a3ed16dfec9d5d)](https://scrutinizer-ci.com/g/PHPMailer/PHPMailer/)
[![Code Coverage](https://scrutinizer-ci.com/g/PHPMailer/PHPMailer/badges/coverage.png?s=3fe6ca5fe8cd2cdf96285756e42932f7ca256962)](https://scrutinizer-ci.com/g/PHPMailer/PHPMailer/)
Aaron Wells's avatar
Aaron Wells committed
8

9
10
[![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)

Aaron Wells's avatar
Aaron Wells committed
11
12
13
## Class Features

- 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
Aaron Wells's avatar
Aaron Wells committed
15
- Integrated SMTP support - send without a local mail server
16
- Send emails with multiple TOs, CCs, BCCs and REPLY-TOs
Aaron Wells's avatar
Aaron Wells committed
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
20
- SMTP authentication with LOGIN, PLAIN, NTLM, CRAM-MD5 and Google's XOAUTH2 mechanisms over SSL and TLS transports
- Error messages in 47 languages!
21
- DKIM and S/MIME signing support
Aaron Wells's avatar
Aaron Wells committed
22
23
24
25
26
27
28
29
30
31
32
33
34
35
- Compatible with PHP 5.0 and later
- Much more!

## Why you might need it

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.

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!
*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.

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.

## 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
Aaron Wells's avatar
Aaron Wells committed
37
38
software availability and distribution.

39
## Installation & loading
Aaron Wells's avatar
Aaron Wells committed
40

41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
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:

```json
"phpmailer/phpmailer": "~5.2"
```

or

```sh
composer require phpmailer/phpmailer
```

If you want to use the Gmail XOAUTH2 authentication class, you will also need to add a dependency on the `league/oauth2-client` package.

Alternatively, copy the contents of the PHPMailer folder into one of the `include_path` directories specified in your PHP configuration.. If you don't speak git or just want a tarball, click the 'zip' button at the top of the page in GitHub.

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.
Aaron Wells's avatar
Aaron Wells committed
58

59
60
PHPMailer does *not* declare a namespace because namespaces were only introduced in PHP 5.3.

61
62
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
64
### 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.
Aaron Wells's avatar
Aaron Wells committed
66
67
68
69
70

## A Simple Example

```php
<?php
71
require 'PHPMailerAutoload.php';
Aaron Wells's avatar
Aaron Wells committed
72
73
74

$mail = new PHPMailer;

75
76
//$mail->SMTPDebug = 3;                               // Enable verbose debug output

Aaron Wells's avatar
Aaron Wells committed
77
$mail->isSMTP();                                      // Set mailer to use SMTP
78
$mail->Host = 'smtp1.example.com;smtp2.example.com';  // Specify main and backup SMTP servers
Aaron Wells's avatar
Aaron Wells committed
79
$mail->SMTPAuth = true;                               // Enable SMTP authentication
80
$mail->Username = 'user@example.com';                 // SMTP username
Aaron Wells's avatar
Aaron Wells committed
81
$mail->Password = 'secret';                           // SMTP password
82
83
$mail->SMTPSecure = 'tls';                            // Enable TLS encryption, `ssl` also accepted
$mail->Port = 587;                                    // TCP port to connect to
Aaron Wells's avatar
Aaron Wells committed
84

85
$mail->setFrom('from@example.com', 'Mailer');
86
$mail->addAddress('joe@example.net', 'Joe User');     // Add a recipient
Aaron Wells's avatar
Aaron Wells committed
87
88
89
90
91
92
93
94
95
96
97
98
99
100
$mail->addAddress('ellen@example.com');               // Name is optional
$mail->addReplyTo('info@example.com', 'Information');
$mail->addCC('cc@example.com');
$mail->addBCC('bcc@example.com');

$mail->addAttachment('/var/tmp/file.tar.gz');         // Add attachments
$mail->addAttachment('/tmp/image.jpg', 'new.jpg');    // Optional name
$mail->isHTML(true);                                  // Set email format to HTML

$mail->Subject = 'Here is the subject';
$mail->Body    = 'This is the HTML message body <b>in bold!</b>';
$mail->AltBody = 'This is the body in plain text for non-HTML mail clients';

if(!$mail->send()) {
101
102
103
104
    echo 'Message could not be sent.';
    echo 'Mailer Error: ' . $mail->ErrorInfo;
} else {
    echo 'Message has been sent';
Aaron Wells's avatar
Aaron Wells committed
105
106
107
}
```

108
You'll find plenty more to play with in the [examples](examples/) folder.
Aaron Wells's avatar
Aaron Wells committed
109
110
111
112

That's it. You should now be ready to use PHPMailer!

## 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:
Aaron Wells's avatar
Aaron Wells committed
114
115
116
117
118
119

```php
// To load the French version
$mail->setLanguage('fr', '/optional/path/to/language/directory/');
```

120
121
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.

Aaron Wells's avatar
Aaron Wells committed
122
123
## Documentation

124
125
126
127
128
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).

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.

Complete generated API documentation is [available online](http://phpmailer.github.io/PHPMailer/).
129
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.
Aaron Wells's avatar
Aaron Wells committed
131

132
133
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).

Aaron Wells's avatar
Aaron Wells committed
134
135
## Tests

136
There is a PHPUnit test script in the [test](test/) folder.
Aaron Wells's avatar
Aaron Wells committed
137

138
Build status: [![Build Status](https://travis-ci.org/PHPMailer/PHPMailer.svg)](https://travis-ci.org/PHPMailer/PHPMailer)
Aaron Wells's avatar
Aaron Wells committed
139
140
141
142
143
144
145
146
147
148
149

If this isn't passing, is there something you can do to help?

## Contributing

Please submit bug reports, suggestions and pull requests to the [GitHub issue tracker](https://github.com/PHPMailer/PHPMailer/issues).

We're particularly interested in fixing edge-cases, expanding test coverage and updating translations.

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
151
152
```sh
git remote set-url upstream https://github.com/PHPMailer/PHPMailer.git
```
Aaron Wells's avatar
Aaron Wells committed
153
154
155

Please *don't* use the SourceForge or Google Code projects any more.

156
157
158
159
160
161
162
163
## Sponsorship

Development time and resources for PHPMailer are provided by [Smartmessages.net](https://info.smartmessages.net/), a powerful email marketing system.

<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>

Other contributions are gladly received, whether in beer 🍺, T-shirts 👕, Amazon wishlist raids, or cold, hard cash 💰.

Aaron Wells's avatar
Aaron Wells committed
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
## Changelog

See [changelog](changelog.md).

## History
- PHPMailer was originally written in 2001 by Brent R. Matzelle as a [SourceForge project](http://sourceforge.net/projects/phpmailer/).
- Marcus Bointon (coolbru on SF) and Andy Prevost (codeworxtech) took over the project in 2004.
- Became an Apache incubator project on Google Code in 2010, managed by Jim Jagielski.
- Marcus created his fork on [GitHub](https://github.com/Synchro/PHPMailer).
- Jim and Marcus decide to join forces and use GitHub as the canonical and official repo for PHPMailer.
- PHPMailer moves to the [PHPMailer organisation](https://github.com/PHPMailer) on GitHub.

### What's changed since moving from SourceForge?
- Official successor to the SourceForge and Google Code projects.
- Test suite.
- Continuous integration with Travis-CI.
- Composer support.
181
- Public development.
Aaron Wells's avatar
Aaron Wells committed
182
183
184
- Additional languages and language strings.
- CRAM-MD5 authentication support.
- Preserves full repo history of authors, commits and branches from the original SourceForge project.