Summary Module Information

March 26, 2020

All Modules

In this table all modules are listed alphabetically with a brief description. Singleton and deprecated modules are identified. If a singleton module is followed by a version number, that number identifies when that module became a singleton. The Auto column indicates whether a module is loaded automatically as required. Note: this applies only to modules in version 3.x. The Type column indicates the MTA type of a given option. Options of type na do not directly apply to either a sending or receiving MTA. The Cluster column indicates whether a module is cluster-specific. The "valid" column indicates whether a module is a validation module.

Name Version Description Auto Cluster Valid See Also
“Live Bounce Updates – Module” 3.0 Canonicalizes bounce messages into a number of categories
“ac_auth – Authentication Handler” 3.6.5 Enable a Lua module to hook into the authentication mechanism
“adaptive – Adaptive Delivery” (singleton) 3.0 Dynamically tune delivery options
“alerting – alerting” (singleton) 3.0 Enable Lua policy scripts and alerts “scriptlet – Module”
“alias – Alias Expansion Module” 3.0 Rewrite recipient addresses “ds_core – Datasource Query Core”
“antivirus – Antivirus Modules” 3.0 The antivirus framework “clamav – ClamAV”, “csapi – The Content Scanning API Module”
apn (singleton) 3.5.4 Use this module to configure the Apple Push Notification service
apn_logger 3.5.4 Use this module to log Apple Push notifications
“as_logger – Audit series logger” (singleton 3.1 ) 3.0 Replicate audit series to disk
“auth_ds – Datasource based SMTP Authentication” (singleton) 3.0 Use a data source to authenticate an SMTP session “ds_core – Datasource Query Core”
“auth_radius – RADIUS based SMTP Authentication” (singleton) 3.0 Authenticate SMTP sessions via SMTP AUTH using RADIUS servers
“beik – BEIK Module” (singleton) 3.0 This module provides an in-process version of the brightmail module “brightmail – Brightmail Module”
“bind_address_secondary – Dual-stack IPv4/IPv6 Support” 3.6.10 Dual-stack IPv4/IPv6 Support
“bounce_classifier – Bounce Classifier” (deprecated) 3.0 Override the built-in bounce classification
“bounce_classifier_override – The Bounce Classifier Override Module” (singleton) 3.1 Override the built-in bounce classification “bounce_classifier – Bounce Classifier”
“bounce_logger – Momentum-Style Bounce Logging” 3.0 Log bounced messages
“brightmail – Brightmail Module” 3.0 Check inbound mail against a Brightmail server
bzip2io (singleton) 3.0 bzip compression algorithm “compress_spool – Dynamic Spool Compression”
“chunk_logger – Asynchronous Logging” 3.6.5 Provide an interface for logging asynchronously from Lua, C, and C++
“cidrdb – CIDRDB” (singleton) 3.0 Expose scripting functions for checking IP addresses
“clamav – ClamAV” 3.0 Support for Clam AV “antivirus – Antivirus Modules”
“cloudmark – Cloudmark Authority Module” (singleton 3.4 ) 3.0 Support for the Cloudmark spam technology
cluster (singleton) 3.0 The cluster configuration module Clustering
“commtouch_ctasd – Commtouch_ctasd Module” 3.0 Spam protection technology
“compress_spool – Dynamic Spool Compression” (singleton) 3.0 Compress large messages before writing them to disk
“conntrol – Fine-Grained Connection Control” 3.0 Control how inbound connections are established
“csapi – The Content Scanning API Module” 3.0 Integration for Symantec content scanners
“custom_bounce_logger – Custom Bounce Logging” 3.6.5 Append a "User_String" to the end of each bounce record “bounce_logger – Momentum-Style Bounce Logging”
“custom_logger – Customizable Logging” 3.0 Create custom logs
“delay_dsn – Delay DSN Generation” 3.0 Configure and send delay DSNs
dk_sign 3.0 Attach domain keys signatures to outbound mail
dk_validate 3.0 Validate inbound mail checking domain keys signatures
dkim_sign 3.0 Attach DKIM signatures to outbound mail
dkim_validate 3.0 Validate inbound mail checking DKIM signatures
“dnsbuf – Dynamically Set the DNS UDP Buffer Size” 3.6.5 Manipulate DNS buffer sizes on demand
“ds_core – Datasource Query Core” (singleton) 3.0 Provide modular data access and caching for use by other modules
“ec_logger – Momentum-Style Logging” 3.0 Log the status of messages
“eleven – Module” (singleton) 3.1 This module implements the eleven spam filter and categorization service
“exim_logger – Exim-Compatible Logging” 3.0 Support for Exim style logs
“fbl – Feedback Loop Module” (singleton) 3.0 Manage feedback loop services
“fingerprint – Host Fingerprinting” 3.0 Perform passive OS fingerprinting
gcm (singleton) 3.5.4 Use this module to configure Google Cloud messaging
gcm_logger 3.5.4 Use this module to log Google Cloud messages
gzipio (singleton) 3.0 gzip compression algorithm “compress_spool – Dynamic Spool Compression”
“http_io – HTTP I/O Provider” (singleton) 3.0 Read content at a URI
httpsrv (singleton) 3.1 The HTTP server required for using the REST injection API
“icu – ICU” (singleton) 3.0 Unicode support
“ilf_logger Module” (singleton) 3.5.6 Use this module if you have usage-based licenses
“imageanalyzer – Module” 3.0 Support for the Image Analyzer engine
“inbound_audit – Inbound traffic analytics” (singleton 3.0.23 ) 3.0 Provide analytics on sending IPs “outbound_audit – Outbound traffic analytics”
“ipv6_lookup – Multi-address-family MX Records” 3.6.10 Multi-address-family MX Records
“jlog – The jlog Module” (singleton) 3.0 Create jlog formatted logs
“mail_loop – Mail Loop Detection” 3.0 Automatic suppression of potential mail loops
“maildir – Maildir Delivery Support” 3.0 Store messages in maildir format as specified by qmail
mm7 (singleton) 3.1 Enable MM7
mm7_serv (singleton) 3.1 Enable the MM7 Value Added Service Provider
mms_bounce_logger 3.1 Enable MMS bounce logging
mms_logger 3.1 Enable MMS logging
msgc_client (singleton) 3.4 The client component of MSGC
msgc_server (singleton) 3.4 The server component of MSGC
“mxip – IP Addresses In MX Records” 3.6.5 Enable Momentum 3.0 to deliver to domains with a textual IP address
opendkim 3.6 Validate/sign mail using DKIM signatures
“outbound_audit – Outbound traffic analytics” 3.0 Provides time-series analytics on the behavior of receiving domains
“outbound_smtp_auth – Module” 3.6.12 Enables users to specify authentication parameters for a given set of messages
“persist_io – Persistent IO Wrapper” (singleton) 3.0 Provides a non-volatile cache wrapper for any other IO wrapper “http_io – HTTP I/O Provider”
“pipe_io – Pipe IO Wrapper” (singleton) 3.0 Provides ability to writing content via an arbitrary program
“pipe_transport – Module” 3.0 Pipe messages to a local program
“postfix_logger – Postfix-Compatible Logging” 3.0 Log in Postfix format
“reception_timing – Reception Timing Modules” 3.6.6 Track how long it takes to receive or reject messages over SMTP “chunk_logger – Asynchronous Logging”
“response_transcode – Module” (singleton) 3.0 Work around broken remote servers
restinjector (singleton) 3.1 Activate the REST injection API
“sched – The Schedule Module” (singleton) 3.0 Schedule tasks to be run from the console “ds_core – Datasource Query Core”
“scriptlet – Module” 3.0 Enable scriptlets for enforcing policy “alerting – alerting”
“securecreds – Module” (singleton) 3.2 Use encrypted credentials throughout Momentum credmgr
“seedlist – Seedlist Integration” 3.0 Deliverability monitoring service
senderid 3.0 Use Sender Policy Framework (spf_v2) “scriptlet – Module”
“sendmail_logger – Sendmail-Compatible Logging” 3.0 Create Sendmail formatted logs
smpp (singleton) 3.0 Enable SMPP
smpp_bounce_logger 3.0 Enable SMPP bounce logging
smpp_logger 3.0 Log SMPP events
“smtp_auth_proxy – SMTP Authentication Proxy” 3.6.5 Allow edge SMTP servers to forward SMTP AUTH requests to SMTP servers
“smtp_cbv – SMTP Callback Verification” 3.0 Perform SMTP Callback Verification
“smtp_rcptto_proxy – SMTP Recipient-To Proxy” 3.6.5 Validate a Lua recipient by doing an SMTP call-forward
spf_macros (singleton) 3.0 Generic macro service for SPF
spf_v1 3.0 Use Sender Policy Framework “scriptlet – Module”
“static-routes – Static Routes” 3.6.5 Route traffic to a given server by IP address and port
“suppress_spool – Deferred Message Spooling” 3.0 Defer spool attempts
“syslog_io – The syslog_io Module” (singleton) 3.0 Use the syslog wrapper to write entries to the log
“tls_macros Module” 3.6.5 Provide several macros supporting custom logging of TLS-related data
“url_ripper – URL Extraction” 3.0 A toolkit for DNS-based content correlation

