Skip to content

Commit

Permalink
add docs about differences with Django
Browse files Browse the repository at this point in the history
  • Loading branch information
waynerv committed Feb 15, 2021
1 parent afc38bc commit ef8b368
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 3 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ are permitted provided that the following conditions are met:
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.

3. Neither the name of Django nor the names of its contributors may be used
3. Neither the name of Flask-Mailman nor the names of its contributors may be used
to endorse or promote products derived from this software without
specific prior written permission.

Expand Down
Binary file added docs/img/favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/img/icon-white.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 8 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The core part of this extension's source code comes directly from Django's mail module.

And following documentation is also a folk of Django's, but with a few differences.
And following documentation is also a folk of Django's, but with a few [differences](#differences-with-django).

## Installation

Expand Down Expand Up @@ -464,4 +464,10 @@ mail.send_mass_mail((message1, message2), fail_silently=False)

### send_mass_mail() vs. send_mail()

The main difference between `send_mass_mail()` and `send_mail()` is that `send_mail()` opens a connection to the mail server each time it’s executed, while `send_mass_mail()` uses a single connection for all of its messages. This makes `send_mass_mail()` slightly more efficient.
The main difference between `send_mass_mail()` and `send_mail()` is that `send_mail()` opens a connection to the mail server each time it’s executed, while `send_mass_mail()` uses a single connection for all of its messages. This makes `send_mass_mail()` slightly more efficient.

## Differences with Django

The name of configuration keys is different here, but you can easily resolve it.

`mail_admins()` and `mail_managers()` methods were removed, you can write an alternative one in a minute if you need.

0 comments on commit ef8b368

Please sign in to comment.