More docs! w/ some emphasis on "reports" section

This commit is contained in:
Lance Edgar 2021-01-15 15:16:23 -06:00
parent 2072e41e19
commit da9823324d
38 changed files with 358 additions and 71 deletions

View file

@ -0,0 +1,6 @@
========================
Handling Email Bounces
========================
TODO

5
docs/base/email/code.rst Normal file
View file

@ -0,0 +1,5 @@
Programmatically Sending Email
------------------------------
TODO

View file

@ -0,0 +1,16 @@
Rattail Configuration
=====================
TODO
Configuring SMTP
----------------
TODO
Configuring Recipients etc.
---------------------------
TODO

8
docs/base/email/dev.rst Normal file
View file

@ -0,0 +1,8 @@
----------------------------
Development Considerations
----------------------------
TODO
* aka. how not to send unwanted/test emails to staff or public!

View file

@ -0,0 +1,6 @@
===============
Email Handler
===============
TODO

18
docs/base/email/index.rst Normal file
View file

@ -0,0 +1,18 @@
Sending Email
=============
.. toctree::
:maxdepth: 2
:caption: Contents:
overview
postfix
system
logging
config
templates
code
handler
dev
bounces

View file

@ -0,0 +1,6 @@
================
Logging to Email
================
TODO

View file

@ -0,0 +1,24 @@
==========
Overview
==========
This manual is primarily concerned with 3 "types" of email:
* emails sent by the underlying system
* emails sent via Python logging mechanism
* emails sent explicitly by a Poser/Rattail app
The first, "emails sent by the underlying system" refers primarily to emails
sent by the ``cron`` daemon. See :doc:`system` for more about those.
The second, "emails sent via Python logging mechanism" is covered in
:doc:`logging`.
The third, "emails sent explicitly by a Poser/Rattail app" is the primary
motivation behind this section of the manual. In particular see the sections
about :doc:`config`, :doc:`templates` and :doc:`code`.
Finally, if you're sending email to the public, it may be helpful to detect
bounces and e.g. flag an address as invalid if it triggers a bounce. See
:doc:`bounces` for more on that.

View file

@ -0,0 +1,5 @@
Postfix Setup
=============
TODO

View file

@ -0,0 +1,5 @@
System Emails
=============
TODO

View file

@ -0,0 +1,6 @@
=======================
Customizing Templates
=======================
TODO