REPOSITORY OVERVIEW

Live repository statistics

★ 493Stars

⑂ 72Forks

◯ 0Open issues

◉ 493Watchers

78/100

OPENREPOHUB HEALTH SIGNAL

Healthy signals

A transparent discovery signal based on current public GitHub metadata.

Recent activity35% weight

100

Community adoption25% weight

Maintenance state20% weight

100

License clarity10% weight

Project information10% weight

100

This score does not audit code, security, maintainers, documentation quality, or suitability. Verify the repository and its current documentation before adoption.

README preview

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.

Support Me

Do you like Nette Mail? Are you looking forward to the new features?

Thank you!

Installation

composer require nette/mail

It requires PHP version 8.2 and supports PHP up to 8.5.

Creating Emails

Email is a Nette\Mail\Message object:

$mail = new Nette\Mail\Message;
$mail->setFrom('John <john@example.com>')
	->addTo('peter@example.com')
	->addTo('jack@example.com')
	->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:

$mail->setFrom('john.doe@example.com');
$mail->setFrom('john.doe@example.com', 'John Doe');
$mail->setFrom('John Doe <john.doe@example.com>');

The body of an email written in HTML is passed using the setHtmlBody() method:

$mail->setHtmlBody('<p>Hello,</p><p>Your order has been accepted.</p>');

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

// automatically adds /path/to/images/background.gif to the email
$mail->setHtmlBody(
	'<b>Hello</b> <img src="background.gif">',
	'/path/to/images',
);

The image embedding algorithm supports the following patterns: <img src=...>, <body background=...>, 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).

// 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 template system. How to do it?

$latte = new Latte\Engine;
$params = [
	'orderId' => 123,
];

$mail = new Nette\Mail\Message;
$mail->setFrom('John <john@example.com>')
	->addTo('jack@example.com')
	->setHtmlBody(
		$latte->renderToString('/path/to/email.latte', $params),
		'/path/to/images',
	);

File email.latte:

<html>
<head>
	<meta charset="utf-8">
	<title>Order Confirmation</title>
	<style>
	body {
		background: url("background.png")
	}
	</style>
</head>
<body>
	<p>Hello,</p>

	<p>Your order number {$orderId} has been accepted.</p>
</body>
</html>

Nette automatically inserts all images, sets the subject according to the <title> element, and generates text alternative for HTML body.

CSS Inlining

Email clients often ignore <style> tags, so CSS needs to be applied as inline style attributes. The CssInliner does this automatically and also adds HTML attributes (bgcolor, width, align) for Outlook.

$html = (new Nette\Mail\CssInliner)
	->addCss('p { margin: 0; } a { color: #a0704e; }')
	->inline($html);

Rules from <style> tags in the HTML are extracted and inlined too. The <style> tags are preserved so that @media queries keep working. CSS nesting is supported.

Requires PHP 8.4+ (ext-dom).

Sending Emails

Mailer is class responsible for sending emails. It implements the Nette\Mail\Mailer 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:

$mailer = new Nette\Mail\SendmailMailer;
$mailer->send($mail);

If you want to set returnPath and the server still overwrites it, use $mailer->commandArgs = '-fmy@email.com'.

SmtpMailer

To send mail via the SMTP server, use SmtpMailer.

$mailer = new Nette\Mail\SmtpMailer(
	host: 'smtp.gmail.com',
	username: 'franta@gmail.com',
	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 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.

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

Interceptor

For debugging or as a safety net on staging, Interceptor wraps any mailer. When redirectTo is set, every outgoing message is cloned and the headers To, Cc, Bcc, Disposition-Notification-To and X-Confirm-Reading-To are replaced with the fixed address; the original values are preserved as X-Original-* headers and the original Message instance is left untouched.

$mailer = new Nette\Mail\Interceptor(
	mailer: $smtpMailer,
	redirectTo: 'dev@example.com',
	subjectPrefix: '[debug]',
);
$mailer->send($mail);

The $onSent callable list is invoked after each send() with the original Message (before any redirect rewrite) and either null on success or a Throwable on failure:

$mailer->onSent[] = function (Nette\Mail\Interceptor $sender, Nette\Mail\Message $mail, ?Throwable $error): void {
	// audit log, metrics, …
};

In a Nette application, the Interceptor is wired automatically when mail.redirect or mail.debugger: true is set. In debug mode, a Tracy Bar panel listing sent emails is attached as well.

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.

$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);