Skip to content
KumoMTA Docs
Reference Manual
Initializing search
KumoCorp/kumomta
Tutorial
User Guide
Reference Manual
FAQ
Changelog
KumoMTA Docs
KumoCorp/kumomta
Tutorial
Tutorial
Quickstart Tutorial
Server Environment
System Preparation
Installing KumoMTA
Configuring KumoMTA
Starting KumoMTA
Testing KumoMTA
Checking Logs
Next Steps
User Guide
User Guide
General
General
Preface and Legal Notices
About This Manual
How to Report Bugs
How to Get Help
Credits
History
Architecture
Lua Fundamentals
Installation
Installation
Installation Overview
Deployment Architecture
Server Environment
Server Hardware
Operating System
System Preparation
Installing on Linux
Upgrading
Installing on Docker
Building from Source
Configuration
Configuration
Configuration Concepts
Lua Policy Helpers
Example Server Policy
Configuring Spooling
Configuring Logging
Configuring SMTP Listeners
Configuring Inbound and Relay Domains
Configuring Bounce Classification
Configuring Feedback Loop Processing
Configuring HTTP Listeners
Configuring Sending IPs
Configuring Queue Management
Configuring Traffic Shaping
Configuring Traffic Shaping Automation
Configuring DKIM Signing
Operation
Operation
Starting KumoMTA
Getting Server Status
Troubleshooting KumoMTA
Injecting Messages using SMTP
Injecting Messages using HTTP
Routing Messages Via Proxy Servers
Viewing Logs
Canceling Queued Messages
Performance Tuning
Additional Utilities
Using the kcli Command-Line Client
KumoProxy SOCKS5 Server
Policy
Policy
Checking Inbound SMTP Authentication
Delivering Messages Using SMTP Auth
Custom Destination Routing
Routing Messages via HTTP Request
Routing Messages via AMQP
Routing Messages via Kafka
Storing Secrets in Hashicorp Vault
Publishing Log Events Via Webhooks
Integrations
Integrations
Ongage
Prometheus
Reference Manual
Reference Manual
Predefined Metadata
Queues
module: kumo
module: kumo
available_parallelism
configure_accounting_db_path
configure_bounce_classifier
configure_local_logs
configure_log_hook
configure_redis_throttles
define_spool
glob
json_encode
json_encode_pretty
json_load
json_parse
make_egress_path
make_egress_pool
make_egress_source
make_listener_domain
make_queue_config
make_throttle
memoize
on
read_dir
reject
set_diagnostic_log_filter
set_max_lua_context_age
set_max_lua_context_use_count
set_max_spare_lua_contexts
sleep
spawn_task
start_esmtp_listener
start_http_listener
toml_encode
toml_encode_pretty
toml_load
toml_parse
uncached_glob
module: kumo.amqp
module: kumo.amqp
build_client
module: kumo.api.inject
module: kumo.api.inject
inject_v1
module: kumo.digest
module: kumo.digest
sha1
sha256
sha384
sha512
sha512_256
module: kumo.dkim
module: kumo.dkim
ed25519_signer
rsa_sha256_signer
module: kumo.dns
module: kumo.dns
configure_resolver
lookup_addr
lookup_mx
module: kumo.encode
module: kumo.encode
base32_decode
base32_encode
base32_nopad_decode
base32_nopad_encode
base32hex_decode
base32hex_encode
base32hex_nopad_decode
base32hex_nopad_encode
base64_decode
base64_encode
base64_nopad_decode
base64_nopad_encode
base64url_decode
base64url_encode
base64url_nopad_decode
base64url_nopad_encode
hex_decode
hex_encode
module: kumo.cidr
module: kumo.cidr
make_map
module: kumo.domain_map
module: kumo.domain_map
new
module: kumo.http
module: kumo.http
Request
Response
build_client
build_url
connect_websocket
module: kumo.kafka
module: kumo.kafka
build_producer
module: kumo.regex_set_map
module: kumo.regex_set_map
new
module: kumo.secrets
module: kumo.secrets
load
module: kumo.shaping
module: kumo.shaping
load
module: redis
module: redis
open
module: sqlite
module: sqlite
open
module: tsa
module: tsa
configure_tsa_db_path
start_http_listener
object: address
object: address
domain
email
user
object: addressheader
object: addressheader
domain
email
list
name
user
object: authenticationresult
object: connectionmeta
object: keysource
object: message
object: message
add_authentication_results
append_header
append_text_html
append_text_plain
check_fix_conformance
dkim_sign
dkim_verify
from_header
get_address_header
get_all_headers
get_all_named_header_values
get_data
get_first_named_header_value
get_meta
id
import_scheduling_header
import_x_headers
num_attempts
parse_rfc3464
prepend_header
queue_name
recipient
remove_all_named_headers
remove_x_headers
save
sender
set_data
set_due
set_force_sync
set_meta
set_recipient
set_scheduling
set_sender
to_header
events
events
get_egress_path_config
get_egress_pool
get_egress_source
get_listener_domain
get_queue_config
http_message_generated
http_server_validate_auth_basic
init
pre_init
requeue_message
should_enqueue_log_record
smtp_client_rewrite_delivery_status
smtp_server_auth_plain
smtp_server_ehlo
smtp_server_mail_from
smtp_server_message_received
smtp_server_rcpt_to
spool_message_enumerated
throttle_insert_ready_queue
tsa_init
tsa_load_shaping_data
HTTP API Explorer
HTTP API
HTTP API
`DELETE /api/admin/bounce/v1`
`GET /api/admin/bounce/v1`
`POST /api/admin/bounce/v1`
`POST /api/admin/set_diagnostic_log_filter/v1`
`POST /api/inject/v1`
`GET /metrics.json`
`GET /metrics`
Internal Rust API
Internal Rust API
bounce_classify
cidr_map
config
data_loader
dns_resolver
domain_map
duration_serde
kumo_api_types
kumo_chrono_helper
kumo_dkim
kumo_log_types
kumo_server_common
kumo_server_lifecycle
kumo_server_memory
kumo_server_runtime
lruttl
maildir
mailparsing
message
mod_amqp
mod_digest
mod_dns_resolver
mod_encode
mod_filesystem
mod_http
mod_kafka
mod_memoize
mod_redis
mod_sqlite
mta_sts
regex_set_map
rfc5321
spool
throttle
timeq
version_info
FAQ
FAQ
What Is KumoMTA?
Who is KumoMTA For?
How Can I Get Help With KumoMTA?
Is There a SaaS Version of KumoMTA?
How Do I Resolve a `Permission Denied` Error?
How Can I Apply Multiple DKIM Signatures to a Message?
How Can I Test TLS Message Injection?
How Do I Configure POP3/IMAP?
Why is KumoMTA Accepting Connections From Systems Not Listed in relay_hosts?
Can I Migrate From PowerMTA to KumoMTA?
Can I Migrate From Momentum (Ecelerity) to KumoMTA?
Changelog
Changelog
Unreleased Changes in The Mainline
Release 2023.12.28-63cde9c7
Release 2023.11.28-b5252a41
Release 2023.08.22-4d895015 - Automation
Release 2023.06.22-51b72a83
Release 2023.05.10-e88ad036 - Beta 2
Release 2023.03.31-36aa20de - Beta1
Reference
This section contains reference documentation
Back to top