config

07:50:47 /tmp/2025> config set suspend_delivery true
Suspend_Delivery = true
08:02:16 /tmp/2025> config set suspend_delivery 1
Suspend_Delivery = 1
08:02:19 /tmp/2025> config set suspend_delivery enabled
Suspend_Delivery = enabled
08:02:22 /tmp/2025> config set suspend_delivery on
Suspend_Delivery = on

10:47:35 /tmp/2025> config begin
10:47:35 /tmp/2025> config set esmtp_listener listen :587 concurrency 5
10:47:35 /tmp/2025> config set esmtp_listener listen :587 pool_name accept
10:47:35 /tmp/2025> config set threadpool accept concurrency 5
10:47:35 /tmp/2025> config commit

config begin

Begin a transaction.

config begin from scratch

Begin a transaction from scratch.

This command starts an entirely new configuration. However, if you issue the command config begin from scratch and then the command config showrecurse , you will see that some options are already set. This is not a bug; these settings are the implicit settings you get when you load an empty configuration file. You can override them with config set , but you cannot unset them because these settings are necessary for proper operation. The options that are already set are the ThreadPool stanzas, the DebugFlags and the TimestampFormat option.

config commit

Commit a transaction.

config locate

Locate a particular scope.

Use this command to locate specific scopes. The following is an example of the output resulting from issuing the command config locate listen :

Listen ":25"
  is at Esmtp_Listener::Listen:\:25:
Listen ":587"
  is at Esmtp_Listener::Listen:\:587:
Listen "127.0.0.1:2025"
  is at Control_Listener::Listen:127.0.0.1\:2025:
Listen "/tmp/2025"
  is at Control_Listener::Listen:/tmp/2025:

Where a scope has an instance name, that instance name may also be specified. For example, the command, config locate listen 127.0.0.1 is also legal.

This command is particularly useful for showing the exact location of a scope. For example:

10:47:35 /tmp/2025> config locate QueryGroups
QueryGroups
  is at auth_ds::Scheme:ecauth:QueryGroups::

You can then examine the particulars of this scope by issuing the command config show auth_ds Scheme ecauth QueryGroups .

You can also use this command specifying a regular expression as an optional argument, for example:

12:00:12 /tmp/2025> config locate Scheme ec.+
Scheme "ecauth"
  is at auth_ds::Scheme:ecauth:

The regex argument need not be quoted unless it contains spaces; specifically, enclosing it in forward slashes is not necessary and will not work. Note that the use of this command with a scope and a regular expression is different from regex scopes such as regex domains. In the case of a regex domain, (see Regex Domains) the regular expression denoted by pattern in the command config locate Domain pattern will be matched against the regex domain treated as an ordinary string. For example, the command config locate Domain ex.+ would locate a regex domain defined as:

Domain "/(?:^|[.])example[.](/momentum/4/com-co-uk)$/" {
  ...
}

config reload

Reload configuration options.

If no file is specified, config reload reloads configuration options from the ecelerity.conf file. You may specify an alternate configuration file. Options changed in the configuration file come into effect immediately. Momentum does not need to be restarted. You may also use config reload to attempt a configuration reload to cancel any changes made from the console. This must happen outside of a transaction, otherwise an error message will be displayed. If you make manual changes to your configuration file, issue this command to ensure that your changes are put into effect immediately.

Issuing the config reload command while receiving email will trigger the Reconfig_Message. For more information see “Reconfig_Message Option”.

Warning#

Not all options can be changed at runtime. To confirm that an option is "dynamic", check the default column of the table at Configuration Options Summary . Options that cannot be changed without restarting the ecelerity process are marked as non-dynamic.

config replay

Show changes in a transaction prior to a commit or rollback.

This command can be used in an active transaction; when you have issued the command config begin or config begin from scratch but have not yet done a config commit or a config rollback . It prints out all the config set and config unset commands you have given since the start of the transaction. config eval or config show commands are not displayed.

This command is especially useful if you find that a conflict causes your commit to fail. Using config replay , you can determine exactly what changes you attempted before rolling back your transaction.

config rollback

Rollback a transaction.

config show

View a specific scope.

config show and config showrecurse are similar. As with config get or config eval , you supply a path into the configuration tree, but without specifying an option name. You can then view the whole scope. config showrecurse also shows child scopes.

Given the following mail_loop configuration:

mail_loop "mail_loop1"
{
  Use_IP = false
}

Issuing the command config show mail_loop mail_loop yields the output:

Use_IP = false

The difference between config show scope and config showrecurse scope is illustrated using the following ESMTP listener configuration:

Esmtp_Listener {
  Listen ":25" {
  }
  Listen ":587" {
    Enable = false
    SMTP_Extensions = (
      "ENHANCEDSTATUSCODES"
      "STARTTLS"
      "AUTH LOGIN"
    )
    TLS_Key = "cert.key"
    TLS_Certificate = "cert.pem"
    TLS_Client_CA = "ca-bundle.crt"
    TLS_Ciphers = "DEFAULT"
  }
  Idle_Time = 300
  SMTP_Extensions = (
    "ENHANCEDSTATUSCODES"
  )
}

Issuing the command config showrecurse ESMTP_Listener reproduces the entire configuration as shown above. On the other hand, issuing the command, config show ESMTP_Listener , outputs only the following:

Listen ":25" { ... }
Listen ":587" { ... }
Idle_Time = 300
SMTP_Extensions = (
  "ENHANCEDSTATUSCODES"
)

config showrecurse

View a specific scope and its child scopes.

config writeback [*`/optional/alternate/path`*]

Write configuration changes to your ecelerity.conf file or an alternate file.

The config writeback command writes any changes you have made to the live configuration back to the configuration file or files that the configuration was read from originally. If you do not want to overwrite the main configuration file, you can provide an alternate path. If your configuration has "include" files, edits go to the most appropriate place. For example, suppose that you have a binding configuration that came from an included file, changes to that binding are written back to the included file.

Message_Expiration = 86400

Domain earthlink.net {
  Message_Expiration = 900
}

Binding smtp-01 {
  EHLO_Hostname = "smtp-01.com"
  Domain relay.com {
    EHLO_Hostname = "relay.com"
  }
}

10:47:35 /tmp/2025> config get message_expiration
Message_Expiration = 86400

10:47:35 /tmp/2025> config get domain earthlink.net message_expiration
        Message_Expiration = 900

10:47:35 /tmp/2025> config unset domain earthlink.net message_expiration
"Message_Expiration" has been unset. Effective value is now:
        Message_Expiration = 86400

10:47:35 /tmp/2025> config get binding smtp-01 ehlo_hostname
        EHLO_Hostname = "smtp-01.com"

10:47:35 /tmp/2025> config get binding smtp-01 domain relay.com ehlo_hostname
        EHLO_Hostname = "relay.com"

10:47:35 /tmp/2025> config unset binding smtp-01 domain relay.com ehlo_hostname
"EHLO_Hostname" has been unset. Effective value is now:
        EHLO_Hostname = "smtp-01.com"

10:47:35 /tmp/2025> config set Relay_Hosts ( 10.0.0.1 10.0.0.2 )
Relay_Hosts = (
  10.0.0.1
  10.0.0.2
  )