Skip to content

KumoMTA Docs

schemas

Initializing search

KumoCorp/kumomta

Tutorial
User Guide
Reference Manual
FAQ
Changelog

KumoMTA Docs

KumoCorp/kumomta

Tutorial
Tutorial
User Guide
User Guide
- General
  General
- Installation
  Installation
- Configuration
  Configuration
- Operation
  Operation
- Policy
  Policy
- Clustering
  Clustering
- Performance
  Performance
- Integrations
  Integrations
Reference Manual
Reference Manual
- Predefined Metadata
- Queues
- Configuration Lifecycle
- SMTP Server Events
- Memory Management
- Template Syntax
  Template Syntax
- Log Record
- Access Control
- kcli
  kcli
- module: kumo
  module: kumo
  - apply_supplemental_trace_header
  - available_parallelism
  - bump_config_epoch
  - configure_accounting_db_path
  - configure_bounce_classifier
  - configure_local_logs
    
    configure_local_logs
    
    back_pressure
    
    compression_level
    
    filter_event
    
    headers
    
    log_dir
    
    max_file_size
    
    max_segment_duration
    
    meta
    
    min_free_inodes
    
    min_free_space
    
    per_record
  - configure_log_hook
  - configure_redis_throttles
  - define_spool
    
    define_spool
    
    flush
    
    kind
    
    min_free_inodes
    
    min_free_space
    
    name
    
    path
    
    rocks_params
  - disconnect
  - eval_config_monitor_globs
  - generate_rfc3464_message
  - get_memory_hard_limit
  - get_memory_low_thresh
  - get_memory_soft_limit
  - glob
  - inject_message
  - invoke_get_egress_path_config
  - invoke_get_egress_pool
  - invoke_get_egress_source
  - invoke_get_queue_config
  - json_encode
  - json_encode_pretty
  - json_load
  - json_parse
  - log_debug
  - log_error
  - log_info
  - log_warn
  - make_egress_path
    
    make_egress_path
    
    additional_connection_limits
    
    additional_message_rate_throttles
    
    additional_source_selection_rates
    
    allow_smtp_auth_plain_without_tls
    
    banner_timeout
    
    connect_timeout
    
    connection_limit
    
    consecutive_connection_failures_before_delay
    
    data_dot_timeout
    
    data_timeout
    
    dispatcher_wakeup_strategy
    
    ehlo_domain
    
    ehlo_timeout
    
    enable_dane
    
    enable_mta_sts
    
    enable_pipelining
    
    enable_rset
    
    enable_tls
    
    idle_timeout
    
    ignore_8bit_checks
    
    low_memory_reduction_policy
    
    mail_from_timeout
    
    maintainer_wakeup_strategy
    
    max_connection_rate
    
    max_deliveries_per_connection
    
    max_message_rate
    
    max_ready
    
    max_recipients_per_batch
    
    no_memory_reduction_policy
    
    openssl_cipher_list
    
    openssl_cipher_suites
    
    openssl_options
    
    opportunistic_tls_reconnect_on_failed_handshake
    
    prohibited_hosts
    
    rcpt_to_timeout
    
    reconnect_strategy
    
    refresh_interval
    
    refresh_strategy
    
    remember_broken_tls
    
    rset_timeout
    
    rustls_cipher_suites
    
    skip_hosts
    
    smtp_auth_plain_password
    
    smtp_auth_plain_username
    
    smtp_port
    
    source_selection_rate
    
    starttls_timeout
    
    suspended
    
    system_shutdown_timeout
    
    tls_certificate
    
    tls_prefer_openssl
    
    tls_private_key
    
    try_next_host_on_transport_error
    
    use_lmtp
  - make_egress_pool
    
    make_egress_pool
    
    entries
    
    name
    
    ttl
  - make_egress_source
    
    make_egress_source
    
    ehlo_domain
    
    ha_proxy_server
    
    ha_proxy_source_address
    
    name
    
    remote_port
    
    socks5_proxy_server
    
    socks5_proxy_source_address
    
    source_address
    
    ttl
  - make_listener_domain
    
    make_listener_domain
    
    log_arf
    
    log_oob
    
    relay_from
    
    relay_to
  - make_message
  - make_queue_config
    
    make_queue_config
    
    egress_pool
    
    max_age
    
    max_message_rate
    
    max_retry_interval
    
    protocol
    
    reap_interval
    
    refresh_interval
    
    refresh_strategy
    
    retry_interval
    
    shrink_policy
    
    strategy
    
    timerwheel_tick_interval
  - make_throttle
  - memoize
  - on
  - read_dir
  - reject
  - set_config_monitor_globs
  - set_diagnostic_log_filter
  - set_httpinject_recipient_rate_limit
  - set_httpinject_threads
  - set_logging_threads
  - set_lruttl_cache_capacity
  - set_max_lua_context_age
  - set_max_lua_context_use_count
  - set_max_spare_lua_contexts
  - set_memory_hard_limit
  - set_memory_low_thresh
  - set_memory_soft_limit
  - set_qmaint_threads
  - set_ready_qmaint_threads
  - set_readyq_threads
  - set_smtpsrv_threads
  - set_spoolin_threads
  - sleep
  - spawn_task
  - start_esmtp_listener
    
    start_esmtp_listener
    
    allow_xclient
    
    banner
    
    batch_handling
    
    client_timeout
    
    data_buffer_size
    
    data_processing_timeout
    
    deferred_queue
    
    deferred_spool
    
    hostname
    
    invalid_line_endings
    
    line_length_hard_limit
    
    listen
    
    max_connections
    
    max_message_size
    
    max_messages_per_connection
    
    max_recipients_per_message
    
    meta
    
    peer
    
    relay_hosts
    
    require_proxy_protocol
    
    tls_certificate
    
    tls_private_key
    
    tls_required_client_ca
    
    trace_headers
    
    via
  - start_http_listener
    
    start_http_listener
    
    hostname
    
    listen
    
    request_body_limit
    
    tls_certificate
    
    tls_private_key
    
    trusted_hosts
    
    use_tls
  - toml_encode
  - toml_encode_pretty
  - toml_load
  - toml_parse
  - uncached_glob
  - version
