DandelionNStuff/dkimpy-smtputf8
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

- Added missing documentation for timestamp function dkim.arc_sign

Browse Source 
(LP: #1800314)
This commit is contained in:
Scott Kitterman
2018-10-30 11:52:43 -04:00
parent 09d4c3d84d
commit 267e62115e
2 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
ChangeLog
+2
View File
@@ -14,6 +14,8 @@ UNRELEASED Version 0.9.0
- Raise error when ARC signing if i= instance limit value of 50 is - Raise error when ARC signing if i= instance limit value of 50 is
exceeded exceeded
- Specified that for ARC, Authentication-Results should not be signed - Specified that for ARC, Authentication-Results should not be signed
- Added missing documentation for timestamp function dkim.arc_sign
(LP: #1800314)
- Fix DNS lookups to be compatible with EAI addresses in domains and - Fix DNS lookups to be compatible with EAI addresses in domains and
selectors (John Levine) selectors (John Levine)
- Add type Hinting for sign and verify functions (LP: #1782596) - Add type Hinting for sign and verify functions (LP: #1782596)
dkim/__init__.py
+1
View File
@@ -1265,6 +1265,7 @@ def arc_sign(message, selector, domain, privkey,
@param srv_id: the authserv_id used to identify the ADMD's AR headers @param srv_id: the authserv_id used to identify the ADMD's AR headers
@param signature_algorithm: the signing algorithm to use when signing @param signature_algorithm: the signing algorithm to use when signing
@param include_headers: a list of strings indicating which headers are to be signed (default all headers not listed as SHOULD NOT sign) @param include_headers: a list of strings indicating which headers are to be signed (default all headers not listed as SHOULD NOT sign)
@param timestamp: the time in integer seconds when the message is sealed (default is int(time.time) based on platform, can be string or int)
@param logger: a logger to which debug info will be written (default None) @param logger: a logger to which debug info will be written (default None)
@return: A list containing the ARC set of header fields for the next instance @return: A list containing the ARC set of header fields for the next instance
@raise DKIMException: when the message, include_headers, or key are badly formed. @raise DKIMException: when the message, include_headers, or key are badly formed.