Skip to content

Commit

Permalink
Documentation tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
JamesDPC committed Nov 16, 2021
1 parent aa0c4f8 commit 5ec9ecf
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 5 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ and...
* A Mailgun account
* At least one non-sandbox Mailgun mailing domain ([verified is best](http://mailgun-documentation.readthedocs.io/en/latest/quickstart-sending.html#verify-your-domain)) in your choice of region
* A Mailgun API key or a [Mailgun Domain Sending Key](https://www.mailgun.com/blog/mailgun-ip-pools-domain-keys) for the relevant mailing domain (the latter is recommended)
* MailgunEmail and MailgunMailer configured in your project (see below)
* MailgunEmail and MailgunMailer are configured in your project (see below)

## Installing

Expand Down Expand Up @@ -228,11 +228,11 @@ See [dmarc.org](https://dmarc.org) for more information on the importance of DMA

## Tests

See ./tests
See [./tests](./tests)

When testing this module, you probably want to avoid emails going out to the internet.
When acceptance testing this module, you probably want to avoid emails going out to the Internet.

Ensure you use a Mailgun sandbox domain with approved recipients to avoid this.
Ensure you use a Mailgun sandbox domain with approved recipients to avoid this and/or switch the `api_testmode` configuration value to `true`

## Breaking changes in 1.0 release

Expand Down
2 changes: 1 addition & 1 deletion docs/en/001-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ To set tags on a message, include them in the `$parameters['options']['tag']` ar

## Future delivery

To send in the future, use [scheduled delivery](https://documentation.mailgun.com/en/latest/user_manual.html#scheduling-delivery)
To send in the future, use [scheduled delivery](https://documentation.mailgun.com/en/latest/user_manual.html#scheduling-delivery) with an RFC2822 formatted datetime.

```php
//send in the future example
Expand Down
13 changes: 13 additions & 0 deletions docs/en/005-detailed_configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

More detailed configuration information is as follows

```yml
NSWDPC\Messaging\Mailgun\Connector\Base:
api_domain: ''
...
```

### api_domain

This is your custom mailing domain. It's recommended that your verify this in DNS
Expand Down Expand Up @@ -44,6 +50,13 @@ Mailgun requires a 'to' parameter. If your system sends messages with Bcc/Cc but

### always_from

> This setting will be replaced with `Email.send_all_emails_from` in the future. You can use that instead, now.
```yml
NSWDPC\Messaging\Mailgun\MailgunMailer:
always_from: ''
```
If you wish to have all emails sent from a single address by default, regardless of the From header set then add the relevant value here.
This is off by default but can come in handy if your application is sending emails from random addresses, which will cause you to fall foul of DMARC rules.
Expand Down

0 comments on commit 5ec9ecf

Please sign in to comment.