Add developer documentation about working with sent emails and previews

This commit is contained in:
Robert Speicher 2017-09-12 11:41:55 -04:00
parent 0cd1563fb6
commit ac51f44f75
2 changed files with 24 additions and 0 deletions

View File

@ -43,6 +43,7 @@
- [Object state models](object_state_models.md)
- [Building a package for testing purposes](build_test_package.md)
- [Manage feature flags](feature_flags.md)
- [View sent emails or preview mailers](emails.md)
## Databases

23
doc/development/emails.md Normal file
View File

@ -0,0 +1,23 @@
# Dealing with email in development
## Sent emails
To view rendered emails "sent" in your development instance, visit
[`/rails/letter_opener`](http://localhost:3000/rails/letter_opener).
## Mailer previews
Rails provides a way to preview our mailer templates in HTML and plaintext using
dummy data.
The previews live in [`spec/mailers/previews`][previews] and can be viewed at
[`/rails/mailers`](http://localhost:3000/rails/mailers).
See the [Rails guides] for more info.
[previews]: https://gitlab.com/gitlab-org/gitlab-ce/tree/master/spec/mailers/previews
[Rails guides]: http://guides.rubyonrails.org/action_mailer_basics.html#previewing-emails
---
[Return to Development documentation](README.md)