Skip to content

Commit

Permalink
Merge pull request #29 from Miksus/docs/add_flask_redmail
Browse files Browse the repository at this point in the history
DOCS: add flask-redmail
  • Loading branch information
Miksus authored Jan 31, 2022
2 parents 693ca59 + 2b21b37 commit ed51f87
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 3 deletions.
15 changes: 15 additions & 0 deletions docs/extensions/flask.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
.. _ext-flask:

Flask Extension
===============

For Flask web applications, you may use the Flask extension:
**Flask-Redmail**. Even though it is trivial to use Red Mail
in such applications, Flask-Redmail integrates with Flask's
configurations to make it slightly easier to manage.

Read more:

- `flask-redmail's documentation <https://flask-redmail.readthedocs.io/>`_
- `flask-redmail's source code <https://github.com/Miksus/flask-redmail>`_
- `flask-redmail's releases from PyPI <https://pypi.org/project/Flask-Redmail/>`_
5 changes: 3 additions & 2 deletions docs/extensions/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@ Extensions

This section covers Red Mail's extensions. Extensions are
tools that helps to integrate the email sender to other
tasks such as logging.
purposes such as logging or web applications.

.. toctree::
:maxdepth: 1
:caption: Contents:

logging.rst
logging.rst
flask.rst
2 changes: 1 addition & 1 deletion docs/extensions/logging.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@

.. _ext-logging:

Email Logging
=============
Expand Down
2 changes: 2 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,8 @@ There are also other reasons to use Red Mail:
- :ref:`Gmail <config-gmail>` and :ref:`Outlook <config-outlook>` pre-configured
- :ref:`Send with cc and bcc <send-cc-bcc>`
- :ref:`Change the email protocol to what you need <config-smtp>`
- :ref:`Easy to use logging handler <ext-logging>`
- :ref:`Easy to use Flask extension <ext-flask>`
- And it is well tested and documented


Expand Down

0 comments on commit ed51f87

Please sign in to comment.