summaryrefslogtreecommitdiff
path: root/src/mailman/interfaces/messages.py
diff options
context:
space:
mode:
authorBarry Warsaw2016-03-08 23:01:14 -0500
committerBarry Warsaw2016-03-08 23:01:14 -0500
commitcb8ddd1671e424478f002e527871f0c5839425d9 (patch)
treeff8845ca998b2b4ea2f67a908c862d79f664f6d7 /src/mailman/interfaces/messages.py
parent47b4d1f987a91e1a2ce9b1e533c166ca21c2477e (diff)
downloadmailman-cb8ddd1671e424478f002e527871f0c5839425d9.tar.gz
mailman-cb8ddd1671e424478f002e527871f0c5839425d9.tar.zst
mailman-cb8ddd1671e424478f002e527871f0c5839425d9.zip
Diffstat (limited to 'src/mailman/interfaces/messages.py')
-rw-r--r--src/mailman/interfaces/messages.py9
1 files changed, 5 insertions, 4 deletions
diff --git a/src/mailman/interfaces/messages.py b/src/mailman/interfaces/messages.py
index bdc06c0fc..ed8dad4c7 100644
--- a/src/mailman/interfaces/messages.py
+++ b/src/mailman/interfaces/messages.py
@@ -64,11 +64,12 @@ class IMessageStore(Interface):
:param message: An email.message.Message instance containing at least
a unique Message-ID header. The message will be given an
- Message-ID-Hash header, overriding any existing such header.
- :returns: The calculated Message-ID-Hash header.
+ Message-ID-Hash header, overriding any existing such header. If
+ the message already exists in the store, it is not added again.
+ :returns: The calculated Message-ID-Hash header or None if the message
+ already exists in the store.
+ :rtype: str or None
:raises ValueError: if the message is missing a Message-ID header.
- The storage service is also allowed to raise this exception if it
- find, but disallows collisions.
"""
def get_message_by_id(message_id):