— control the Simple Mail Transfer Protocol
|command [argument ...]
smtpctl program controls
smtpd(8). Commands may be
abbreviated to the minimum unambiguous prefix; for example,
sh s for
mailq command is provided for
compatibility with other MTAs and is simply a shortcut for
The following commands are available:
- Encrypt the password string to a representation
suitable for user credentials and print it to the standard output. If
string is not provided, cleartext passwords are read
from standard input.
It is advised to avoid providing the password as a parameter
as it will be visible from
- Disable verbose debug logging.
- Enable verbose debug logging.
- Display updates of some
smtpd(8) internal counters
in one second intervals. Each line reports the increment of all counters
since the last update, except for some counters which are always absolute
values. The first line reports the current value of each counter. The
- Current number of active SMTP clients (absolute value).
- New SMTP clients.
- Disconnected clients.
- Current number of envelopes in the queue (absolute value).
- Newly enqueued envelopes.
- Dequeued envelopes.
- Successful deliveries.
- Temporary failures.
- Permanent failures.
- Message loops.
- Expired envelopes.
- Envelopes removed by the administrator.
- Generated bounces.
envelope envelope-id |
- Temporarily suspend scheduling for the envelope with the given ID, or all
envelopes with the given message ID.
- Temporarily stop deliveries to local users.
- Temporarily stop relaying and deliveries to remote users.
- Temporarily stop accepting incoming sessions.
- Enables real-time profiling of subsystem. Supported
- queue, to profile cost of queue IO
- imsg, to profile cost of event handlers
envelope-id | message-id
- Remove a single envelope, or all envelopes with the same message ID.
envelope envelope-id |
- Resume scheduling for the envelope with the given ID, or all envelopes
with the given message ID.
- Resume deliveries to local users.
- Resume relaying and deliveries to remote users.
- Resume routing on disabled route route-id.
- Resume accepting incoming sessions.
- Mark all envelopes as ready for immediate delivery.
envelope-id | message-id
- Mark a single envelope, or all envelopes with the same message ID, as
ready for immediate delivery.
- Display envelope content for the given ID.
- Display the list of known remote MX hosts. For each of them, it shows the
IP address, the canonical hostname, a reference count, the number of
active connections to this host, and the elapsed time since the last
- Display status of last delivery for domains that have been active in the
last 4 hours. It consists of the following fields, separated by a
- UNIX timestamp of last delivery.
- Status of last delivery.
- Display message content for the given ID.
- Display information concerning envelopes that are currently in the queue.
Each line of output describes a single envelope. It consists of the
following fields, separated by a "|":
- Envelope ID.
- Address family of the client which enqueued the mail.
- Type of delivery: one of "mta", "mda" or
- Various flags on the envelope.
- Sender address (return path).
- The original recipient address.
- The destination address.
- Time of creation.
- Time of expiration.
- Time of last delivery or relaying attempt.
- Number of delivery or relaying attempts.
- Current runstate: either "pending" or "inflight"
if smtpd(8) is running,
or "offline" otherwise.
- Delay in seconds before the next attempt if pending, or time ellapsed
if currently running. This field is blank if
smtpd(8) is not
- Error string for the last failed delivery or relay attempt.
- Display the list of currently active relays and associated connectors. For
each relay, it shows a number of counters and information on its internal
state on a single line. Then comes the list of connectors (source
addresses to connect from for this relay).
- Display status of routes currently known by
smtpd(8). Each line consists
of a route number, a source address, a destination address, a set of
flags, the number of connections on this route, the current penalty level
which determines the amount of time the route is disabled if an error
occurs, and the delay before it gets reactivated. The following flags are
- The route is currently disabled.
- The route is new. No SMTP session has been established yet.
- The route as a timeout registered to lower its penalty level and
possibly reactivate or discard it.
- Displays runtime statistics concerning
- Shows if MTA, MDA and SMTP systems are currently running or paused.
- Stop the server.
- Enables real-time tracing of subsystem. Supported
- smtp (incoming sessions)
- transfer (outgoing sessions)
- expand (aliases/virtual/forward expansion)
- lookup (user/credentials lookups)
- rules (matched by incoming sessions)
- Disables real-time profiling of subsystem.
- Disables real-time tracing of subsystem.
- For table backends that provide caching, causes
smtpd(8) to update the
smtpd receives a message, it
generates a message-id for the message, and one
envelope-id per recipient. The
message-id is a 32-bit random identifier that is
guaranteed to be unique on the host system. The
envelope-id is a 64-bit unique identifier that encodes
the message-id in the 32 upper bits and a random
envelope identifier in the 32 lower bits.
A command which specifies a message-id
applies to all recipients of a message; a command which specifies an
envelope-id applies to a specific recipient of a
- UNIX-domain socket used for communication with
smtpctl program first appeared in