From 57d115d0396e20662d6eddd8881fa68801a94bd3 Mon Sep 17 00:00:00 2001 From: Julie Zhao Date: Tue, 14 May 2024 08:56:02 -0400 Subject: [PATCH] add mta-sts config options and control commands into summaries --- content/momentum/4/4-console-commands.md | 5 ++++- content/momentum/4/config-options-summary.md | 4 ++++ content/momentum/4/config/index.md | 4 ++++ content/momentum/4/console-commands/index.md | 4 +++- 4 files changed, 15 insertions(+), 2 deletions(-) diff --git a/content/momentum/4/4-console-commands.md b/content/momentum/4/4-console-commands.md index 3570e8fd9..4136666f6 100644 --- a/content/momentum/4/4-console-commands.md +++ b/content/momentum/4/4-console-commands.md @@ -118,6 +118,9 @@ This table lists all console commands alphabetically giving a brief description. | [message retry](/momentum/4/console-commands/message-retry) – Perform an immediate delivery attempt on a message | 4.0 |   | message | | [module hooks](/momentum/4/console-commands/4-module) – Manage loaded module hooks | 4.0 |   | module | | [module list](/momentum/4/console-commands/4-module) – Show loaded modules | 4.0 |   | module | +| [mta_sts list all](/momentum/4/console-commands/mta-sts) – list active domains which have MTA-STS policy | 4.8 |   | mta-sts | +| [mta_sts show domain](/momentum/4/console-commands/mta-sts) – show MTA-STS policy details for a domain | 4.8 |   | mta-sts | +| [mta_sts refresh policy](/momentum/4/console-commands/mta-sts) – refresh MTA-STS policy for a domain | 4.8 |   | mta-sts | | [outbound_audit:instance_name clear all](/momentum/4/modules/outbound-audit#modules.outbound_audit.console) – Zero-out all statistics | 4.0 | outbound_audit | module | | [outbound_audit:instance_name clear domain](/momentum/4/modules/outbound-audit#modules.outbound_audit.console) – Zero-out a domain's statistics | 4.0 | outbound_audit | module | | [outbound_audit:instance_name domain_list](/momentum/4/modules/outbound-audit#modules.outbound_audit.console) – Runtime addition/deletion of a domain in the monitoring list | 4.0 | outbound_audit | module | @@ -160,4 +163,4 @@ This table lists all console commands alphabetically giving a brief description. | [trace smtp remove](/momentum/4/console-commands/trace-smtp) – Remove an SMTP trace | 4.0 |   | misc | | [unlink stats](/momentum/4/console-commands/unlink-stats) – Show statistics of removing messages from the disk | 4.0 |   | stats | | [version](/momentum/4/console-commands/version) – Show version information of Momentum | 4.0 |   | misc | -| [write config](/momentum/4/console-commands/write-config) – Display current running configuration | 4.0 |   | config | \ No newline at end of file +| [write config](/momentum/4/console-commands/write-config) – Display current running configuration | 4.0 |   | config | diff --git a/content/momentum/4/config-options-summary.md b/content/momentum/4/config-options-summary.md index cca6110c6..7f3f5293d 100644 --- a/content/momentum/4/config-options-summary.md +++ b/content/momentum/4/config-options-summary.md @@ -149,6 +149,7 @@ The `Version` column indicated the version(s) of Momentum that support the optio | [enable_authorization](/momentum/4/control-authz) – Whether or not to enable authorization for console commands | receiving |   | 4.0 and later | control_listener, listen, peer | | [enable_duravip](/momentum/4/4-cluster-config-duravip) – Whether to enable Durable MultiVIP© bindings (cluster-specific) | both |   | 4.0 and later | binding, listen | | [enable_fbl_header_insertion](/momentum/4/config/ref-enable-fbl-header-insertion) – Enable or disable fbl header insertion | sending |   | 4.0 and later | binding, binding_group, domain, global | +| [enable_mta_sts](/momentum/4/config/mta-sts/enable_mta_sts) – Enable or disable MTA-STS policy application | sending |   | 4.8 and later | binding, binding_group, domain, global | | **enabled** – Whether or not the module is enabled (cluster-specific) | na | true | 4.0 and later | cluster | | [error](/momentum/4/config/ref-debug-flags) – Set the debug level | na | ALL | 4.0 and later | debug_flags | | [esmtp_listener](/momentum/4/esmtp-listener) *(scope)* – Listener for incoming SMTP connections | receiving |   | 4.0 and later | global | @@ -237,6 +238,8 @@ The `Version` column indicated the version(s) of Momentum that support the optio | [max_resident_active_queue](/momentum/4/config/ref-max-resident-active-queue) – Threshold above which messages are not held in memory | sending | 250 | 4.0 and later | binding, binding_group, domain, global | | [max_resident_messages](/momentum/4/config/ref-max-resident-messages) – Threshold above which messages are not held in memory | sending | 32768 | 4.0 and later | binding, binding_group, global | | [max_resident_transfails](/momentum/4/config/ref-max-resident-transfails) – If the transient failure queue grows beyond this size, messages are swapped out of memory | sending | 100 | 4.0 and later | global | +| [mta_sts_dns_cname_max_depth](/momentum/4/config/mta-sts/mta-sts-dns-cname-max-depth) – Maximum number of continous CNAME lookups allowed while doing MTA-STS DNS lookup | sending | 5 | 4.8 and later | global | +| [mta_sts_policy_store](/momentum/4/config/mta-sts/mta-sts-policy-store) – Directory to store MTA-STS policy files | sending | /var/spool/ecelerity/mtasts (*non-dynamic*) | 4.8 and later | global | | [swap_out_meta_after_each_tempfail](/momentum/4/config/ref-swap-out-meta-after-each-tempfail) – If this is set to false, Momentum will only update metadata on disk after each tempfail if the message context is dirty, and the num_retires, next_attempt and message context may not be accurate if Momentum crashes | sending | true | 4.3.1 and later | global | | [max_retries](/momentum/4/config/ref-max-retries) – Override the system configured max_retries | sending |   | 4.0 and later | binding, binding_group, domain, global | | [max_retry_interval](/momentum/4/config/ref-max-retry-interval) – Maximum retry interval | sending | 43200 | 4.0 and later | binding, binding_group, domain, global | @@ -365,6 +368,7 @@ The `Version` column indicated the version(s) of Momentum that support the optio | [use_iflist_cache](/momentum/4/config/ref-use-iflist-cache) – Whether or not to cache the list of interfaces configured by the system | sending | 0 (*non-dynamic*) | 4.0 and later | global | | [use_ipv6](/momentum/4/config/ref-use-ipv-6) – Affects the selection of IPv6 hosts in the SMTP client | sending | false | 4.0 and later | global | | [use_mmap](/momentum/4/config/ref-use-mmap) – Use mmap when spooling messages from disk | na | false | 4.0 and later | global | +| [use_mta_sts](/momentum/4/config/mta-sts/use-mta-sts) – Enable MTA-STS policy fetching on a domain | sending | false | 4.8 and later | global, domain | | [use_sendfile](/momentum/4/config/ref-use-sendfile) – Use sendfile() when sending mail | sending | false | 4.0 and later | global | | **use_ssl** – Whether or not to use SSL verification | receiving | false | 4.0 and later | ecstream_listener, esmtp_listener, http_listener, listen, pathway, pathway_group, peer | | [user](/momentum/4/config/ref-user) – User identity to assume after startup | na | ecuser (*non-dynamic*) | 4.0 and later | security | diff --git a/content/momentum/4/config/index.md b/content/momentum/4/config/index.md index 5f820d160..b2d056c29 100644 --- a/content/momentum/4/config/index.md +++ b/content/momentum/4/config/index.md @@ -76,6 +76,7 @@ description: "This chapter provides the definitions of the configuration options | [ehlo_hostname](/momentum/4/config/ref-ehlo-hostname) | set the hostname used for EHLO in outbound mail | | [ehlo_timeout](/momentum/4/config/ref-ehlo-timeout) | network timeout for EHLO | | [enable_fbl_header_insertion](/momentum/4/config/ref-enable-fbl-header-insertion) | enable or disable fbl header insertion | +| [enable_mta_sts](/momentum/4/config/mta-sts/enable-mta-sts) | enable application of MTA-STS policy on email delivery to a remote domain | | [event_loop](/momentum/4/config/ref-event-loop) | associate a pool of event loops within a listener scope to use multiple threads | | [eventloop](/momentum/4/config/ref-eventloop) | define a pool of event loops to enable multiple event loop configuration | | [events_per_iter](/momentum/4/config/ref-events-per-iter) | employ when using a concurrency greater than 1. | @@ -136,6 +137,8 @@ description: "This chapter provides the definitions of the configuration options | [migrate_connections_between_sibling_domains](/momentum/4/config/ref-migrate-connections-between-sibling-domains) | optimize connections for sibling domains | | [mime_parse_large_messages_during_reception](/momentum/4/config/ref-mime-parse-large-messages-during-reception) | configure whether large messages are parsed upon reception or just in time. | | [min_dns_ttl](/momentum/4/config/ref-min-dns-ttl) | override DNS TTLs smaller than this value | +| [mta_sts_dns_cname_max_depth](/momentum/4/config/mta-sts/mta-sts-dns-cname-max-depth) | the maximum number of continuous CNAME lookups while doing MTA-STS DNS TXT lookup | +| [mta_sts_policy_store](/momentum/4/config/mta-sts/mta-sts-policy-store) | the directory to store MTA-STS policy files | | [mx_failures_fallback_to_a](/momentum/4/config/ref-mx-failures-fallback-to-a) | configure the maximum number of times an MX lookup will be attempted | | [mx_failures_to_delay](/momentum/4/config/ref-mx-failures-to-delay) | number of consecutive failures before a domain is auto-delayed | | [never_attempt_expired_messages](/momentum/4/config/ref-never-attempt-expired-messages) | Never attempt delivery of expired messages | @@ -227,6 +230,7 @@ description: "This chapter provides the definitions of the configuration options | [use_iflist_cache](/momentum/4/config/ref-use-iflist-cache) | Whether or not to cache the list of network interfaces configured by the system | | [use_ipv6](/momentum/4/config/ref-use-ipv-6) | Affects the selection of IPv6 hosts in the SMTP client | | [use_mmap](/momentum/4/config/ref-use-mmap) | use mmap when spooling messages from disk | +| [use_mta_sts](/momentum/4/config/mta-sts/use-mta-sts) | fetch MTA-STS policy for a domain | | [use_sendfile](/momentum/4/config/ref-use-sendfile) | use sendfile() when sending mail | | [user](/momentum/4/config/ref-user) | security: user identity to assume after startup | | [xclient](/momentum/4/config/ref-xclient) | use the xclient extension to SMTP for outbound mail | diff --git a/content/momentum/4/console-commands/index.md b/content/momentum/4/console-commands/index.md index d9219f1ce..e7aac7652 100644 --- a/content/momentum/4/console-commands/index.md +++ b/content/momentum/4/console-commands/index.md @@ -1,5 +1,5 @@ --- -lastUpdated: "02/09/2021" +lastUpdated: "06/01/2024" title: "Category File" type: "custom" name: "Non-Module-Specific Console Commands" @@ -44,6 +44,8 @@ description: "This section documents all the non module specific console command | [message fail quiet](/momentum/4/console-commands/message-fail-quiet) | fail a message and do not create a non-delivery receipt (NDR) | | [message retry](/momentum/4/console-commands/message-retry) | perform an immediate delivery attempt on a message | | [module](/momentum/4/console-commands/4-module) | manage loaded modules online | +| [mta_sts](/momentum/4/console-commands/mta_sts) | commands to display and manage MTA-STS policy for a domain | +| [\pager](/momentum/4/console-commands/pager) | Page output of long console commands in the console. | | [\pager](/momentum/4/console-commands/pager) | Page output of long console commands in the console. | | [paniclog](/momentum/4/console-commands/paniclog) | show last several entries written to paniclog | | [pid](/momentum/4/console-commands/pid) | show process id of Momentum |