8000 minor #49991 [Mailer] Add bridge documentation (alamirault) · enumag/symfony@026286b · GitHub
[go: up one dir, main page]
Skip to content

Commit 026286b

Browse files
fabpotfabpot
committed
minor symfony#49991 [Mailer] Add bridge documentation (alamirault)
This PR was merged into the 5.4 branch. Discussion ---------- [Mailer] Add bridge documentation | Q | A | ------------- | --- | Branch? | 5.4 | New feature? | no <!-- please update src/**/CHANGELOG.md files --> | Deprecations? | no <!-- please update UPGRADE-*.md and src/**/CHANGELOG.md files --> | Tickets | [From a doc issue](symfony/symfony-docs#15793 (comment)) | License | MIT | Doc PR | symfony/symfony-docs#... <!-- required for new features --> Like work done [for notifiers documentation](symfony#49782). This PR document mailer bridges in their README (I harmonized examples) Commits ------- 7ac6fcf [Mailer] Add brifge documentation
2 parents 0ccb053 + 7ac6fcf commit 026286b

File tree

9 files changed

+109
-13
lines changed

9 files changed

+109
-13
lines changed

‎src/Symfony/Component/Mailer/Bridge/Amazon/README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,25 @@ Amazon Mailer
33

44
Provides Amazon SES integration for Symfony Mailer.
55

6+
Configuration example:
7+
8+
```env
9+
# SMTP
10+
MAILER_DSN=ses+smtp://USERNAME:PASSWORD@default?region=REGION&session_token=SESSION_TOKEN
11+
12+
# HTTP
13+
MAILER_DSN=ses+https://ACCESS_KEY:SECRET_KEY@default?region=REGION&session_token=SESSION_TOKEN
14+
15+
# API
16+
MAILER_DSN=ses+api://ACCESS_KEY:SECRET_KEY@default?region=REGION&session_token=SESSION_TOKEN
17+
```
18+
19+
where:
20+
- `ACCESS_KEY` is your Amazon SES access key id
21+
- `SECRET_KEY` is your Amazon SES access key secret
22+
- `REGION` is Amazon SES selected region (optional, default `eu-west-1`)
23+
- `SESSION_TOKEN` is your Amazon SES session token (optional)
24+
625
Resources
726
---------
827

‎src/Symfony/Component/Mailer/Bridge/Google/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,13 @@ Google Mailer
33

44
Provides Google Gmail integration for Symfony Mailer.
55

6+
Configuration example:
7+
8+
```env
9+
# SMTP
10+
MAILER_DSN=gmail+smtp://USERNAME:APP-PASSWORD@default
11+
```
12+
613
Resources
714
---------
815

‎src/Symfony/Component/Mailer/Bridge/Mailchimp/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,22 @@ Mailchimp Mailer
33

44
Provides Mandrill integration for Symfony Mailer.
55

6+
Configuration example:
7+
8+
```env
9+
# SMTP
10+
MAILER_DSN=mandrill+smtp://USERNAME:PASSWORD@default
11+
12+
# HTTP
13+
MAILER_DSN=mandrill+https://KEY@default
14+
15+
# API
16+
MAILER_DSN=mandrill+api://KEY@default
17+
```
18+
19+
where:
20+
- `KEY` is your Mailchimp API key
21+
622
Resources
723
---------
824

‎src/Symfony/Component/Mailer/Bridge/Mailgun/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,24 @@ Mailgun Mailer
33

44
Provides Mailgun integration for Symfony Mailer.
55

6+
Configuration example:
7+
8+
```env
9+
# SMTP
10+
MAILER_DSN=mailgun+smtp://USERNAME:PASSWORD@default?region=REGION
11+
12+
# HTTP
13+
MAILER_DSN=mailgun+https://KEY:DOMAIN@default?region=REGION
14+
15+
# API
16+
MAILER_DSN=mailgun+api://KEY:DOMAIN@default?region=REGION
17+
```
18+
19+
where:
20+
- `KEY` is your Mailgun API key
21+
- `DOMAIN` is your Mailgun sending domain
22+
- `REGION` is Mailgun selected region (optional)
23+
624
Resources
725
---------
826

‎src/Symfony/Component/Mailer/Bridge/Mailjet/README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,20 @@ Mailjet Bridge
33

44
Provides Mailjet integration for Symfony Mailer.
55

6-
Configuration examples:
6+
Configuration example:
77

8-
```dotenv
9-
# API
10-
MAILER_DSN=mailjet+api://$PUBLIC_KEY:$PRIVATE_KEY@default
8+
```env
119
# SMTP
12-
MAILER_DSN=mailjet+smtp://$PUBLIC_KEY:$PRIVATE_KEY@default
10+
MAILER_DSN=mailjet+smtp://ACCESS_KEY:SECRET_KEY@default
11+
12+
# API
13+
MAILER_DSN=mailjet+api://ACCESS_KEY:SECRET_KEY@default
1314
```
1415

16+
where:
17+
- `ACCESS_KEY` is your Mailjet access key
18+
- `SECRET_KEY` is your Mailjet secret key
19+
1520
Resources
1621
---------
1722

‎src/Symfony/Component/Mailer/Bridge/OhMySmtp/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,19 @@ OhMySMTP Bridge
33

44
Provides [OhMySMTP](https://ohmysmtp.com) integration for Symfony Mailer.
55

6+
Configuration example:
67

7-
DSN example
8-
-----------
8+
```env
9+
# SMTP
10+
MAILER_DSN=ohmysmtp+smtp://API_TOKEN@default
911
10-
```
12+
# API
1113
MAILER_DSN=ohmysmtp+api://API_TOKEN@default
1214
```
1315

1416
where:
1517
- `API_TOKEN` is your OhMySMTP API Token
1618

17-
1819
Resources
1920
---------
2021

‎src/Symfony/Component/Mailer/Bridge/Postmark/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,20 @@ Postmark Bridge
33

44
Provides Postmark integration for Symfony Mailer.
55

6+
Configuration example:
7+
8+
```env
9+
# SMTP
10+
MAILER_DSN=postmark+smtp://ID@default
11+
12+
# API
13+
MAILER_DSN=postmark+api://KEY@default
14+
```
15+
16+
where:
17+
- `ID` is your Postmark Server Token
18+
- `KEY` is your Postmark Server Token
19+
620
Resources
721
---------
822

‎src/Symfony/Component/Mailer/Bridge/Sendgrid/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,19 @@ Sendgrid Bridge
33

44
Provides Sendgrid integration for Symfony Mailer.
55

6+
Configuration example:
7+
8+
```env
9+
# SMTP
10+
MAILER_DSN=sendgrid+smtp://KEY@default
11+
12+
# API
13+
MAILER_DSN=sendgrid+api://KEY@default
14+
```
15+
16+
where:
17+
- `KEY` is your Sendgrid API Key
18+
619
Resources
720
---------
821

‎src/Symfony/Component/Mailer/Bridge/Sendinblue/README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,16 @@ Provides Sendinblue integration for Symfony Mailer.
66
Configuration example:
77

88
```env
9-
# API
10-
MAILER_DSN=sendinblue+api://$SENDINBLUE_API_KEY@default
11-
129
# SMTP
13-
MAILER_DSN=sendinblue+smtp://$SENDINBLUE_USERNAME:$SENDINBLUE_PASSWORD@default
10+
MAILER_DSN=sendinblue+smtp://USERNAME:PASSWORD@default
11+
12+
# API
13+
MAILER_DSN=sendinblue+api://KEY@default
1414
```
1515

16+
where:
17+
- `KEY` is your Sendinblue API Key
18+
1619
With API, you can use custom headers.
1720

1821
```php

0 commit comments

Comments
 (0)
0