Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Fixed #14783 - Links + style improvements to docs/topics/email.txt. T…

…hanks adamv for the patch.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@14723 bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
commit 750325505efc7f522bb303001995f9d4dc6d64d4 1 parent 0be14b0
Tim Graham authored November 27, 2010

Showing 1 changed file with 15 additions and 16 deletions. Show diff stats Hide diff stats

  1. 31  docs/topics/email.txt
31  docs/topics/email.txt
@@ -39,10 +39,10 @@ set, are used to authenticate to the SMTP server, and the
39 39
 send_mail()
40 40
 ===========
41 41
 
42  
-The simplest way to send e-mail is using the function
43  
-``django.core.mail.send_mail()``. Here's its definition:
  42
+.. function:: send_mail(subject, message, from_email, recipient_list, fail_silently=False, auth_user=None, auth_password=None, connection=None)
44 43
 
45  
-    .. function:: send_mail(subject, message, from_email, recipient_list, fail_silently=False, auth_user=None, auth_password=None, connection=None)
  44
+The simplest way to send e-mail is using
  45
+``django.core.mail.send_mail()``.
46 46
 
47 47
 The ``subject``, ``message``, ``from_email`` and ``recipient_list`` parameters
48 48
 are required.
@@ -58,10 +58,10 @@ are required.
58 58
       possible exceptions, all of which are subclasses of ``SMTPException``.
59 59
     * ``auth_user``: The optional username to use to authenticate to the SMTP
60 60
       server. If this isn't provided, Django will use the value of the
61  
-      ``EMAIL_HOST_USER`` setting.
  61
+      :setting:`EMAIL_HOST_USER` setting.
62 62
     * ``auth_password``: The optional password to use to authenticate to the
63 63
       SMTP server. If this isn't provided, Django will use the value of the
64  
-      ``EMAIL_HOST_PASSWORD`` setting.
  64
+      :setting:`EMAIL_HOST_PASSWORD` setting.
65 65
     * ``connection``: The optional e-mail backend to use to send the mail.
66 66
       If unspecified, an instance of the default backend will be used.
67 67
       See the documentation on :ref:`E-mail backends <topic-email-backends>`
@@ -72,10 +72,9 @@ are required.
72 72
 send_mass_mail()
73 73
 ================
74 74
 
75  
-``django.core.mail.send_mass_mail()`` is intended to handle mass e-mailing.
76  
-Here's the definition:
  75
+.. function:: send_mass_mail(datatuple, fail_silently=False, auth_user=None, auth_password=None, connection=None)
77 76
 
78  
-    .. function:: send_mass_mail(datatuple, fail_silently=False, auth_user=None, auth_password=None, connection=None)
  77
+``django.core.mail.send_mass_mail()`` is intended to handle mass e-mailing.
79 78
 
80 79
 ``datatuple`` is a tuple in which each element is in this format::
81 80
 
@@ -110,10 +109,10 @@ a single connection for all of its messages. This makes
110 109
 mail_admins()
111 110
 =============
112 111
 
113  
-``django.core.mail.mail_admins()`` is a shortcut for sending an e-mail to the
114  
-site admins, as defined in the :setting:`ADMINS` setting. Here's the definition:
  112
+.. function:: mail_admins(subject, message, fail_silently=False, connection=None)
115 113
 
116  
-    .. function:: mail_admins(subject, message, fail_silently=False, connection=None)
  114
+``django.core.mail.mail_admins()`` is a shortcut for sending an e-mail to the
  115
+site admins, as defined in the :setting:`ADMINS` setting.
117 116
 
118 117
 ``mail_admins()`` prefixes the subject with the value of the
119 118
 :setting:`EMAIL_SUBJECT_PREFIX` setting, which is ``"[Django] "`` by default.
@@ -123,14 +122,14 @@ The "From:" header of the e-mail will be the value of the
123 122
 
124 123
 This method exists for convenience and readability.
125 124
 
126  
-mail_managers() function
127  
-========================
  125
+mail_managers()
  126
+===============
  127
+
  128
+.. function:: mail_managers(subject, message, fail_silently=False, connection=None)
128 129
 
129 130
 ``django.core.mail.mail_managers()`` is just like ``mail_admins()``, except it
130 131
 sends an e-mail to the site managers, as defined in the :setting:`MANAGERS`
131  
-setting. Here's the definition:
132  
-
133  
-    .. function:: mail_managers(subject, message, fail_silently=False, connection=None)
  132
+setting.
134 133
 
135 134
 Examples
136 135
 ========

0 notes on commit 7503255

Please sign in to comment.
Something went wrong with that request. Please try again.