summaryrefslogtreecommitdiff
path: root/src/mailman/interfaces/pending.py
diff options
context:
space:
mode:
authorBarry Warsaw2017-01-08 23:21:15 -0500
committerBarry Warsaw2017-01-08 23:21:15 -0500
commita01ef2bac4d52da67e4be1fccc2634086aaa03e3 (patch)
treee077c807084e5f15ea92f4748ffa6bf7e2df92f7 /src/mailman/interfaces/pending.py
parent7b3b9d37f94f744c863b6b96f2d75a558357e397 (diff)
downloadmailman-a01ef2bac4d52da67e4be1fccc2634086aaa03e3.tar.gz
mailman-a01ef2bac4d52da67e4be1fccc2634086aaa03e3.tar.zst
mailman-a01ef2bac4d52da67e4be1fccc2634086aaa03e3.zip
Diffstat (limited to 'src/mailman/interfaces/pending.py')
-rw-r--r--src/mailman/interfaces/pending.py18
1 files changed, 12 insertions, 6 deletions
diff --git a/src/mailman/interfaces/pending.py b/src/mailman/interfaces/pending.py
index 841d195f5..aef18bcb4 100644
--- a/src/mailman/interfaces/pending.py
+++ b/src/mailman/interfaces/pending.py
@@ -96,14 +96,20 @@ class IPendings(Interface):
def evict():
"""Remove all pended items whose lifetime has expired."""
- def find(mlist=None, pend_type=None):
+ def find(mlist=None, pend_type=None, confirm=True):
"""Search for the pendables matching the given criteria.
- :param mlist: The MailingList object that the pendables must be
- related to.
- :param pend_type: The type of the pendables that are looked for, this
- corresponds to the `PEND_TYPE` attribute.
- :return: An iterator over 2-tuples of the form (token, dict).
+ :param mlist: The mailing list object that the pendables must be
+ related to, or None. The default returns all pendables regardless
+ of which mailing list they are related to.
+ :type mlist: IMailingList or None.
+ :param pend_type: The type of the pendables that are looked for, or
+ None. This corresponds to the `PEND_TYPE` attribute. The default
+ returns all pending types.
+ :param confirm: A flag indicating whether the found pendings should be
+ "confirmed" or not. See ``confirm()`` for details.
+ :return: An iterator over 2-tuples of the form (token, pendable).
+ When ``confirm`` is False, ``pendable`` is None.
"""
def __iter__():