summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMalcolm Tredinnick <malcolm.tredinnick@gmail.com>2008-10-05 06:41:15 +0000
committerMalcolm Tredinnick <malcolm.tredinnick@gmail.com>2008-10-05 06:41:15 +0000
commitee9c6ae269e858ddfa318fdb49b0c7ca31676cb8 (patch)
treeb79d2fbc4f1edcfa2276812744a11f96cdb304ef /docs
parent2993ef3d7eb8e81d9682ee6948bdcd9ba058bc41 (diff)
[1.0.X] Fixed a typo and clarified how django.core.mail.outbox works in the testing framework. Fixed #9237.
Backport of r9140 from trunk. git-svn-id: http://code.djangoproject.com/svn/django/branches/releases/1.0.X@9142 bcc190cf-cafb-0310-a4f2-bffc1f526a37
Diffstat (limited to 'docs')
-rw-r--r--docs/topics/testing.txt7
1 files changed, 6 insertions, 1 deletions
diff --git a/docs/topics/testing.txt b/docs/topics/testing.txt
index 0916f52388..4f37b3bdc0 100644
--- a/docs/topics/testing.txt
+++ b/docs/topics/testing.txt
@@ -950,7 +950,7 @@ Django, such as your machine's mail server, if you're running one.)
.. currentmodule:: django.core.mail
-.. data:: django.core.mail.output
+.. data:: django.core.mail.outbox
During test running, each outgoing e-mail is saved in
``django.core.mail.outbox``. This is a simple list of all
@@ -961,6 +961,11 @@ dummy :class:`<~django.core.mail.SMTPConnection>`. When the test framework is
torn down, the standard :class:`<~django.core.mail.SMTPConnection>` class is
restored, and the test outbox is destroyed.
+The ``outbox`` attribute is a special attribute that is created *only* when
+the tests are run. It doesn't normally exist as part of the
+:mod:`django.core.mail` module and you can't import it directly. The code
+below shows how to access this attribute correctly.
+
Here's an example test that examines ``django.core.mail.outbox`` for length
and contents::