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 mda
- Temporarily stop deliveries to local users.
pause mta
- Temporarily stop relaying and deliveries to remote users.
pause smtp
- Temporarily stop accepting incoming sessions.
remove
envelope-id | message-id- Removes a single envelope, or all envelopes with the same message ID.
resume mda
- Resume deliveries to local users.
resume mta
- Resume relaying and deliveries to remote users.
resume smtp
- Resume accepting incoming sessions.
schedule-all
- Marks all envelopes as ready for immediate delivery.
schedule-id
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
HISTORY
The smtpctl
program first appeared in
OpenBSD 4.6.