1IMTEST(1)                         Cyrus IMAP                         IMTEST(1)
2
3
4

NAME

6       imtest - Cyrus IMAP documentation
7
8       Interactive IMAP test program.
9

SYNOPSIS

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

DESCRIPTION

18       imtest  is  a  utility that allows you to authenticate to a 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 a IMAP
23       server.  Also those developing IMAP clients find it useful.
24

OPTIONS

26       -t 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
31       -p port
32              Port to connect to. If left off this defaults to imap as defined
33              in /etc/services.
34
35       -m 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
41       -a 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
46       -u 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
51              NOTE:
52                 This is only used with SASL mechanisms  that  allow  proxying
53                 (e.g. PLAIN, DIGEST-MD5).
54
55       -k num Minimum protection layer required.
56
57       -l num Maximum protection layer to use (0=none; 1=integrity; etc).  For
58              example if you are using the KERBEROS_V4  authentication  mecha‐
59              nism  specifying  0  will  force imtest to not use any layer and
60              specifying 1 will force it to use the integrity layer.   By  de‐
61              fault the maximum supported protection layer will be used.
62
63       -r realm
64              Specify  the  realm  to  use.  Certain authentication mechanisms
65              (e.g. DIGEST-MD5) may require one to specify the realm.
66
67       -f file
68              Pipe file into connection after authentication.
69
70       -n num Number of authentication attempts; default = 1.  The client will
71              attempt to do SSL/TLS session reuse and/or fast reauth (e.g. DI‐
72              GEST-MD5), if possible.
73
74       -s     Enable SSL over chosen protocol.
75
76       -q     Enable IMAP COMPRESSion (after authentication).
77
78       -c     Enable challenge prompt callbacks.   This  will  cause  the  OTP
79              mechanism to ask for the one-time password instead of the secret
80              pass-phrase (library generates the correct response).
81
82       -i     Don’t send an initial client response for SASL mechanisms,  even
83              if the protocol supports it.
84
85       -I file
86              Echo  the PID of the running process into file (This can be use‐
87              ful with -X).
88
89       -v     Verbose. Print out more information than usual.
90
91       -z     Timing test.
92
93       -x file
94              Open the named socket for the interactive portion.
95
96       -X file
97              Like -x,  only  close  all  file  descriptors  &  daemonize  the
98              process.
99
100       -w passwd
101              Password to use (if not supplied, we will prompt).
102
103       -o option=value
104              Set the SASL option to value.
105

EXAMPLES

SEE ALSO
108       imapd(8)
109

AUTHOR
111       The Cyrus Team, Nic Bernstein (Onlight)
112

114       1993–2022, The Cyrus Team
115
116
117
118
1193.6.0                          December 12, 2022                     IMTEST(1)



        

    


            
        

        

            Impressum