Mark Sapiro pushed to branch master at GNU Mailman / Mailman Core
Commits:
beb593cb by Mark Sapiro at 2021-03-14T14:40:36-07:00
Document delivery_mode and delivery_status register() args.
- - - - -
1e24fa89 by Mark Sapiro at 2021-03-14T22:42:54+00:00
Merge branch 'iface' into 'master'
Document delivery_mode and delivery_status register() args.
See merge request mailman/mailman!795
- - - - -
1 changed file:
- src/mailman/interfaces/subscriptions.py
Changes:
=====================================
src/mailman/interfaces/subscriptions.py
=====================================
@@ -234,7 +234,8 @@ class ISubscriptionManager(Interface):
"""
def register(subscriber=None, *,
pre_verified=False, pre_confirmed=False, pre_approved=False,
- invitation=False, send_welcome_message=None):
+ invitation=False, send_welcome_message=None,
+ delivery_mode=None, delivery_status=None):
"""Subscribe an address or user according to subscription policies.
The mailing list's subscription policy is used to subscribe
@@ -251,7 +252,7 @@ class ISubscriptionManager(Interface):
resume the workflow.
:param subscriber: The user or address to subscribe.
- :type email: ``IUser`` or ``IAddress``
+ :type subscriber: ``IUser`` or ``IAddress``
:param pre_verified: A flag indicating whether the subscriber's email
address should be considered pre-verified. Normally a never
before seen email address must be verified by mail-back
@@ -285,6 +286,12 @@ class ISubscriptionManager(Interface):
should receive a welcome message. This overrides the list's
configuration of send_welcome_message if it is specified.
:type send_welcome_message: bool
+ :param delivery_mode: A ``DeliveryMode`` enum which if specified sets
+ delivery_mode for the subscription.
+ :type delivery_mode: ``DeliveryMode`` enum or None:
+ :param delivery_status: A ``DeliveryStatus`` enum which if specified
+ sets delivery_status for the subscription.
+ :type delivery_status: ``DeliveryStatus`` enum or None:
:return: A 3-tuple is returned where the first element is the token
hash, the second element is a ``TokenOwner`, and the third element
is the subscribed member. If the subscriber got subscribed
@@ -315,7 +322,7 @@ class ISubscriptionManager(Interface):
resume the workflow.
:param subscriber: The user or address to unsubscribe.
- :type email: ``IUser`` or ``IAddress``
+ :type subscriber: ``IUser`` or ``IAddress``
:param pre_confirmed: A flag indicating whether, when required by the
unsubscription policy, an unsubscription request should be
considered pre-confirmed. Normally in such cases, a mail-back
View it on GitLab:
https://gitlab.com/mailman/mailman/-/compare/56dcb1031a16217463a18b9e9afcd0f7051cfc60...1e24fa89ddf4750993ec232b7f03afe054b39d31
--
View it on GitLab:
https://gitlab.com/mailman/mailman/-/compare/56dcb1031a16217463a18b9e9afcd0f7051cfc60...1e24fa89ddf4750993ec232b7f03afe054b39d31
You're receiving this email because of your account on gitlab.com.
_______________________________________________
Mailman-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/mailman-checkins.python.org/
Member address: [email protected]
