[prev in list] [next in list] [prev in thread] [next in thread]
List: mailman-cvs
Subject: [Mailman-checkins] SF.net SVN: mailman: [8211]
From: bwarsaw () users ! sourceforge ! net
Date: 2007-05-09 1:31:36
Message-ID: E1Hlb1k-00084Z-Gx () sc8-pr-svn1 ! sourceforge ! net
[Download RAW message or body]
Revision: 8211
http://svn.sourceforge.net/mailman/?rev=8211&view=rev
Author: bwarsaw
Date: 2007-05-08 18:31:36 -0700 (Tue, 08 May 2007)
Log Message:
-----------
a bit of renaming
Modified Paths:
--------------
branches/exp-elixir-branch/Mailman/docs/mlist-addresses.txt
Added Paths:
-----------
branches/exp-elixir-branch/Mailman/docs/use-listmanager.txt
branches/exp-elixir-branch/Mailman/docs/use-usermanager.txt
branches/exp-elixir-branch/Mailman/testing/test_use_listmanager.py
branches/exp-elixir-branch/Mailman/testing/test_use_usermanager.py
Removed Paths:
-------------
branches/exp-elixir-branch/Mailman/docs/mlist-creation.txt
branches/exp-elixir-branch/Mailman/docs/mlist-rosters.txt
branches/exp-elixir-branch/Mailman/testing/test_mlist_creation.py
branches/exp-elixir-branch/Mailman/testing/test_rosters.py
Modified: branches/exp-elixir-branch/Mailman/docs/mlist-addresses.txt
===================================================================
--- branches/exp-elixir-branch/Mailman/docs/mlist-addresses.txt 2007-05-08 19:06:28 \
UTC (rev 8210)
+++ branches/exp-elixir-branch/Mailman/docs/mlist-addresses.txt 2007-05-09 01:31:36 \
UTC (rev 8211) @@ -57,6 +57,10 @@
>>> mlist.unsubscribe_address
'_xtest-unsubscribe@example.com'
+
+Email confirmations
+-------------------
+
Email confirmation messages are sent when actions such as subscriptions need
to be confirmed. It requires that a cookie be provided, which will be
included in the local part of the email address. The exact format of this is
@@ -73,7 +77,9 @@
'_xtest-confirm---cookie@example.com'
>>> config.VERP_CONFIRM_FORMAT = old_format
-Clean up.
+Clean up
+--------
+
>>> for mlist in config.list_manager.mailing_lists:
... config.list_manager.delete(mlist)
Deleted: branches/exp-elixir-branch/Mailman/docs/mlist-creation.txt
===================================================================
--- branches/exp-elixir-branch/Mailman/docs/mlist-creation.txt 2007-05-08 19:06:28 \
UTC (rev 8210)
+++ branches/exp-elixir-branch/Mailman/docs/mlist-creation.txt 2007-05-09 01:31:36 \
UTC (rev 8211) @@ -1,83 +0,0 @@
-Creating a mailing list
-=======================
-
-To create a mailing list, start by importing the IListManager instance that
-talks to the database. This is accessable via the global config object.
-
- >>> from Mailman.configuration import config
- >>> from Mailman.interfaces import IMailingList
-
-Creating the list returns the newly created IMailList object.
-
- >>> mgr = config.list_manager
- >>> mlist = mgr.create('_xtest@example.com')
- >>> IMailingList.providedBy(mlist)
- True
-
-This object has an identity.
-
- >>> from Mailman.interfaces import IMailingListIdentity
- >>> IMailingListIdentity.providedBy(mlist)
- True
-
-All lists with identities have a short name, a host name, and a fully
-qualified listname. This latter is what uniquely distinguishes the mailing
-list to the system.
-
- >>> mlist.list_name
- '_xtest'
- >>> mlist.host_name
- 'example.com'
- >>> mlist.fqdn_listname
- '_xtest@example.com'
-
-If you try to create a mailing list with the same name as an existing list,
-you will get an exception.
-
- >>> mlist_dup = mgr.create('_xtest@example.com')
- Traceback (most recent call last):
- ...
- MMListAlreadyExistsError: _xtest@example.com
-
-Delete the existing list, and you can then create it again. But don't try to
-use the deleted mlist once you've done so.
-
- >>> mgr.delete(mlist)
- >>> mlist.fqdn_listname
- Traceback (most recent call last):
- ...
- AttributeError: fqdn_listname
-
- >>> mlist = mgr.create('_xtest@example.com')
- >>> mlist.fqdn_listname
- '_xtest@example.com'
-
-When a mailing list exists, you can ask the list manager for it and you will
-always get the same object back.
-
- >>> mlist_2 = mgr.get('_xtest@example.com')
- >>> mlist_2 is mlist
- True
-
-Don't try to get a list that doesn't exist yet though, or you will get an
-exception.
-
- >>> mgr.get('_xtest_2@example.com')
- Traceback (most recent call last):
- ...
- MMUnknownListError: _xtest_2@example.com
-
-Once you've created a bunch of mailing lists, you can use the list manager to
-iterate over either the list object, or the list names.
-
- >>> mlist_3 = mgr.create('_xtest_3@example.com')
- >>> mlist_4 = mgr.create('_xtest_4@example.com')
- >>> sorted(mgr.names)
- ['_xtest@example.com', '_xtest_3@example.com', '_xtest_4@example.com']
- >>> sorted(m.fqdn_listname for m in mgr.mailing_lists)
- ['_xtest@example.com', '_xtest_3@example.com', '_xtest_4@example.com']
-
-Clean up.
-
- >>> for mlist in mgr.mailing_lists:
- ... mgr.delete(mlist)
Deleted: branches/exp-elixir-branch/Mailman/docs/mlist-rosters.txt
===================================================================
--- branches/exp-elixir-branch/Mailman/docs/mlist-rosters.txt 2007-05-08 19:06:28 UTC \
(rev 8210)
+++ branches/exp-elixir-branch/Mailman/docs/mlist-rosters.txt 2007-05-09 01:31:36 UTC \
(rev 8211) @@ -1,14 +0,0 @@
-The user manager and rosters
-============================
-
-The user manager contains a set of rosters, each roster is a collection of
-users. The user manager always contains at least one roster, the 'null'
-roster or 'all inclusive roster'.
-
- >>> from Mailman.configuration import config
- >>> mgr = config.user_manager
- >>> sorted(roster.name for roster in mgr.rosters)
- ['']
-
-Users can belong to more than one roster, but the belong to at least
-one roster, the null roster. The null roster returns all the users
\ No newline at end of file
Copied: branches/exp-elixir-branch/Mailman/docs/use-listmanager.txt (from rev 8210, \
branches/exp-elixir-branch/Mailman/docs/mlist-creation.txt) \
===================================================================
--- branches/exp-elixir-branch/Mailman/docs/use-listmanager.txt \
(rev 0)
+++ branches/exp-elixir-branch/Mailman/docs/use-listmanager.txt 2007-05-09 01:31:36 \
UTC (rev 8211) @@ -0,0 +1,106 @@
+Using the IListManager interface
+================================
+
+The IListManager is how you create, delete, and retrieve mailing list
+objects. The Mailman system instantiates an IListManager for you based on the
+configuration variable MANAGERS_INIT_FUNCTION. The instance is accessible
+on the global config object.
+
+ >>> from Mailman.configuration import config
+ >>> from Mailman.interfaces import IListManager
+ >>> IListManager.providedBy(config.list_manager)
+ True
+ >>> mgr = config.list_manager
+
+
+Creating a mailing list
+-----------------------
+
+Creating the list returns the newly created IMailList object.
+
+ >>> from Mailman.interfaces import IMailingList
+ >>> mlist = mgr.create('_xtest@example.com')
+ >>> IMailingList.providedBy(mlist)
+ True
+
+This object has an identity.
+
+ >>> from Mailman.interfaces import IMailingListIdentity
+ >>> IMailingListIdentity.providedBy(mlist)
+ True
+
+All lists with identities have a short name, a host name, and a fully
+qualified listname. This latter is what uniquely distinguishes the mailing
+list to the system.
+
+ >>> mlist.list_name
+ '_xtest'
+ >>> mlist.host_name
+ 'example.com'
+ >>> mlist.fqdn_listname
+ '_xtest@example.com'
+
+If you try to create a mailing list with the same name as an existing list,
+you will get an exception.
+
+ >>> mlist_dup = mgr.create('_xtest@example.com')
+ Traceback (most recent call last):
+ ...
+ MMListAlreadyExistsError: _xtest@example.com
+
+
+Deleting a mailing list
+-----------------------
+
+Delete the existing list, and you can then create it again. But don't try to
+use the deleted mlist once you've done so.
+
+ >>> mgr.delete(mlist)
+ >>> mlist.fqdn_listname
+ Traceback (most recent call last):
+ ...
+ AttributeError: fqdn_listname
+
+ >>> mlist = mgr.create('_xtest@example.com')
+ >>> mlist.fqdn_listname
+ '_xtest@example.com'
+
+
+Retrieving a mailing list
+-------------------------
+
+When a mailing list exists, you can ask the list manager for it and you will
+always get the same object back.
+
+ >>> mlist_2 = mgr.get('_xtest@example.com')
+ >>> mlist_2 is mlist
+ True
+
+Don't try to get a list that doesn't exist yet though, or you will get an
+exception.
+
+ >>> mgr.get('_xtest_2@example.com')
+ Traceback (most recent call last):
+ ...
+ MMUnknownListError: _xtest_2@example.com
+
+
+Iterating over all mailing lists
+--------------------------------
+
+Once you've created a bunch of mailing lists, you can use the list manager to
+iterate over either the list object, or the list names.
+
+ >>> mlist_3 = mgr.create('_xtest_3@example.com')
+ >>> mlist_4 = mgr.create('_xtest_4@example.com')
+ >>> sorted(mgr.names)
+ ['_xtest@example.com', '_xtest_3@example.com', '_xtest_4@example.com']
+ >>> sorted(m.fqdn_listname for m in mgr.mailing_lists)
+ ['_xtest@example.com', '_xtest_3@example.com', '_xtest_4@example.com']
+
+
+Cleaning up
+-----------
+
+ >>> for mlist in mgr.mailing_lists:
+ ... mgr.delete(mlist)
Copied: branches/exp-elixir-branch/Mailman/docs/use-usermanager.txt (from rev 8210, \
branches/exp-elixir-branch/Mailman/docs/mlist-rosters.txt) \
===================================================================
--- branches/exp-elixir-branch/Mailman/docs/use-usermanager.txt \
(rev 0)
+++ branches/exp-elixir-branch/Mailman/docs/use-usermanager.txt 2007-05-09 01:31:36 \
UTC (rev 8211) @@ -0,0 +1,14 @@
+The user manager and rosters
+============================
+
+The user manager contains a set of rosters, each roster is a collection of
+users. The user manager always contains at least one roster, the 'null'
+roster or 'all inclusive roster'.
+
+ >>> from Mailman.configuration import config
+ >>> mgr = config.user_manager
+ >>> sorted(roster.name for roster in mgr.rosters)
+ ['']
+
+Users can belong to more than one roster, but the belong to at least
+one roster, the null roster. The null roster returns all the users
\ No newline at end of file
Deleted: branches/exp-elixir-branch/Mailman/testing/test_mlist_creation.py
===================================================================
--- branches/exp-elixir-branch/Mailman/testing/test_mlist_creation.py 2007-05-08 \
19:06:28 UTC (rev 8210)
+++ branches/exp-elixir-branch/Mailman/testing/test_mlist_creation.py 2007-05-09 \
01:31:36 UTC (rev 8211) @@ -1,28 +0,0 @@
-# Copyright (C) 2007 by the Free Software Foundation, Inc.
-#
-# This program is free software; you can redistribute it and/or
-# modify it under the terms of the GNU General Public License
-# as published by the Free Software Foundation; either version 2
-# of the License, or (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
-# USA.
-
-"""Doctest harness for testing mailing list creation and deletion."""
-
-import doctest
-import unittest
-
-
-def test_suite():
- suite = unittest.TestSuite()
- suite.addTest(doctest.DocFileSuite('../docs/mlist-creation.txt',
- optionflags=doctest.ELLIPSIS))
- return suite
Deleted: branches/exp-elixir-branch/Mailman/testing/test_rosters.py
===================================================================
--- branches/exp-elixir-branch/Mailman/testing/test_rosters.py 2007-05-08 19:06:28 \
UTC (rev 8210)
+++ branches/exp-elixir-branch/Mailman/testing/test_rosters.py 2007-05-09 01:31:36 \
UTC (rev 8211) @@ -1,28 +0,0 @@
-# Copyright (C) 2007 by the Free Software Foundation, Inc.
-#
-# This program is free software; you can redistribute it and/or
-# modify it under the terms of the GNU General Public License
-# as published by the Free Software Foundation; either version 2
-# of the License, or (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
-# USA.
-
-"""Doctest harness for testing mailing list creation and deletion."""
-
-import doctest
-import unittest
-
-
-def test_suite():
- suite = unittest.TestSuite()
- suite.addTest(doctest.DocFileSuite('../docs/mlist-rosters.txt',
- optionflags=doctest.ELLIPSIS))
- return suite
Copied: branches/exp-elixir-branch/Mailman/testing/test_use_listmanager.py (from rev \
8210, branches/exp-elixir-branch/Mailman/testing/test_mlist_creation.py) \
===================================================================
--- branches/exp-elixir-branch/Mailman/testing/test_use_listmanager.py \
(rev 0)
+++ branches/exp-elixir-branch/Mailman/testing/test_use_listmanager.py 2007-05-09 \
01:31:36 UTC (rev 8211) @@ -0,0 +1,28 @@
+# Copyright (C) 2007 by the Free Software Foundation, Inc.
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
+# USA.
+
+"""Doctest harness for testing mailing list creation and deletion."""
+
+import doctest
+import unittest
+
+
+def test_suite():
+ suite = unittest.TestSuite()
+ suite.addTest(doctest.DocFileSuite('../docs/use-listmanager.txt',
+ optionflags=doctest.ELLIPSIS))
+ return suite
Copied: branches/exp-elixir-branch/Mailman/testing/test_use_usermanager.py (from rev \
8210, branches/exp-elixir-branch/Mailman/testing/test_rosters.py) \
===================================================================
--- branches/exp-elixir-branch/Mailman/testing/test_use_usermanager.py \
(rev 0)
+++ branches/exp-elixir-branch/Mailman/testing/test_use_usermanager.py 2007-05-09 \
01:31:36 UTC (rev 8211) @@ -0,0 +1,28 @@
+# Copyright (C) 2007 by the Free Software Foundation, Inc.
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
+# USA.
+
+"""Doctest harness for testing mailing list creation and deletion."""
+
+import doctest
+import unittest
+
+
+def test_suite():
+ suite = unittest.TestSuite()
+ suite.addTest(doctest.DocFileSuite('../docs/use-usermanager.txt',
+ optionflags=doctest.ELLIPSIS))
+ return suite
This was sent by the SourceForge.net collaborative development platform, the world's \
largest Open Source development site. _______________________________________________
Mailman-checkins mailing list
Mailman-checkins@python.org
Unsubscribe: http://mail.python.org/mailman/options/mailman-checkins/mailman-cvs%40progressive-comp.com
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic