Home
Platform
Our Platform
Reliability
Signals
Deliverability
PowerMTA
Recipient Validation
Inbox Tracker
Security and Privacy
Competitive Tracker
Email API & Integration
Industries
Featured Case Studies
Enterprise SaaS
Financial Services
FinTech
MarTech
Learn
AMP for Email
Email 101
Email Templates
Email Tools
SparkPost Academy
Support
Blog
Login
Contact Us
See Pricing
See Pricing
Home
Platform
Our Platform
Signals
PowerMTA
Recipient Validation
Deliverability
Reliability
Security and Privacy
Email API & Integration
Industries
Featured Case Studies
Enterprise SaaS
Financial Services
FinTech
MarTech
Learn
Learn With SparkPost
AMP for Email
Email 101
Email Templates
Email Tools
SparkPost Academy
Blog
Support
Contact Us
Login
Your Dashboard
Login
Try Now
Momentum Documentation
Momentum 4.x
Preface
Typographical Conventions Used in This Document
Introduction to Momentum
Components
Life of A Message
Roles and Behaviors
Licensed Features
Message Generation
Adaptive Delivery
Supercharger
Installing Momentum
Hardware Considerations
Server Roles
Configuration Options
Hardware Scaling Approach
Environmental Considerations
Hardware Deployment Configuration
Production Environment Configurations
Additional Configuration Notes
Before You Begin
Momentum License
Operating System
Redundancy
Load Balancing
Disable SELinux
Enable Network Time Protocol (NTP)
Adjusting /etc/sysctl.conf
Setting Hostnames
Java Runtime Environment (JRE)
Creating root and vertica_dba Accounts
Redefining Ephemeral Ports
Configuring Locale
Configuring SSH and SSHD
Basic Required Packages
Riak Provisioning
Separate Vertica Partition
Disable Postfix and QPIDD
Verifying Analytics Node Requirements
Download the Software Bundle and Prepare
Install / Upgrade the Packages
New Installation - All Configurations
Configure Your MTA Nodes
Configure the Cassandra Nodes
Configure the Analytics Nodes
Start Remaining Services
Upgrade - Single Node
Preparation
Vertica Updates
Prepare and Run Flyway
Configuration Changes
Software Upgrade
Update Web UI Configuration
Start Services
Complete the Software Set Up
Next Steps
Rolling Upgrade - Two-Tier Configuration and Combined Node
Overview
Before You Begin the Upgrade
Perform a Cassandra Snapshot
Upgrade Cassandra on the Platform Nodes
Stop Transmissions to the First Platform Node
Upgrade Ecelerity and the Cassandra Schema on the First Platform Node
Restore Transmissions to the First Platform Node and Stop Transmissions to all other Platform Nodes
Upgrade Ecelerity on the Remaining Platform Nodes
Restore Transmissions to the Remaining Platform Nodes
Upgrade Vertica on the Analytics Nodes
Prepare and Run Flyway
Upgrade Remaining RPMs on Analytics Nodes
Configuration Changes
Install the Adaptive Delivery API
Update the Web UI Configuration
Start Services
Complete the Software Set Up
Post-Installation
Installing Partner Modules
Reviewing Configuration Files
Rotating Logfiles
Download and Install the Vertica Management Console
Upgrading the Vertica License
Security Considerations
Adding and Removing Platform Nodes
Adding a Platform Node
Removing a Platform Node
Adding and Removing Analytics Nodes
Adding an Analytics Node
Removing an Analytics Node
Configuring Momentum
Configuration Overview
Configuration Files
Configuration Options
Configuration Scopes and Fallback
Listeners
Modules
ecelerity.conf File
Cluster-specific Configuration
Cluster-specific Configuration Files
eccluster.conf File
ecelerity-cluster.conf File
msgc_server.conf File
Cluster-specific Listeners
Configuring Momentum for High Availability and Failover
Configuring Riak in a Cluster
Configuring Momentum's System Console
Control_Listener Configuration
Control_Listener Authentication
Control_Listener Accounting
Control_Listener Authorization
Configuring Inbound Mail Service Using ECStream
ECStream_Listener Configuration
Configuring Inbound Mail Service Using SMTP
ESMTP_Listener Configuration
Inbound Email Relay or Gateway
Reconfig_Message Option
SMTP Extensions
ESMTP_Listener Authentication
Inbound SSL
Inbound TLS
Configuring Inbound Mail Service Using HTTP
HTTP_Listener Configuration
msg_gen.conf File
Enforcing REST API/UI User Authentication
Using Yahoo! DomainKeys
DomainKeys Signing
DomainKeys Validation
Using DomainKeys Identified Mail (DKIM) Signatures
DKIM Signing
DKIM Validation
Configuring Multiple Event Loops
Configuring Outbound Mail Delivery
Routing Mail
Prohibited_Hosts
MultiVIP© Interfaces
Throttling and Traffic Shaping
Outbound TLS
Outbound XCLIENT support
Outbound Email Relay
Log Aggregation
Configuring Log Aggregation
Centralized Logging Example
Complex Centralized Logging Deployments
Redundant Logs
Decommissioning a Log Aggregator
DuraVIP™: IP Fail over
IP Addresses and duravip_follow
duravip_follow and the #mmove Binding
Address Resolution Protocol (ARP) traffic
DuraVIP™ Configuration Conflicts and Ambiguities
Data Replication
Replication Configurations
PostgreSQL
PostgreSQL Overview
Running the PostgreSQL Server
Using the PostgreSQL Client Program
Dumping and Restoring the Database
Riak
Riak Overview
Running the Riak Service
Riak Ports
Backups
Configuring the Environment File
Logging
Logging Overview
Log Files
Logging Configuration
Log Monitoring
Rotating Logs ec_rotate
ec_rotate.conf File
Log Formats
acctlog
adaptive Log
bouncelog
fbllog
httplog
importlog
mainlog
paniclog
rejectlog
Bounce Classification Codes
Connection Stages
Using the System Console
Starting Momentum (ecelerity)
Startup Scripts
Using the System Console (ec_console)
Connecting to the Console
Console Commands
Using Module-Specific Console Commands
Setting and Getting Module Options from the Console
Creating Custom Console Commands
Using the Cluster Manager (eccmgr)
Connecting to the Console on the Cluster Manager
Console Commands for the Cluster Manager
CIDR Server
cidr_cli Utility
SMTP Injection
Adjusting your Client Mail Application
Tracking Engagement for SMTP
Introduction
Using the X-MSYS-API Header for Engagement Tracking
Using Policy for Engagement Tracking
Escaping {{ and }} in SMTP Message Body
Reporting Options
Message Generation (HTTP)
Creating an API Key
Managing Your API Keys
Viewing Your API Keys
Creating an API Key
Updating an API Key
Deleting an API Key
Generating a Transmission
Using Substitution Data
Creating Stored Templates
Managing Your Templates in the UI
Viewing Your Templates
Creating a Template
Previewing and Testing Your Template
Updating Your Template
Publishing Your Template
Deleting a Template
Using Stored Templates
Creating Stored Recipient Lists
Managing Recipient Lists using the UI
Using Stored Recipient Lists
Sending Emails as CC and BCC
Using Complex Templates
Reporting and Engagement Tracking
Reporting Options
Getting Started with the Web-based User Interface
Recipient Lists
Using the UI for Reporting
Reports and Engagement Tracking in the UI
Selecting Your Metrics and Filters
Viewing Your Reports
Adaptive Delivery Report
Evaluating Your Campaign Performance
Using the Metrics API for Reporting
Using Webhooks for Event Data
Managing Your Webhooks in the UI
Viewing Your Webhooks
Creating a Webhook
Testing Your Webhook
Updating Your Webhook
Deleting a Webhook
Tracking Engagement for HTTP
Writing Policy
Implementing Policy with Momentum
Validation and the Validation Context
Policy Scriptlets
Validation Context Variables
Connection Context Variables
Message Context Variables
Reference
Lua Functions Summary
Modules Summary
Configuration Options Summary
Console Commands Summary
Executable Command Summary
Hook Points and C Functions Reference
Lua Functions Reference
Modules Reference
Configuration Options Reference
Non-Module-Specific Console Commands
Executable Commands Reference
Appendix
Message Responses
Responses Sorted By Codes
MIB Files
1.3.6.1.4.1.19552.1.2 – Per-domain Metrics
Per-group (binding) Metrics, 1.3.6.1.4.1.19552.1.3
The OMNITI-SNMP-MIB.txt file
SMTP Response Codes
Key Binding Reference for ec_console
Editor Commands
Extended Commands
Glossary
Copyright Notices
Acknowledgements
Disclaimers for Redistributed Third-Party Software
Momentum 3.x
Momentum Reference Manual
Preface
Typographical Conventions Used in This Document
Configuration Guide
Installation
System Requirements
Ports Used by Momentum
Security Considerations
Preparing the System
Operating System Specific Preparation
Installation on Linux
Installation on Solaris
Installer Options
Installing Additional Packages
Riak Server
Performing a Stand-alone Installation
Installing a Cluster
Configuration
The ecelerity.conf File
Authentication, Authorization and Accounting
Setting Up Active Directory Authentication With Momentum 3.2.2
Configuring for Multiple Event Loops in Momentum 3.6
Options that Must Change
Configuration Scopes and Fallback
The Momentum Configuration Server: ecconfigd
Best Practices for Manually Changing Configuration Files
Best Practices for Adding Configuration Files
Starting Momentum
Testing Your Installation
Using the Web Console
Starting the Web Console
Web Console Overview
The Dashboard
Cluster Status
Filtering
The Reporting Page
The Paths Page
Administration
Administering Users From the Web Console
The Policy Configuration Editor
Automated Alerting Configuration
Operations
The Momentum System Console
Console Commands
PostgreSQL
Riak
Logging
MultiVIP© Interfaces
Implementing Policy with Momentum
Validation and the Validation Context
Implementing Policy Using Scriptlets
Default Policy Scriptlets
Implementing Policy Using Sieve
Setting Context Based on Connecting IP
Best Practices for Manually Created Policy Scripts
Conclusion
Validation Context Variables
Connection Context Variables
Message Context Variables
Clustering
Subclusters
Configuration Management
Message Bus
Cluster Deployment
DuraVIP™: IP Fail over
Log Aggregation
Data Replication
Using the Cluster Manager
Configuring Momentum for High Availability and Failover
The cidr_server
Sieve++
The differences between Sieve and Sieve++
Sieve's Basic Syntax
RFC Standard Sieve Enhancements
Sieve++, Momentum-specific extensions
Command Reference
Ecelerity.conf Configuration Reference
Options Summary
Configuration Files and Option Details
Cluster Configuration Reference
Momentum Command Line Reference
Executable Command Summary
Executable Commands
Momentum System Console Commands Reference
System Console Command Summary
System Console Commands
Modules
Module Overview
Summary Module Information
Module-Specific Console Commands
Using Module-Specific Console Commands
Modules Reference
Lua Function Reference
Lua Functions List
Lua Functions
Sieve++ Function Reference
Sieve Function Summary
Sieve Function Details
Appendices
Frequently Asked Questions
MIB Files
1.3.6.1.4.1.19552.1.2 – Per-domain Metrics
Per-group (binding) Metrics, 1.3.6.1.4.1.19552.1.3
The OMNITI-SNMP-MIB.txt file
SMTP Response Codes
Example LDAP webui-common.conf File
Log Formats
Log Formats for Version 3.x
Bounce Classification Codes
Connection Stages
Message Responses
Responses Sorted By Codes
Responses Sorted by Message
Key Binding Reference for ec_console
Default emacs key bindings
Editor Commands
Extended Commands
Disclaimer
Acknowledgements
Disclaimers for Redistributed Third-Party Software
Copyrights
Acronyms
Glossary
Momentum for Mobile Push Notifications
Preface
Configuring Momentum for Apple Push Notification service (APNs)
APNs Options
APNs-specific Configuration Option
Other Configuration Options Used with APNs
APN Modules
apn Module
The apn_logger Module
Using APNs
Message Injection and the APNs Payload
Disabling APNs
APNs and Lua
Lua Callouts
Maintaining APNs Recipient Lists
Apple Status Codes
Configuring Momentum for Google Cloud Messages (GCM)
GCM Options
GCM-specific Configuration Options
Other Configuration Options Used with GCM
GCM Modules
gcm Module
gcm_logger Module
Using GCM
Message Injection and the GCM Payload
Disabling GCM
GCM and Lua
Lua Callouts
GCM Status Codes
Generic HTTP Delivery and Push
Callouts and Push Notifications
generic_delivery_msg_dispose
http_request_eval
http_response_eval
Glossary
Default Policy User Guide
Preface
Enabling the Policy Scripts
Configuration Items
Use Cases
Policy Categories
Configuration Details
msys.dp_config.whitelist
msys.dp_config.rbls
msys.dp_config.early_talker
msys.dp_config.fcdns
msys.dp_config.concurrent_connection_limits
msys.dp_config.audit_series
msys.dp_config.audit_series.invalid_smtp_auth
msys.dp_config.audit_series.connections
msys.dp_config.audit_series.mailfrom
msys.dp_config.audit_series.auth_user
msys.dp_config.mail_from_domain_validate
msys.dp_config.recipient_validation
msys.dp_config.relay_authorization
msys.dp_config.audit_series.invalid_recipients
msys.dp_config.audit_series.messages
msys.dp_config.audit_series.spam_mailfrom
msys.dp_config.audit_series.spam
msys.dp_config.audit_series.virus
msys.dp_config.audit_series.virus_mailfrom
msys.dp_config.message_size_limits
msys.dp_config.beik
msys.dp_config.commtouch
msys.dp_config.cloudmark
msys.dp_config.antivirus
msys.dp_config.keyword_filter
Customizing Policy
The dp_config.lua and custom_policy.lua Files
The dp_config.lua File
The custom_policy.lua File
Adaptive Delivery User Guide
What Does Adaptive Delivery Do?
Implementing Adaptive Delivery
Setting up Adaptive Delivery
Adaptive Rules
Receivers Managed by Adaptive Rules
Parameters Adjusted by the Rules
Rule Actions
Custom Rules
Sample Custom Configurations
Automated Updates for the Adaptive Rules
Manually Installing New Rules
Using a Proxy Server
Sweep Rules – Configuring Bounce and FBL Behavior
Troubleshooting
Logs, Alerts and Summaries
Using the System Console
Adaptive Options
Adaptive Executables and Console Commands
Adaptive Logs
The adaptive_rules.lua File
The Momentum REST Injector
Overview
Configuring Momentum to Use the Injector
The httpsrv and restinjector Modules
HTTP_Listener
Template Files
Using the API
Momentum API Reference (3.x)
Preface
Typographical Conventions Used in This Document
Momentum Architecture
Momentum Architecture Overview
Introduction
General Architecture Overview
Primary Momentum APIs
Secondary Momentum APIs
C API
Adaptive Functions
AV/Scanning Functions
Audit Series Functions
Bag Functions
Base64 Encode/Decode and Related Functions
Blobject Functions
Bounce Functions
Buffer Functions
CIDR Functions
Configuration Functions I (binding/domain)
Configuration Functions II
Connection-related Functions
Control Functions
Conversion
Datasource Functions
Debug Functions
Dictionary Functions
DKIM/DK Functions
DNS Functions
ec_cache Functions
ec_double Functions
echash Functions
Event Functions
Fast Cache Functions
File-related Functions
httpclnt Functions
httpsrv Functions
Interpolation Functions
io_wrapper Functions
Logging Functions
Mail Queue Functions
Memory Functions
Message Functions
Miscellaneous Functions
Module Configuration Functions
Module-related Functions
Netlistener Functions
Pointer Array Functions
RFC Functions
Scheduler Functions
Scriptlet (and Alerting) Functions
Security
Sieve Functions
Skiplist Functions
SMPP Functions
SMTP-related Functions
Socket Address Functions
Spool-related Functions
SSL Functions
String Functions
Threadpool Functions
Throttle Functions
Time Series Functions
Utility Functions
Validation Context Functions
XMPP Functions
Hooks
Hooks in the apn Scope
Hooks in the cluster Scope
Hooks in the core scope
Hooks in the delay_dsn Scope
Hooks in the gcm Scope
Hooks in the generic_delivery and httpclnt Scope
Hooks in the msgc Scope
Hooks in the publish Scope
Hooks in the restinj Scope
Hooks in the sieve scope
Structs
Structs
Custom Delivery Modules
Overview
Momentum Modules
Custom Delivery Module Setup
Custom Callback Functions
Compiling in C
Momentum Mobile
Reference Manual
Preface
Typographical Conventions Used in This Document
Mobile Momentum SMPP
Overview of Mobile Momentum
Architecture
The Short Message Peer-to-Peer Protocol (SMPP) ESME Module
Message Conversions, Transformations, and Mappings
Installing Momentum
Mobile Momentum SMPP
The smpp Modules
Persistent Connections
Throttling
SMPP Caveats
smpp_logger Module Configuration
The smpp_bounce_logger Module
Message Context Variables
SMS Conversion Hook Points
Mobile Momentum SMPP Options
SMPP Configuration Option Details
Use Cases
Route to SMS Matching a Regex in the Subject Header
Route to SMS Based on the Recipient Address
Route to SMS Based on the Sender IP Address
Route to SMS Based on the Sender Address
SMPP Configuration Best Practices
SMSC Bind Parameters
Message Conversion Parameters
SMPP Timer Parameters
Delivery Receipts
Persistent Connections
SMS to Email Address Mappings
Throttling
SMPP Logging
Message Mode
FAQ
Configuration
Domains
Mobile Momentum MMS
Mobile Momentum MM7
The mm7_serv Module
The mms_logger Module
The mms_bounce_logger Module
Multi Protocol Domain Naming
The MCMT_Reception option
Listener Configuration for MCMT
Aggregator-specific Requirements
Configuration for MM7
Mobile Momentum MM7 Options
MM7 Configuration Option Details
Aggregator APIs
The mBlox API
Mobile Momentum XMPP
Mobile Momentum XMPP
The XMPP Module and Listener
The XMPP Logger Module
Roster and Presence
Lua XMPP Functions
Converting MCMT to XMPP
Filtering Out Chat State Notifications
Retrying Messages
Retrying Messages
The mstore Module
Message Retention
Glossary
Acronyms
Command Status Codes
SMPP PDU Operation Definitions
Quick Start
Overview
Installing Mobile Momentum
Configuring the Mobile Momentum Modules
The SMPP Modules
The MM7 Modules
Configuring for Web UI Stats
Configuration Options in the Global, Domain and Binding Scopes
SMPP-specific Configuration
MM7-specific Configuration
Bare Bones Configurations
Developer Guide
Customization
Overview
Developing Applications for Mobile Momentum 2.1
Developing Applications for the SMPP ESME
Developing Applications for the MM7 VASP
SMPP Hooks
SMPP Delivery Receipt Evaluation Hook
Purpose
Interface
Examples
SMPP Log Inband Bounce Hook
Purpose
Interface
Examples
SMPP Log Outband Bounce Hook
Purpose
Interface
Examples
SMPP Log Transient Bounce Hook
Purpose
Function Interface
Examples
SMPP Log Conversion Hook
Purpose
Interface
Examples
SMPP Log Delivery Hook
Purpose
Interface
Examples
SMPP Log Permfail Hook
Purpose
Interface
Examples
SMPP Log Reception Hook
Purpose
Interface
Examples
SMPP Logger Status Hook
Purpose
Interface
Examples
SMPP Log Tempfail Hook
Purpose
Interface
Examples
SMPP MO Conversion Hook
Purpose
Interface
Examples
SMPP MT Conversion Hook
Interface
Examples
SMPP PDU MO (Receiver) Evaluation Hook
Purpose
Interface
Examples
SMPP PDU MT (Transmit) Evaluation Hook
Purpose
Interface
Examples
SMPP Received Message Validation Hook
Purpose
Interface
Examples
SMPP Submit Response Hook
Purpose
Interface
Examples
MM7 Hooks
MM7 MT Submit Request Hook
Purpose
Interface
Examples
MM7 MT Submit Response Hook
Purpose
Interface
Examples
MM7 Log Inband Bounce Hook
Purpose
Interface
Examples
MM7 Log Outband Bounce Hook
Purpose
Interface
Examples
MM7 Log Transient Bounce Hook
Purpose
Interface
Examples
MM7 Log Conversion Hook
Purpose
Interface
Examples
MM7 Log Delivery Hook
Purpose
Interface
Examples
MM7 Log Permfail Hook
Purpose
Interface
Examples
MM7 Log Reception Hook
Purpose
Interface
Examples
MM7 Logger Status Hook
Purpose
Interface
Examples
MM7 Log Tempfail Hook
Purpose
Interface
Examples
MM7 Server Received Message Hook
Purpose
Interface
Examples
MM7 Server Received Message Validation Hook
Purpose
Interface
Examples
The Multi-Channel Message Type (MCMT)
The Multi-Channel Message Type (MCMT)
The MCMT Format
Changelog
Momentum 4.x Changelog
Momentum 4.3.1 Changelog
Momentum 4.3.0 Changelog
Momentum 4.2.40 Changelog
Momentum 4.2.38 Changelog
Momentum 4.2.31 Changelog
Momentum 4.2.28 Changelog
Momentum Legacy Changelogs
Momentum 4.x Legacy Changelog
Momentum 3.x Legacy Changelog from 2013-2016
Momentum 3.x Legacy Changelog from 2011-2012
Momentum 3.x Legacy Changelog from 2009-2010
Momentum 2.x Legacy Changelog from 2009-2013
Momentum 2.x Legacy Changelog for 2008
Momentum 2.x Legacy Changelog for 2007
Momentum 2.x Legacy Changelog from 2003-2006
Message Central Legacy Changelog
Message Scope Legacy Changelog
Community
Email Tools
Customers
Developer Blog
Developer Hub
Service Status
Examples
March 26, 2020
Print
Edit
For an example see
SMPP Log Tempfail Hook
.
Function Interface
SMPP Log Conversion Hook
