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

NAME

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

OPTIONS

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

EXAMPLES

SEE ALSO

113       imapd(8)
114
115       sendmail(8)
116

AUTHOR

118       The Cyrus Team, Nic Bernstein (Onlight)
119
121       1993-2018, The Cyrus Team
122
123
124
125
1263.2.8                         September 01, 2021                   SMTPTEST(1)
Impressum