Django

Code

Changeset 2761

Show
Ignore:
Timestamp:
04/27/06 23:19:50 (2 years ago)
Author:
adrian
Message:

magic-removal: Proofread docs/email.txt

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • django/branches/magic-removal/docs/email.txt

    r2744 r2761  
    2121        ['to@example.com'], fail_silently=False) 
    2222 
    23 The send_mail function 
    24 ====================== 
     23send_mail() 
     24=========== 
    2525 
    2626The simplest way to send e-mail is using the function 
    27 ``django.core.mail.send_mail``. Here's its definition:: 
     27``django.core.mail.send_mail()``. Here's its definition:: 
    2828 
    2929    send_mail(subject, message, from_email, recipient_list, 
     
    5252.. _smtplib docs: http://www.python.org/doc/current/lib/module-smtplib.html 
    5353 
    54 The send_mass_mail function 
    55 =========================== 
     54send_mass_mail() 
     55================ 
    5656 
    57 ``django.core.mail.send_mass_mail`` is intended to handle mass e-mailing. 
     57``django.core.mail.send_mass_mail()`` is intended to handle mass e-mailing. 
    5858Here's the definition:: 
    5959 
     
    7272the other addresses in the e-mail messages's "To:" field. 
    7373 
    74 send_mass_mail vs. send_mail 
    75 ---------------------------- 
     74send_mass_mail() vs. send_mail() 
     75-------------------------------- 
    7676 
    7777The main difference between ``send_mass_mail()`` and ``send_mail()`` is that 
     
    8080This makes ``send_mass_mail()`` slightly more efficient. 
    8181 
    82 The mail_admins function 
    83 ======================== 
     82mail_admins() 
     83============= 
    8484 
    85 ``django.core.mail.mail_admins`` is a shortcut for sending an e-mail to the 
     85``django.core.mail.mail_admins()`` is a shortcut for sending an e-mail to the 
    8686site admins, as defined in the `ADMINS setting`_. Here's the definition:: 
    8787 
     
    9393The "From:" header of the e-mail will be the value of the `SERVER_EMAIL setting`_. 
    9494 
     95This method exists for convenience and readability. 
     96 
    9597.. _ADMINS setting: http://www.djangoproject.com/documentation/settings/#admins 
    9698.. _EMAIL_SUBJECT_PREFIX setting: http://www.djangoproject.com/documentation/settings/#email-subject-prefix 
    9799.. _SERVER_EMAIL setting: http://www.djangoproject.com/documentation/settings/#server-email 
    98100 
    99 The mail_managers function 
    100 ========================== 
     101mail_managers() function 
     102======================== 
    101103 
    102 ``django.core.mail.mail_managers`` is just like ``mail_admins``, except it 
     104``django.core.mail.mail_managers()`` is just like ``mail_admins()``, except it 
    103105sends an e-mail to the site managers, as defined in the `MANAGERS setting`_. 
    104106Here's the definition::