diff --git a/README.rst b/README.rst index b2a95e8..1f10e98 100644 --- a/README.rst +++ b/README.rst @@ -147,6 +147,7 @@ For example host = imap.example.com user = dmarcresports@example.com password = $uperSecure + # Starting in 8.0.0, the watch option has moved to the mailbox section [mailbox] watch = True @@ -169,15 +170,14 @@ For example server = localhost port = 514 - [gmail_api] - credentials_file = /path/to/credentials.json # Get this file from console.google.com. See https://developers.google.com/identity/protocols/oauth2 - token_file = /path/to/token.json # This file will be generated automatically - scopes = https://mail.google.com/ - include_spam_trash=True The full set of configuration options are: +.. note:: + ``%`` characters must be escaped with another ``%`` character, so use ``%%`` wherever a `%`` character is used, such as a password. + + - ``general`` - ``save_aggregate`` - bool: Save aggregate report data to Elasticsearch, Splunk and/or S3 - ``save_forensic`` - bool: Save forensic report data to Elasticsearch, Splunk and/or S3 @@ -210,7 +210,10 @@ The full set of configuration options are: - ``host`` - str: The IMAP server hostname or IP address - ``port`` - int: The IMAP server port (Default: 993). - .. note:: + .. note:: + Starting in version 8.0.0, the ``watch`` option has been moved to the ``mailbox`` section + + .. note:: If your host recommends another port, still try 993 - ``ssl`` - bool: Use an encrypted SSL/TLS connection (Default: True) diff --git a/docs/index.rst b/docs/index.rst index f6e1492..a143f88 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -142,6 +142,7 @@ For example host = imap.example.com user = dmarcresports@example.com password = $uperSecure + # Starting in 8.0.0, the watch option has moved to the mailbox section [mailbox] watch = True @@ -164,15 +165,11 @@ For example server = localhost port = 514 - [gmail_api] - credentials_file = /path/to/credentials.json # Get this file from console.google.com. See https://developers.google.com/identity/protocols/oauth2 - token_file = /path/to/token.json # This file will be generated automatically - scopes = https://mail.google.com/ - include_spam_trash=True The full set of configuration options are: + - ``general`` - ``save_aggregate`` - bool: Save aggregate report data to Elasticsearch, Splunk and/or S3 - ``save_forensic`` - bool: Save forensic report data to Elasticsearch, Splunk and/or S3 @@ -203,7 +200,13 @@ The full set of configuration options are: - ``imap`` - ``host`` - str: The IMAP server hostname or IP address - - ``port`` - int: The IMAP server port (Default: 993). + - ``port`` - int: The IMAP server port (Default: 993) + + .. note:: + ``%`` characters must be escaped with another ``%`` character, so use ``%%`` wherever a ``%`` character is used. + + .. note:: + Starting in version 8.0.0, the ``watch`` option has been moved to the ``mailbox`` section .. note:: If your host recommends another port, still try 993 @@ -260,6 +263,10 @@ The full set of configuration options are: - ``subject`` - str: The Subject header to use in the email (Default: parsedmarc report) - ``attachment`` - str: The ZIP attachment filenames - ``message`` - str: The email message (Default: Please see the attached parsedmarc report.) + + .. note:: + ``%`` characters must be escaped with another ``%`` character, so use ``%%`` wherever a ``%`` character is used. + - ``s3`` - ``bucket`` - str: The S3 bucket name - ``path`` - int: The path to upload reports to (Default: /) diff --git a/parsedmarc/cli.py b/parsedmarc/cli.py index c595ea9..beb8e50 100644 --- a/parsedmarc/cli.py +++ b/parsedmarc/cli.py @@ -396,6 +396,10 @@ def _main(): if "imap" in config.sections(): imap_config = config["imap"] + if "watch" in imap_config: + logger.warning("Starting in 8.0.0, the watch option has been " + "moved from the imap configuration section to " + "the mailbox configuration section.") if "host" in imap_config: opts.imap_host = imap_config["host"] else: