1LMTPTEST(1) Cyrus IMAP LMTPTEST(1)
2
6 lmtptest - Cyrus IMAP documentation
7 Interactive LMTP test program
9 This is actually installed as a hard link to imtest(1).
11 It allows you to authenticate and send LMTP commands to the server.
13
15 imtest [ -t keyfile ] [ -p port ] [ -m mechanism ]
16 [ -a userid ] [ -u userid ] [ -k num ] [ -l num ]
17 [ -r realm ] [ -f file ] [ -n num ] [ -s ] [ -q ]
18 [ -c ] [ -i ] [ -z ] [ -v ] [ -I file ] [ -x file ]
19 [ -X file ] [ -w passwd ] [ -o option=value ] hostname
20
22 imtest is a utility that allows you to authenticate to an IMAP server
23 and interactively issue commands to it. Once authenticated you may is‐
24 sue any IMAP command by simply typing it in. It is capable of multiple
25 SASL authentication mechanisms and handles encryption layers transpar‐
26 ently. This utility is often used for testing the operation of an IMAP
27 server. Also those developing IMAP clients find it useful.
28
30 -t keyfile, --keyfile=keyfile
31 Enable TLS. keyfile contains the TLS public and private keys.
32 Specify "" to negotiate a TLS encryption layer but not use TLS
33 authentication.
34 -p port, --port=port
36 Port to connect to. If left off this defaults to imap as defined
37 in /etc/services.
38 -m mechanism, --mechanism=mechanism
40 Force imtest to use mechanism for authentication. If not speci‐
41 fied the strongest authentication mechanism supported by the
42 server is chosen. Specify login to use the LOGIN command in‐
43 stead of AUTHENTICATE.
44 -a userid, --authname=userid
46 Userid to use for authentication; defaults to the current user.
47 This is the userid whose password or credentials will be pre‐
48 sented to the server for verification.
49 -u userid, --username=userid
51 Userid to use for authorization; defaults to the current user.
52 This is the userid whose identity will be assumed after authen‐
53 tication.
54 NOTE:
56 This is only used with SASL mechanisms that allow proxying
57 (e.g. PLAIN, DIGEST-MD5).
58 -k num, --minssf=num
60 Minimum protection layer required.
61 -l num, --maxssf=num
63 Maximum protection layer to use (0=none; 1=integrity; etc). For
64 example if you are using the KERBEROS_V4 authentication mecha‐
65 nism specifying 0 will force imtest to not use any layer and
66 specifying 1 will force it to use the integrity layer. By de‐
67 fault the maximum supported protection layer will be used.
68 -r realm, --realm=realm
70 Specify the realm to use. Certain authentication mechanisms
71 (e.g. DIGEST-MD5) may require one to specify the realm.
72 -f file, --input-filename=file
74 Pipe file into connection after authentication.
75 -n num, --reauth-attempts=num
77 Number of authentication attempts; default = 1. The client will
78 attempt to do SSL/TLS session reuse and/or fast reauth (e.g. DI‐
79 GEST-MD5), if possible.
80 -s, --require-tls
82 Enable SSL over chosen protocol.
83 -q, --require-compression
85 Enable IMAP COMPRESSion (after authentication).
86 -c, --do-challenge
88 Enable challenge prompt callbacks. This will cause the OTP
89 mechanism to ask for the one-time password instead of the secret
90 pass-phrase (library generates the correct response).
91 -i, --no-initial-response
93 Don't send an initial client response for SASL mechanisms, even
94 if the protocol supports it.
95 -I file, --pidfile=file
97 Echo the PID of the running process into file (This can be use‐
98 ful with -X).
99 -v, --verbose
101 Verbose. Print out more information than usual.
102 -z, --run-stress-test
104 Timing test.
105 -x file, --output-socket=file
107 Open the named socket for the interactive portion.
108 -X file
110 Like -x, only close all file descriptors & daemonize the
111 process.
112 -w password, --password=password
114 Password to use (if not supplied, we will prompt).
115 -o option=value, --sasl-option=option=value
117 Set the SASL option to value.
118
121 imapd(8)
122 lmtpd(8)
124
126 The Cyrus Team, Nic Bernstein (Onlight)
127
129 1993–2023, The Cyrus Team
1303.8.1 Sep 11, 2023 LMTPTEST(1)