[Mailer] Add brifge documentation

symfony · Apr 10, 2023 · 5414052 · 5414052
1 parent 899d095
commit 5414052
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -3,6 +3,24 @@ Mailgun Mailer
 
 Provides Mailgun integration for Symfony Mailer.
 
+Configuration example:
+
+```env
+# SMTP
+MAILER_DSN=mailgun+smtp://USERNAME:PASSWORD@default?region=REGION
+
+# HTTP
+MAILER_DSN=mailgun+https://KEY:DOMAIN@default?region=REGION
+
+# API
+MAILER_DSN=mailgun+api://KEY:DOMAIN@default?region=REGION
+```
+
+where:
+ - `KEY` is your Mailgun API key
+ - `DOMAIN` is your Mailgun sending domain
+ - `REGION` is Mailgun selected region (optional)
+
 Resources
 ---------