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

NAME

6       sivtest - Cyrus IMAP documentation
7
8       Interactive MANAGESIEVE test program.
9
10       This is actually installed as a hard linked copy of imtest(1).
11
12       It  allows  you  to  authenticate  and send MANAGESIEVE commands to the
13       server.
14

SYNOPSIS

16          imtest [ -t keyfile ] [ -p port ] [ -m mechanism ]
17              [ -a userid ] [ -u userid ] [ -k num ] [ -l num ]
18              [ -r realm ] [ -f file ] [ -n num ] [ -s ] [ -q ]
19              [ -c ] [ -i ] [ -z ] [ -v ] [ -I file ] [ -x file ]
20              [ -X file ] [ -w passwd ] [ -o option=value ] hostname
21

DESCRIPTION

23       imtest is a utility that allows you to authenticate to an  IMAP  server
24       and  interactively issue commands to it. Once authenticated you may is‐
25       sue any IMAP command by simply typing it in. It is capable of  multiple
26       SASL  authentication mechanisms and handles encryption layers transpar‐
27       ently.  This utility is often used for testing the operation of an IMAP
28       server.  Also those developing IMAP clients find it useful.
29

OPTIONS

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

EXAMPLES

SEE ALSO
122       imapd(8)
123
124       timsieved(8)
125

AUTHOR
127       The Cyrus Team, Nic Bernstein (Onlight)
128

130       1993–2023, The Cyrus Team
131
132
133
134
1353.8.1                            Sep 11, 2023                       SIVTEST(1)



        

    


            
        

        

            Impressum