summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBarry Warsaw2010-01-12 08:27:38 -0500
committerBarry Warsaw2010-01-12 08:27:38 -0500
commit41faffef13f11c793c140d7f18d3b0698685b7a2 (patch)
treebce0b307279a9682afeb57e50d16aa646440e22e
parentf137d934b0d5b9e37bd24989e7fb613540ca675d (diff)
downloadmailman-41faffef13f11c793c140d7f18d3b0698685b7a2.tar.gz
mailman-41faffef13f11c793c140d7f18d3b0698685b7a2.tar.zst
mailman-41faffef13f11c793c140d7f18d3b0698685b7a2.zip
-rw-r--r--src/mailman/app/docs/__init__.py0
-rw-r--r--src/mailman/app/docs/bounces.txt (renamed from src/mailman/docs/bounces.txt)26
-rw-r--r--src/mailman/app/docs/chains.txt (renamed from src/mailman/docs/chains.txt)0
-rw-r--r--src/mailman/app/docs/hooks.txt (renamed from src/mailman/docs/hooks.txt)0
-rw-r--r--src/mailman/app/docs/lifecycle.txt (renamed from src/mailman/docs/lifecycle.txt)0
-rw-r--r--src/mailman/app/docs/message.txt (renamed from src/mailman/docs/message.txt)0
-rw-r--r--src/mailman/app/docs/pipelines.txt (renamed from src/mailman/docs/pipelines.txt)0
-rw-r--r--src/mailman/app/docs/styles.txt (renamed from src/mailman/docs/styles.txt)0
-rw-r--r--src/mailman/app/docs/system.txt (renamed from src/mailman/docs/system.txt)1
-rw-r--r--src/mailman/docs/README.txt4
-rw-r--r--src/mailman/docs/START.txt (renamed from src/mailman/docs/ALPHA.txt)0
-rw-r--r--src/mailman/model/docs/__init__.py0
-rw-r--r--src/mailman/model/docs/addresses.txt (renamed from src/mailman/docs/addresses.txt)0
-rw-r--r--src/mailman/model/docs/autorespond.txt (renamed from src/mailman/docs/autorespond.txt)3
-rw-r--r--src/mailman/model/docs/domains.txt (renamed from src/mailman/docs/domains.txt)0
-rw-r--r--src/mailman/model/docs/languages.txt (renamed from src/mailman/docs/languages.txt)0
-rw-r--r--src/mailman/model/docs/listmanager.txt (renamed from src/mailman/docs/listmanager.txt)0
-rw-r--r--src/mailman/model/docs/membership.txt (renamed from src/mailman/docs/membership.txt)0
-rw-r--r--src/mailman/model/docs/messagestore.txt (renamed from src/mailman/docs/messagestore.txt)0
-rw-r--r--src/mailman/model/docs/mlist-addresses.txt (renamed from src/mailman/docs/mlist-addresses.txt)0
-rw-r--r--src/mailman/model/docs/pending.txt (renamed from src/mailman/docs/pending.txt)1
-rw-r--r--src/mailman/model/docs/registration.txt (renamed from src/mailman/docs/registration.txt)0
-rw-r--r--src/mailman/model/docs/requests.txt (renamed from src/mailman/docs/requests.txt)19
-rw-r--r--src/mailman/model/docs/usermanager.txt (renamed from src/mailman/docs/usermanager.txt)0
-rw-r--r--src/mailman/model/docs/users.txt (renamed from src/mailman/docs/users.txt)0
25 files changed, 26 insertions, 28 deletions
diff --git a/src/mailman/app/docs/__init__.py b/src/mailman/app/docs/__init__.py
new file mode 100644
index 000000000..e69de29bb
--- /dev/null
+++ b/src/mailman/app/docs/__init__.py
diff --git a/src/mailman/docs/bounces.txt b/src/mailman/app/docs/bounces.txt
index 736eda19d..a12305154 100644
--- a/src/mailman/docs/bounces.txt
+++ b/src/mailman/app/docs/bounces.txt
@@ -1,3 +1,4 @@
+=======
Bounces
=======
@@ -7,16 +8,13 @@ XXX Many more converted tests go here.
Bounces, or message rejection
------------------------------
+=============================
Mailman can also bounce messages back to the original sender. This is
essentially equivalent to rejecting the message with notification. Mailing
lists can bounce a message with an optional error message.
- >>> from mailman.interfaces.listmanager import IListManager
- >>> from zope.component import getUtility
- >>> mlist = getUtility(IListManager).create('_xtest@example.com')
- >>> mlist.preferred_language = 'en'
+ >>> mlist = create_list('_xtest@example.com')
Any message can be bounced.
@@ -32,15 +30,13 @@ Bounce a message by passing in the original message, and an optional error
message. The bounced message ends up in the virgin queue, awaiting sending
to the original messageauthor.
- >>> switchboard = config.switchboards['virgin']
>>> from mailman.app.bounces import bounce_message
>>> bounce_message(mlist, msg)
- >>> len(switchboard.files)
+ >>> from mailman.testing.helpers import get_queue_messages
+ >>> items = get_queue_messages('virgin')
+ >>> len(items)
1
- >>> filebase = switchboard.files[0]
- >>> qmsg, qmsgdata = switchboard.dequeue(filebase)
- >>> switchboard.finish(filebase)
- >>> print qmsg.as_string()
+ >>> print items[0].msg.as_string()
Subject: Something important
From: _xtest-owner@example.com
To: aperson@example.com
@@ -75,12 +71,10 @@ passed in as an instance of a RejectMessage exception.
>>> from mailman.core.errors import RejectMessage
>>> error = RejectMessage("This wasn't very important after all.")
>>> bounce_message(mlist, msg, error)
- >>> len(switchboard.files)
+ >>> items = get_queue_messages('virgin')
+ >>> len(items)
1
- >>> filebase = switchboard.files[0]
- >>> qmsg, qmsgdata = switchboard.dequeue(filebase)
- >>> switchboard.finish(filebase)
- >>> print qmsg.as_string()
+ >>> print items[0].msg.as_string()
Subject: Something important
From: _xtest-owner@example.com
To: aperson@example.com
diff --git a/src/mailman/docs/chains.txt b/src/mailman/app/docs/chains.txt
index f9ed156b1..f9ed156b1 100644
--- a/src/mailman/docs/chains.txt
+++ b/src/mailman/app/docs/chains.txt
diff --git a/src/mailman/docs/hooks.txt b/src/mailman/app/docs/hooks.txt
index 14dc76667..14dc76667 100644
--- a/src/mailman/docs/hooks.txt
+++ b/src/mailman/app/docs/hooks.txt
diff --git a/src/mailman/docs/lifecycle.txt b/src/mailman/app/docs/lifecycle.txt
index a1cd50825..a1cd50825 100644
--- a/src/mailman/docs/lifecycle.txt
+++ b/src/mailman/app/docs/lifecycle.txt
diff --git a/src/mailman/docs/message.txt b/src/mailman/app/docs/message.txt
index 41607ff44..41607ff44 100644
--- a/src/mailman/docs/message.txt
+++ b/src/mailman/app/docs/message.txt
diff --git a/src/mailman/docs/pipelines.txt b/src/mailman/app/docs/pipelines.txt
index cf848f1d9..cf848f1d9 100644
--- a/src/mailman/docs/pipelines.txt
+++ b/src/mailman/app/docs/pipelines.txt
diff --git a/src/mailman/docs/styles.txt b/src/mailman/app/docs/styles.txt
index 10312cd3a..10312cd3a 100644
--- a/src/mailman/docs/styles.txt
+++ b/src/mailman/app/docs/styles.txt
diff --git a/src/mailman/docs/system.txt b/src/mailman/app/docs/system.txt
index 3ed0ce28c..035833047 100644
--- a/src/mailman/docs/system.txt
+++ b/src/mailman/app/docs/system.txt
@@ -1,3 +1,4 @@
+===============
System versions
===============
diff --git a/src/mailman/docs/README.txt b/src/mailman/docs/README.txt
index eb7361bd9..d0bbf6092 100644
--- a/src/mailman/docs/README.txt
+++ b/src/mailman/docs/README.txt
@@ -12,6 +12,8 @@ includes GNU/Linux and most other Unix-like operating systems (e.g. Solaris,
mail clients on any platform should be able to interact with Mailman just
fine.
+Learn more about GNU Mailman in the `Getting Started`_ documentation.
+
Copyright
=========
@@ -76,8 +78,6 @@ lists and archives, etc., are available at:
http://www.list.org/help.html
-For more information about the alpha releases, see `ALPHA.txt`_.
-
Requirements
============
diff --git a/src/mailman/docs/ALPHA.txt b/src/mailman/docs/START.txt
index eb7b6aada..eb7b6aada 100644
--- a/src/mailman/docs/ALPHA.txt
+++ b/src/mailman/docs/START.txt
diff --git a/src/mailman/model/docs/__init__.py b/src/mailman/model/docs/__init__.py
new file mode 100644
index 000000000..e69de29bb
--- /dev/null
+++ b/src/mailman/model/docs/__init__.py
diff --git a/src/mailman/docs/addresses.txt b/src/mailman/model/docs/addresses.txt
index 5388a3cc8..5388a3cc8 100644
--- a/src/mailman/docs/addresses.txt
+++ b/src/mailman/model/docs/addresses.txt
diff --git a/src/mailman/docs/autorespond.txt b/src/mailman/model/docs/autorespond.txt
index 5d37927fa..ba0521a89 100644
--- a/src/mailman/docs/autorespond.txt
+++ b/src/mailman/model/docs/autorespond.txt
@@ -1,3 +1,4 @@
+===================
Automatic responder
===================
@@ -76,7 +77,7 @@ Now the day flips over and all the counts reset.
Response dates
---------------
+==============
You can also use the response set to get the date of the last response sent.
diff --git a/src/mailman/docs/domains.txt b/src/mailman/model/docs/domains.txt
index 5673e6ee9..5673e6ee9 100644
--- a/src/mailman/docs/domains.txt
+++ b/src/mailman/model/docs/domains.txt
diff --git a/src/mailman/docs/languages.txt b/src/mailman/model/docs/languages.txt
index a724a0510..a724a0510 100644
--- a/src/mailman/docs/languages.txt
+++ b/src/mailman/model/docs/languages.txt
diff --git a/src/mailman/docs/listmanager.txt b/src/mailman/model/docs/listmanager.txt
index e07659066..e07659066 100644
--- a/src/mailman/docs/listmanager.txt
+++ b/src/mailman/model/docs/listmanager.txt
diff --git a/src/mailman/docs/membership.txt b/src/mailman/model/docs/membership.txt
index 27d2d9552..27d2d9552 100644
--- a/src/mailman/docs/membership.txt
+++ b/src/mailman/model/docs/membership.txt
diff --git a/src/mailman/docs/messagestore.txt b/src/mailman/model/docs/messagestore.txt
index aabfd55fb..aabfd55fb 100644
--- a/src/mailman/docs/messagestore.txt
+++ b/src/mailman/model/docs/messagestore.txt
diff --git a/src/mailman/docs/mlist-addresses.txt b/src/mailman/model/docs/mlist-addresses.txt
index 3f44008fb..3f44008fb 100644
--- a/src/mailman/docs/mlist-addresses.txt
+++ b/src/mailman/model/docs/mlist-addresses.txt
diff --git a/src/mailman/docs/pending.txt b/src/mailman/model/docs/pending.txt
index bc6d3c470..dc27b6bee 100644
--- a/src/mailman/docs/pending.txt
+++ b/src/mailman/model/docs/pending.txt
@@ -1,3 +1,4 @@
+====================
The pending database
====================
diff --git a/src/mailman/docs/registration.txt b/src/mailman/model/docs/registration.txt
index abc7f2c93..abc7f2c93 100644
--- a/src/mailman/docs/registration.txt
+++ b/src/mailman/model/docs/registration.txt
diff --git a/src/mailman/docs/requests.txt b/src/mailman/model/docs/requests.txt
index 5dcfa922a..8cd027297 100644
--- a/src/mailman/docs/requests.txt
+++ b/src/mailman/model/docs/requests.txt
@@ -1,3 +1,4 @@
+==================
Moderator requests
==================
@@ -30,7 +31,7 @@ And another helper for displaying messages in the virgin queue.
Mailing list centric
---------------------
+====================
A set of requests are always related to a particular mailing list, so given a
mailing list you need to get its requests object.
@@ -48,7 +49,7 @@ mailing list you need to get its requests object.
Holding requests
-----------------
+================
The list's requests database starts out empty.
@@ -112,7 +113,7 @@ We can hold requests with additional data.
Getting requests
-----------------
+================
We can ask the requests database for a specific request, by providing the id
of the request data we want. This returns a 2-tuple of the key and data we
@@ -144,7 +145,7 @@ If we ask for a request that is not in the database, we get None back.
Iterating over requests
------------------------
+=======================
To make it easier to find specific requests, the list requests can be iterated
over by type.
@@ -166,7 +167,7 @@ over by type.
Deleting requests
------------------
+=================
Once a specific request has been handled, it will be deleted from the requests
database.
@@ -200,7 +201,7 @@ For the next section, we first clean up all the current requests.
Application support
--------------------
+===================
There are several higher level interfaces available in the mailman.app package
which can be used to hold messages, subscription, and unsubscriptions. There
@@ -211,7 +212,7 @@ and consistent way.
Holding messages
-----------------
+================
For this section, we need a mailing list and at least one message.
@@ -410,7 +411,7 @@ moderators.
Holding subscription requests
------------------------------
+=============================
For closed lists, subscription requests will also be held for moderator
approval. In this case, several pieces of information related to the
@@ -699,7 +700,7 @@ Frank Person is now a member of the mailing list.
Holding unsubscription requests
--------------------------------
+===============================
Some lists, though it is rare, require moderator approval for unsubscriptions.
In this case, only the unsubscribing address is required. Like subscriptions,
diff --git a/src/mailman/docs/usermanager.txt b/src/mailman/model/docs/usermanager.txt
index 856221952..856221952 100644
--- a/src/mailman/docs/usermanager.txt
+++ b/src/mailman/model/docs/usermanager.txt
diff --git a/src/mailman/docs/users.txt b/src/mailman/model/docs/users.txt
index bb0301772..bb0301772 100644
--- a/src/mailman/docs/users.txt
+++ b/src/mailman/model/docs/users.txt