Skip to content

Update README with example params submission #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
josh-works wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README with example params submission #27

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,38 @@ Action:
forward("http://example.com/email_processor")
```

#### Notes on testing

If you want to test the functionality of the route, via `rspec` or `minitest` or in Postman, please note that the `to`, `from`, `bcc` and `cc` params you post _must_ be capitalized:

This would _not_ work:

```json
{
"recipient": "recipient@domain.com",
"from": "this wont work <whywontyouwork@working.foo>",
"to": "to@domain.com",
"subject": "griddler-mailgun",
"body-plain": "This is some text body",
"body-html": "Supports <em>HTML</em> as well."
}
```

On the other hand, this would:

```json
{
"recipient": "recipient@domain.com",
"From": "this wont work <whywontyouwork@working.foo>",
"To": "to@domain.com",
"subject": "griddler-mailgun",
"body-plain": "This is some text body",
"body-html": "Supports <em>HTML</em> as well."
}
```
You can explore the expected fields and capitalizations in the [`Griddler::Mailgun::Adapter#normalize_params`](https://github.com/bradpauly/griddler-mailgun/blob/master/lib/griddler/mailgun/adapter.rb#L15) method.


## More Information

* [mailgun](http://www.mailgun.com)
Expand Down