Receiving Modules

This section shows inbound modules. Modules are listed alphabetically with a brief description and with singleton and deprecated modules identified. If a singleton module is followed by a version number, that number identifies when that module became a singleton. The Auto column indicates whether a module is loaded automatically as required. Note: this applies only to modules in version 3.x. The Cluster column indicates whether a module is cluster-specific.

Name Version Description Auto Cluster Valid See Also
“antivirus – Antivirus Modules” 3.0 The antivirus framework “clamav – ClamAV”, “csapi – The Content Scanning API Module”
“auth_ds – Datasource based SMTP Authentication” (singleton) 3.0 Use a data source to authenticate an SMTP session “ds_core – Datasource Query Core”
“auth_radius – RADIUS based SMTP Authentication” (singleton) 3.0 Authenticate SMTP sessions via SMTP AUTH using RADIUS servers
“beik – BEIK Module” (singleton) 3.0 This module provides an in-process version of the brightmail module “brightmail – Brightmail Module”
“brightmail – Brightmail Module” 3.0 Check inbound mail against a Brightmail server
bzip2io (singleton) 3.0 bzip compression algorithm “compress_spool – Dynamic Spool Compression”
“cidrdb – CIDRDB” (singleton) 3.0 Expose scripting functions for checking IP addresses
“clamav – ClamAV” 3.0 Support for Clam AV “antivirus – Antivirus Modules”
“cloudmark – Cloudmark Authority Module” (singleton 3.4 ) 3.0 Support for the Cloudmark spam technology
“commtouch_ctasd – Commtouch_ctasd Module” 3.0 Spam protection technology
“compress_spool – Dynamic Spool Compression” (singleton) 3.0 Compress large messages before writing them to disk
“conntrol – Fine-Grained Connection Control” 3.0 Control how inbound connections are established
“csapi – The Content Scanning API Module” 3.0 Integration for Symantec content scanners
“delay_dsn – Delay DSN Generation” 3.0 Configure and send delay DSNs
dk_validate 3.0 Validate inbound mail checking domain keys signatures
dkim_validate 3.0 Validate inbound mail checking DKIM signatures
“eleven – Module” (singleton) 3.1 This module implements the eleven spam filter and categorization service
“fingerprint – Host Fingerprinting” 3.0 Perform passive OS fingerprinting
gzipio (singleton) 3.0 gzip compression algorithm “compress_spool – Dynamic Spool Compression”
“imageanalyzer – Module” 3.0 Support for the Image Analyzer engine
“inbound_audit – Inbound traffic analytics” (singleton 3.0.23 ) 3.0 Provide analytics on sending IPs “outbound_audit – Outbound traffic analytics”
“maildir – Maildir Delivery Support” 3.0 Store messages in maildir format as specified by qmail
“pipe_transport – Module” 3.0 Pipe messages to a local program
“reception_timing – Reception Timing Modules” 3.6.6 Track how long it takes to receive or reject messages over SMTP “chunk_logger – Asynchronous Logging”
senderid 3.0 Use Sender Policy Framework (spf_v2) “scriptlet – Module”
“smtp_cbv – SMTP Callback Verification” 3.0 Perform SMTP Callback Verification
spf_macros (singleton) 3.0 Generic macro service for SPF
spf_v1 3.0 Use Sender Policy Framework “scriptlet – Module”
“suppress_spool – Deferred Message Spooling” 3.0 Defer spool attempts

