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 or IMSP
19       server and interactively issue commands to it. Once  authenticated  you
20       may  issue any IMAP or IMSP command by simply typing it in. It is capa‐
21       ble of multiple SASL authentication mechanisms and  handles  encryption
22       layers transparently. This utility is often used for testing the opera‐
23       tion of a imsp or imap server. Also those developing IMAP clients  find
24       it useful.
25

OPTIONS

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

EXAMPLES

SEE ALSO
109       imapd(8)
110

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

115       1993-2018, The Cyrus Team
116
117
118
119
1203.2.6                           March 09, 2021                       IMTEST(1)



        

    


            
        

        

            Impressum