Skip to content

Commit 90bf62a

Browse files
dgdg
committed
readme: added jumbo, updated
1 parent 33bf386 commit 90bf62a

File tree

1 file changed

+34
-24
lines changed

1 file changed

+34
-24
lines changed

‎readme.md‎

Lines changed: 34 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
1-
Nette Mail: Sending E-mails
2-
===========================
1+
[![Nette Mail](https://github.com/nette/mail/assets/194960/8b2371bd-0976-443c-b60a-460eb8b3222f)](https://doc.nette.org/en/mail)
32

43
[![Downloads this Month](https://img.shields.io/packagist/dm/nette/mail.svg)](https://packagist.org/packages/nette/mail)
54
[![Tests](https://github.com/nette/mail/workflows/Tests/badge.svg?branch=master)](https://github.com/nette/mail/actions)
65
[![Coverage Status](https://coveralls.io/repos/github/nette/mail/badge.svg?branch=master)](https://coveralls.io/github/nette/mail?branch=master)
76
[![Latest Stable Version](https://poser.pugx.org/nette/mail/v/stable)](https://github.com/nette/mail/releases)
87
[![License](https://img.shields.io/badge/license-New%20BSD-blue.svg)](https://github.com/nette/mail/blob/master/license.md)
98

9+
 <!---->
10+
1011

1112
Introduction
1213
------------
1314

1415
Are you going to send emails such as newsletters or order confirmations? Nette Framework provides the necessary tools with a very nice API.
1516

16-
Documentation can be found on the [website](https://doc.nette.org/mailing).
17+
Documentation can be found on the [website](https://doc.nette.org/en/mail).
18+
19+
 <!---->
1720

1821

1922
[Support Me](https://github.com/sponsors/dg)
@@ -25,6 +28,8 @@ Do you like Nette Mail? Are you looking forward to the new features?
2528

2629
Thank you!
2730

31+
 <!---->
32+
2833

2934
Installation
3035
------------
@@ -35,6 +40,8 @@ composer require nette/mail
3540

3641
It requires PHP version 8.0 and supports PHP up to 8.3.
3742

43+
 <!---->
44+
3845

3946
Creating Emails
4047
===============
@@ -74,7 +81,7 @@ Images can also be extremely easily inserted into the HTML body of an email. Jus
7481
// automatically adds /path/to/images/background.gif to the email
7582
$mail->setHtmlBody(
7683
'<b>Hello</b> <img src="background.gif">',
77-
'/path/to/images'
84+
'/path/to/images',
7885
);
7986
```
8087

@@ -118,14 +125,14 @@ $mail = new Nette\Mail\Message;
118125
$mail->setFrom('John <john@example.com>')
119126
->addTo('[email protected]')
120127
->setHtmlBody(
121-
$latte->renderToString('email.latte', $params),
122-
'/path/to/images'
128+
$latte->renderToString('/path/to/email.latte', $params),
129+
'/path/to/images',
123130
);
124131
```
125132

126133
File `email.latte`:
127134

128-
```html
135+
```latte
129136
<html>
130137
<head>
131138
<meta charset="utf-8">
@@ -146,6 +153,7 @@ File `email.latte`:
146153

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

156+
 <!---->
149157

150158

151159
Sending Emails
@@ -174,22 +182,22 @@ SmtpMailer
174182
To send mail via the SMTP server, use `SmtpMailer`.
175183

176184
```php
177-
$mailer = new Nette\Mail\SmtpMailer([
178-
'host' => 'smtp.gmail.com',
179-
'username' => '[email protected]',
180-
'password' => '*****',
181-
'secure' => 'ssl',
182-
]);
185+
$mailer = new Nette\Mail\SmtpMailer(
186+
host: 'smtp.gmail.com',
187+
username: '[email protected]',
188+
password: '*****',
189+
encryption: Nette\Mail\SmtpMailer::EncryptionSSL,
190+
);
183191
$mailer->send($mail);
184192
```
185193

186-
If you do not specify `host`, the value from php.ini will be used. The following additional keys can be used in the options:
194+
The following additional parameters can be passed to the constructor:
187195

188196
* `port` - if not set, the default 25 or 465 for `ssl` will be used
189-
* `context` - allows you to set [SSL context options](https://www.php.net/manual/en/context.ssl.php) for connection
190197
* `timeout` - timeout for SMTP connection
191198
* `persistent` - use persistent connection
192199
* `clientHost` - client designation
200+
* `streamOptions` - allows you to set [SSL context options](https://www.php.net/manual/en/context.ssl.php) for connection
193201

194202

195203
FallbackMailer
@@ -201,13 +209,15 @@ It does not send email but sends them through a set of mailers. If one mailer fa
201209
$mailer = new Nette\Mail\FallbackMailer([
202210
$smtpMailer,
203211
$backupSmtpMailer,
204-
$sendmailMailer
212+
$sendmailMailer,
205213
]);
206214
$mailer->send($mail);
207215
```
208216

209-
Other parameters in the constructor include the number of repeat and waiting time in miliseconds.
217+
Other parameters in the constructor include the number of repeat and waiting time in milliseconds.
218+
210219

220+
 <!---->
211221

212222
DKIM
213223
====
@@ -216,14 +226,14 @@ DKIM (DomainKeys Identified Mail) is a trustworthy email technology that also he
216226
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.
217227

218228
```php
219-
$options = [
220-
'domain' => 'nette.org',
221-
'selector' => 'dkim',
222-
'privateKey' => file_get_contents('../dkim/dkim.key'),
223-
'passPhrase' => '****',
224-
];
229+
$signer = new Nette\Mail\DkimSigner(
230+
domain: 'nette.org',
231+
selector: 'dkim',
232+
privateKey: file_get_contents('../dkim/dkim.key'),
233+
passPhrase: '****',
234+
);
225235

226236
$mailer = new Nette\Mail\SendmailMailer; // or SmtpMailer
227-
$mailer->setSigner(new Nette\Mail\DkimSigner($options));
237+
$mailer->setSigner($signer);
228238
$mailer->send($mail);
229239
```

0 commit comments

Comments
 (0)