mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-07-05 10:19:20 +00:00
Code Issues 32 Releases Wiki Activity

magic-removal: Proofread docs/email.txt

Browse Source 
git-svn-id: http://code.djangoproject.com/svn/django/branches/magic-removal@2761 bcc190cf-cafb-0310-a4f2-bffc1f526a37
This commit is contained in:
Adrian Holovaty 2006-04-28 04:19:50 +00:00
parent 5cc2464e77
commit c73d0dc46b
1 changed files with 16 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/email.txt
View File

@ -20,11 +20,11 @@ In two lines::
send_mail('Subject here', 'Here is the message.', 'from@example.com', send_mail('Subject here', 'Here is the message.', 'from@example.com',
['to@example.com'], fail_silently=False) ['to@example.com'], fail_silently=False)
The send_mail function send_mail()
====================== ===========
The simplest way to send e-mail is using the function The simplest way to send e-mail is using the function
``django.core.mail.send_mail``. Here's its definition:: ``django.core.mail.send_mail()``. Here's its definition::
send_mail(subject, message, from_email, recipient_list, send_mail(subject, message, from_email, recipient_list,
fail_silently=False, auth_user=EMAIL_HOST_USER, fail_silently=False, auth_user=EMAIL_HOST_USER,
@ -51,10 +51,10 @@ are required.
.. _smtplib docs: http://www.python.org/doc/current/lib/module-smtplib.html .. _smtplib docs: http://www.python.org/doc/current/lib/module-smtplib.html
The send_mass_mail function send_mass_mail()
=========================== ================
``django.core.mail.send_mass_mail`` is intended to handle mass e-mailing. ``django.core.mail.send_mass_mail()`` is intended to handle mass e-mailing.
Here's the definition:: Here's the definition::
send_mass_mail(datatuple, fail_silently=False, send_mass_mail(datatuple, fail_silently=False,
@ -71,18 +71,18 @@ Each separate element of ``datatuple`` results in a separate e-mail message.
As in ``send_mail()``, recipients in the same ``recipient_list`` will all see As in ``send_mail()``, recipients in the same ``recipient_list`` will all see
the other addresses in the e-mail messages's "To:" field. the other addresses in the e-mail messages's "To:" field.
send_mass_mail vs. send_mail send_mass_mail() vs. send_mail()
---------------------------- --------------------------------
The main difference between ``send_mass_mail()`` and ``send_mail()`` is that 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, ``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. while ``send_mass_mail()`` uses a single connection for all of its messages.
This makes ``send_mass_mail()`` slightly more efficient. This makes ``send_mass_mail()`` slightly more efficient.
The mail_admins function mail_admins()
======================== =============
``django.core.mail.mail_admins`` is a shortcut for sending an e-mail to the ``django.core.mail.mail_admins()`` is a shortcut for sending an e-mail to the
site admins, as defined in the `ADMINS setting`_. Here's the definition:: site admins, as defined in the `ADMINS setting`_. Here's the definition::
mail_admins(subject, message, fail_silently=False) mail_admins(subject, message, fail_silently=False)
@ -92,14 +92,16 @@ site admins, as defined in the `ADMINS setting`_. Here's the definition::
The "From:" header of the e-mail will be the value of the `SERVER_EMAIL setting`_. The "From:" header of the e-mail will be the value of the `SERVER_EMAIL setting`_.
This method exists for convenience and readability.
.. _ADMINS setting: http://www.djangoproject.com/documentation/settings/#admins .. _ADMINS setting: http://www.djangoproject.com/documentation/settings/#admins
.. _EMAIL_SUBJECT_PREFIX setting: http://www.djangoproject.com/documentation/settings/#email-subject-prefix .. _EMAIL_SUBJECT_PREFIX setting: http://www.djangoproject.com/documentation/settings/#email-subject-prefix
.. _SERVER_EMAIL setting: http://www.djangoproject.com/documentation/settings/#server-email .. _SERVER_EMAIL setting: http://www.djangoproject.com/documentation/settings/#server-email
The mail_managers function mail_managers() function
========================== ========================
``django.core.mail.mail_managers`` is just like ``mail_admins``, except it ``django.core.mail.mail_managers()`` is just like ``mail_admins()``, except it
sends an e-mail to the site managers, as defined in the `MANAGERS setting`_. sends an e-mail to the site managers, as defined in the `MANAGERS setting`_.
Here's the definition:: Here's the definition::