SMTPCTL(8)

NAME
smtpctl - control the Simple Mail Transfer Protocol daemon

SYNOPSIS
smtpctl command [argument ...]

DESCRIPTION
The smtpctl program controls smtpd(8). Commands may be abbreviated to the minimum unambiguous prefix; for example, sh s for show stats.

The following commands are available:

log brief
    Disable verbose debug logging.

log verbose
    Enable verbose debug logging.

pause incoming
    Temporarily stop accepting incoming sessions.

pause local
    Temporarily stop deliveries to local users.

pause outgoing
    Temporarily stop relaying and deliveries to remote users.

remove envelope-id
    Removes a single envelope from queue.

resume incoming
    Resume accepting incoming sessions.

resume local
    Resume deliveries to local users.

resume outgoing
    Resume relaying and deliveries to remote users.

schedule envelope-id | message-id
    Marks a single envelope, or all envelopes with the same message ID, as ready for immediate delivery.

show queue
    Displays information concerning envelopes that are currently in a queue.

show runqueue
    Displays information concerning envelopes that are scheduled for delivery.

show stats
    Displays runtime statistics concerning smtpd(8).

When 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 a envelope-uid applies to a specific recipient of a message.

FILES
/var/run/smtpd.sock
    UNIX-domain socket used for communication with smtpd(8).

SEE ALSO
smtpd(8)

HISTORY
The smtpctl program first appeared in OpenBSD 4.6.