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

NAME

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

SYNOPSIS

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

DESCRIPTION

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

OPTIONS

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

EXAMPLES

SEE ALSO

112       imapd(8)
113
114       lmtpd(8)
115

AUTHOR

117       The Cyrus Team, Nic Bernstein (Onlight)
118
120       1993–2022, The Cyrus Team
121
122
123
124
1253.6.0                          December 12, 2022                   LMTPTEST(1)
Impressum