paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-03 21:43:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Simplify email testing notes section.

Browse Source 
No good reason for one note to be bold compared to
other notes.
This commit is contained in:
Vishnu KS
2020-10-30 17:42:58 +05:30
committed by Tim Abbott
parent 7a6285ede7
commit ebe92fe70a
1 changed files with 11 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/subsystems/email.md
View File

@@ -98,22 +98,24 @@ email_host_user = username@gmail.com
email_password = gmail_password
```
**Note: The base_image_uri of the images in forwarded emails would be replaced
with `https://chat.zulip.org/static/images/emails` inorder for the email clients
to render the images. See `zproject/email_backends.py` for more details.**
### Notes
While running the backend test suite, we use
* The base_image_uri of the images in forwarded emails would be replaced
with `https://chat.zulip.org/static/images/emails` inorder for the email clients
to render the images. See `zproject/email_backends.py` for more details.
* After changing any HTML email or `email_base.html`, you need to run
`scripts/setup/inline_email_css.py` for the changes to be reflected in the dev
environment. The script generates files like
`templates/zerver/emails/compiled/<template_prefix>.html`.
* While running the backend test suite, we use
`django.core.mail.backends.locmem.EmailBackend` as the email
backend. The `locmem` backend stores messages in a special attribute
of the django.core.mail module, "outbox". The outbox attribute is
created when the first message is sent. It’s a list with an
EmailMessage instance for each message that would be sent.
Other notes:
* After changing any HTML email or `email_base.html`, you need to run
`scripts/setup/inline_email_css.py` for the changes to be reflected in the dev
environment. The script generates files like
`templates/zerver/emails/compiled/<template_prefix>.html`.
## Email templates
Zulip's email templates live under `templates/zerver/emails`. Email