Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobert Speicher <rspeicher@gmail.com>2017-09-12 18:41:55 +0300
committerRobert Speicher <rspeicher@gmail.com>2017-09-12 18:44:31 +0300
commitac51f44f752476caf205dbeff03e094c829ea8e5 (patch)
tree1d6e189a1a15b4bfd6b76982e4f3ec9eca67abf6 /doc/development/emails.md
parent0cd1563fb66e9ba533346fe3957912225e27000f (diff)
Add developer documentation about working with sent emails and previews
Diffstat (limited to 'doc/development/emails.md')
-rw-r--r--doc/development/emails.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/development/emails.md b/doc/development/emails.md
new file mode 100644
index 00000000000..18f47f44cb5
--- /dev/null
+++ b/doc/development/emails.md
@@ -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)