Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nette/mail
A handy library for creating and sending emails in PHP
https://github.com/nette/mail
html mail mailer nette nette-framework php
Last synced: about 2 months ago
JSON representation
A handy library for creating and sending emails in PHP
- Host: GitHub
- URL: https://github.com/nette/mail
- Owner: nette
- License: other
- Created: 2014-03-13T03:46:38.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-06-18T21:23:55.000Z (3 months ago)
- Last Synced: 2024-06-19T10:54:10.169Z (3 months ago)
- Topics: html, mail, mailer, nette, nette-framework, php
- Language: PHP
- Homepage: https://doc.nette.org/mailing
- Size: 450 KB
- Stars: 458
- Watchers: 39
- Forks: 70
- Open Issues: 10
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
- awesome-opensource-email - Nette Mail - Handy email creation and transfer library for PHP with both text and MIME-compliant support. (Code / Library)
README
[](https://doc.nette.org/en/mail)
[](https://packagist.org/packages/nette/mail)
[](https://github.com/nette/mail/actions)
[](https://coveralls.io/github/nette/mail?branch=master)
[](https://github.com/nette/mail/releases)
[](https://github.com/nette/mail/blob/master/license.md)
Introduction
------------
Are you going to send emails such as newsletters or order confirmations? Nette Framework provides the necessary tools with a very nice API.
Documentation can be found on the [website](https://doc.nette.org/en/mail).
[Support Me](https://github.com/sponsors/dg)
--------------------------------------------
Do you like Nette Mail? Are you looking forward to the new features?
[](https://github.com/sponsors/dg)
Thank you!
Installation
------------
```shell
composer require nette/mail
```
It requires PHP version 8.0 and supports PHP up to 8.4.
Creating Emails
===============
Email is a [Nette\Mail\Message](https://api.nette.org/3.0/Nette/Mail/Message.html) object:
```php
$mail = new Nette\Mail\Message;
$mail->setFrom('John ')
->addTo('[email protected]')
->addTo('[email protected]')
->setSubject('Order Confirmation')
->setBody("Hello, Your order has been accepted.");
```
All parameters must be encoded in UTF-8.
In addition to specifying recipients with the `addTo()` method, you can also specify the recipient of copy with `addCc()`, or the recipient of blind copy with `addBcc()`. All these methods, including `setFrom()`, accepts addressee in three ways:
```php
$mail->setFrom('[email protected]');
$mail->setFrom('[email protected]', 'John Doe');
$mail->setFrom('John Doe ');
```
The body of an email written in HTML is passed using the `setHtmlBody()` method:
```php
$mail->setHtmlBody('
Hello,
Your order has been accepted.
');
```
You don't have to create a text alternative, Nette will generate it automatically for you. And if the email does not have a subject set, it will be taken from the `` element.
Images can also be extremely easily inserted into the HTML body of an email. Just pass the path where the images are physically located as the second parameter, and Nette will automatically include them in the email:
```php
// automatically adds /path/to/images/background.gif to the email
$mail->setHtmlBody(
'Hello 
',
'/path/to/images',
);
```
The image embedding algorithm supports the following patterns: `
`, ``, `url(...)` inside the HTML attribute `style` and special syntax `[[...]]`.
Can sending emails be even easier?
Emails are like postcards. Never send passwords or other credentials via email.
Attachments
-----------
You can, of course, attach attachments to email. Use the `addAttachment(string $file, string $content = null, string $contentType = null)`.
```php
// inserts the file /path/to/example.zip into the email under the name example.zip
$mail->addAttachment('/path/to/example.zip');
// inserts the file /path/to/example.zip into the email under the name info.zip
$mail->addAttachment('info.zip', file_get_contents('/path/to/example.zip'));
// attaches new example.txt file contents "Hello John!"
$mail->addAttachment('example.txt', 'Hello John!');
```
Templates
---------
If you send HTML emails, it's a great idea to write them in the [Latte](https://latte.nette.org) template system. How to do it?
```php
$latte = new Latte\Engine;
$params = [
'orderId' => 123,
];
$mail = new Nette\Mail\Message;
$mail->setFrom('John ')
->addTo('[email protected]')
->setHtmlBody(
$latte->renderToString('/path/to/email.latte', $params),
'/path/to/images',
);
```
File `email.latte`:
```latte
Order Confirmation
body {
background: url("background.png")
}
Hello,
Your order number {$orderId} has been accepted.
```
Nette automatically inserts all images, sets the subject according to the `` element, and generates text alternative for HTML body.
Sending Emails
==============
Mailer is class responsible for sending emails. It implements the [Nette\Mail\Mailer](https://api.nette.org/3.0/Nette/Mail/Mailer.html) interface and several ready-made mailers are available which we will introduce.
SendmailMailer
--------------
The default mailer is SendmailMailer which uses PHP function `mail()`. Example of use:
```php
$mailer = new Nette\Mail\SendmailMailer;
$mailer->send($mail);
```
If you want to set `returnPath` and the server still overwrites it, use `$mailer->commandArgs = '[email protected]'`.
SmtpMailer
----------
To send mail via the SMTP server, use `SmtpMailer`.
```php
$mailer = new Nette\Mail\SmtpMailer(
host: 'smtp.gmail.com',
username: '[email protected]',
password: '*****',
encryption: Nette\Mail\SmtpMailer::EncryptionSSL,
);
$mailer->send($mail);
```
The following additional parameters can be passed to the constructor:
* `port` - if not set, the default 25 or 465 for `ssl` will be used
* `timeout` - timeout for SMTP connection
* `persistent` - use persistent connection
* `clientHost` - client designation
* `streamOptions` - allows you to set [SSL context options](https://www.php.net/manual/en/context.ssl.php) for connection
FallbackMailer
--------------
It does not send email but sends them through a set of mailers. If one mailer fails, it repeats the attempt at the next one. If the last one fails, it starts again from the first one.
```php
$mailer = new Nette\Mail\FallbackMailer([
$smtpMailer,
$backupSmtpMailer,
$sendmailMailer,
]);
$mailer->send($mail);
```
Other parameters in the constructor include the number of repeat and waiting time in milliseconds.
DKIM
====
DKIM (DomainKeys Identified Mail) is a trustworthy email technology that also helps detect spoofed messages. The sent message is signed with the private key of the sender's domain and this signature is stored in the email header.
The recipient's server compares this signature with the public key stored in the domain's DNS records. By matching the signature, it is shown that the email actually originated from the sender's domain and that the message was not modified during the transmission of the message.
```php
$signer = new Nette\Mail\DkimSigner(
domain: 'nette.org',
selector: 'dkim',
privateKey: file_get_contents('../dkim/dkim.key'),
passPhrase: '****',
);
$mailer = new Nette\Mail\SendmailMailer; // or SmtpMailer
$mailer->setSigner($signer);
$mailer->send($mail);
```