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