- module: kumo.aaa
  module: kumo.aaa
- module: kumo.amqp
  module: kumo.amqp
  - basic_publish
  - build_client
- module: kumo.api.inject
  module: kumo.api.inject
  - inject_v1
- module: kumo.crypto
  module: kumo.crypto
- module: kumo.digest
  module: kumo.digest
  - crc32
  - hmac_sha1
  - hmac_sha224
  - hmac_sha256
  - hmac_sha384
  - hmac_sha512
  - sha1
  - sha224
  - sha256
  - sha384
  - sha3_256
  - sha3_384
  - sha3_512
  - sha512
  - sha512_256
- module: kumo.dkim
  module: kumo.dkim
- module: kumo.dns
  module: kumo.dns
- module: kumo.encode
  module: kumo.encode
- module: kumo.cidr
  module: kumo.cidr
  - make_map
- module: kumo.domain_map
  module: kumo.domain_map
  - new
- module: kumo.file_type
  module: kumo.file_type
- module: kumo.fs
  module: kumo.fs
  - glob
  - open
  - read_dir
  - uncached_glob
- module: kumo.http
  module: kumo.http
- module: kumo.kafka
  module: kumo.kafka
  - build_producer
- module: kumo.mimepart
  module: kumo.mimepart
  - builder
  - new_binary
  - new_html
  - new_multipart
  - new_text
  - new_text_plain
  - parse
- module: kumo.mpsc
  module: kumo.mpsc
  - define
- module: kumo.regex_set_map
  module: kumo.regex_set_map
  - new
- module: kumo.secrets
  module: kumo.secrets
  - load
- module: kumo.serde
  module: kumo.serde
- module: kumo.shaping
  module: kumo.shaping
  - load
- module: kumo.spf
  module: kumo.spf
  - check_host
  - check_msg
- module: kumo.uuid
  module: kumo.uuid
  - new_v1
  - new_v4
  - new_v6
  - new_v7
  - parse
- module: redis
  module: redis
  - open
- module: regex
  module: regex
  - compile
  - escape
- module: sqlite
  module: sqlite
  - open
- module: string
  module: string
  - eval_template
  - normalize_smtp_response
  - psl_domain
  - psl_suffix
  - replace
  - replacen
  - rsplit
  - rsplitn
  - split
  - split_ascii_whitespace
  - split_whitespace
  - splitn
  - trim
  - trim_end
  - trim_start
  - wrap
- module: kumo.time
  module: kumo.time
- module: kumo.xfer
  module: kumo.xfer
- module: policy-extras.mail_auth
  module: policy-extras.mail_auth
  - check
  - iprev
  - iprev_msg
- module: proxy
  module: proxy
  - start_http_listener
  - start_proxy_listener
    
    start_proxy_listener
    
    hostname
    
    listen
    
    require_auth
    
    timeout
    
    tls_certificate
    
    tls_private_key
    
    use_splice
    
    use_tls
- 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: headermap
  object: headermap
- object: header
  object: header
- object: keysource
- object: message
  object: message
- object: mimepart
  object: mimepart
  - append_part
  - body
  - get_simple_structure
  - headers
  - id
  - rebuild
  - replace_body
- events
  events
- kumod HTTP API
  kumod HTTP API
- kumod Metrics
  kumod Metrics
- proxy-server HTTP API
  proxy-server HTTP API
- proxy-server Metrics
  proxy-server Metrics
- Internal Rust API
  Internal Rust API
- Tags
FAQ
FAQ
Changelog
Changelog

Table of contents

Types

API Types for proxy-server service

The following types are defined for the proxy-server service:

Types

SetDiagnosticFilterRequest

GET /proxy/status

SetDiagnosticFilterRequest

Copyright © 2023 Kumo Corp

Made with Material for MkDocs