Skip to content

Commit

Permalink
Leave instructions in main repo for sendgrid config (#3736)
Browse files Browse the repository at this point in the history
  • Loading branch information
milescalabresi authored Mar 22, 2024
1 parent 9501fab commit 8d76557
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/dev/email.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,9 @@ Incoming email
Incoming email is received by Exim via SMTP, and handled according to the settings in ``/etc/exim4``. For mail at chapter-site domains, this mail is passed to the site's ``esp/mailgates/mailgate.py``. This, in turn, consults the ``EmailList`` objects in the database (which on most sites are just the autocreated ones).

Each ``EmailList`` matches some regular expression of email addresses, and forwards the email to some list of users based on that. (For example, class email lists match ``<emailcode>-students@``, and send to the class's students, teachers, and the admin archive list.) Once we determine to whom to forward the email, we again use the standard Django facilities to send a copy to Exim, which passes it on to the world.


SendGrid Configuration
----------------------
Modern email providers require us to prove we are who we say we are by authenticating our domains (registered with Gandi and/or Amazon Web Services (AWS)) with our email provider(s), currently SendGrid. This process requires two steps: telling the email provider what domains we own and confirming that we own them by posting a unique record (that the email service gives us) to the domain registrar. See ``/lu/scripts/sendgrid_authentication.py`` to set everything up automatically with SendGrid and AWS.

0 comments on commit 8d76557

Please sign in to comment.