Sending Modules

This section shows outbound modules. Modules are listed alphabetically with a brief description and with singleton and deprecated modules identified. If a singleton module is followed by a version number, that number identifies when that module became a singleton. The Auto column indicates whether a module is loaded automatically as required. Note: this applies only to modules in version 3.x. The Cluster column indicates whether a module is cluster-specific.

Name Version Description Auto Cluster Valid See Also
“adaptive – Adaptive Delivery” (singleton) 3.0 Dynamically tune delivery options
“alias – Alias Expansion Module” 3.0 Rewrite recipient addresses “ds_core – Datasource Query Core”
apn (singleton) 3.5.4 Use this module to configure the Apple Push Notification service
apn_logger 3.5.4 Use this module to log Apple Push notifications
“bounce_logger – Momentum-Style Bounce Logging” 3.0 Log bounced messages
dk_sign 3.0 Attach domain keys signatures to outbound mail
dkim_sign 3.0 Attach DKIM signatures to outbound mail
“fbl – Feedback Loop Module” (singleton) 3.0 Manage feedback loop services
gcm (singleton) 3.5.4 Use this module to configure Google Cloud messaging
gcm_logger 3.5.4 Use this module to log Google Cloud messages
httpsrv (singleton) 3.1 The HTTP server required for using the REST injection API
“mail_loop – Mail Loop Detection” 3.0 Automatic suppression of potential mail loops
“outbound_audit – Outbound traffic analytics” 3.0 Provides time-series analytics on the behavior of receiving domains
“outbound_smtp_auth – Module” 3.6.12 Enables users to specify authentication parameters for a given set of messages
“response_transcode – Module” (singleton) 3.0 Work around broken remote servers
restinjector (singleton) 3.1 Activate the REST injection API
“seedlist – Seedlist Integration” 3.0 Deliverability monitoring service