DOCSEARCHbyAlgolia
Submit Docs

KumoMTA Documentation

repository·main·Indexed 19 days ago

https://github.com/kumocorp/kumomta

A high-performance, open-source Message Transfer Agent (MTA) designed for large-scale outbound email delivery in enterprise-grade environments. Features include DKIM signing and verification via kumo-dkim, Maildir interaction, AWS SigV4 signing for HTTP requests in Lua, and the tsa-daemon for automated traffic shaping and delivery suspensions based on delivery logs.

Tokens
499K
Snippets
1.7K
Records
2.3K
Agent score
66%

What's inside KumoMTA

  1. Overview of Traffic Shaping configuration and automation

    main

    The traffic shaping system in KumoMTA is organized into several functional areas:

    • Scoping: Using domain, egress source, and site name to target specific rules.
    • MX Rollups & Provider Blocks: Mapping domain entries to site names and using pattern-based matching for MX records.
    • Configuration Files: Using the shaping.lua helper with TOML/JSON files to define rules.
    • Option Resolution: Understanding the precedence and merging logic when multiple configuration layers apply.
    • Custom Shaping: Writing custom rules to supplement or replace defaults.
    • Automation: Using the TSA daemon for real-time adjustments based on remote host feedback.
    • Testing: Using the validate-shaping tool to check syntax.

  2. What is KumoMTA?

    main
    KumoMTA is an open-source Message Transfer Agent (MTA) purpose-built for high-performance outbound email. Unlike traditional MTAs that are often modified legacy systems, KumoMTA was designed from the ground up using modern technology to meet the requirements of the world's largest email senders.

  3. Overview of Traffic Shaping Automation Daemon (tsa-daemon)

    main

    The tsa-daemon is a service designed to automate traffic shaping and delivery suspensions in KumoMTA by ingesting delivery logs and applying user-defined rules. It monitors log patterns and automatically triggers actions to mitigate issues like spam or high-volume delivery spikes.

    Ingestion Methods

    tsa-daemon accepts delivery logs via:

    • HTTP
    • AMQP (subscribing to a specific log topic)

    Rule Matching and Triggering

    Rules are applied based on:

    • Matching Criteria:
      • DSN (from the log record) matched via regex.
      • Bounce Classification strings.
      • Scoping by destination domain name or site name.
    • Triggering Criteria:
      • A specific number of events occurring within a defined time window.
      • Immediate triggering upon a match.

    Available Actions

    When a rule is triggered, the daemon can:

    • Suspend delivery to a destination domain or site name for a specified duration.
    • Generate traffic shaping configuration overrides for a domain or site name for a specified duration.
    • Clear traffic shaping configuration overrides for a domain or site name.

  4. Overview of KumoMTA

    main

    KumoMTA is an open-source Message Transfer Agent (MTA) optimized for high-performance outbound email delivery. It is designed as a high-performance alternative to commercial enterprise MTAs like Momentum, PowerMTA, and Halon.

    Target Audience: KumoMTA is intended for experienced email operations professionals and DevOps practitioners managing high-volume sending environments.

  10. Explore KumoMTA integrations

    main

    KumoMTA integrates with various partner and adjacent systems for campaign management, reporting, data feeds, and anti-virus/anti-spam (AV/AS) capabilities. These integrations range from Free and Open Source Software (FOSS) to paid professional services and third-party tools.

    Available integration categories include:

    • Campaign Management: Ongage, Mautic Marketing Automation, and EmailElement.
    • Reporting UIs: Postmastery Console, Tatami Monitor, and Grafana Dashboard.
    • Data Feeds: Prometheus Metrics Monitor.
    • AV/AS (Anti-Virus/Anti-Spam): Hornetsecurity Spam and Malware protection, and Rspamd.