Mercurial > projects > sievemgr

comparison cmd/sievemgr/doc.go @ 22:fc5e6970a0d5 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add support for specifying an authorization identity on the command line
author Guido Berhoerster <guido+sievemgr@berhoerster.name>
date Wed, 17 Feb 2021 07:50:55 +0100
parents 2b799ca75d96
children
comparison
equal deleted inserted replaced
21:ad5f548e3b10 22:fc5e6970a0d5
1 /* 1 /*
2 The sievemgr command is a ManageSieve client. 2 The sievemgr command is a ManageSieve client.
3 3
4 Usage: 4 Usage:
5 5
6 sievemgr [-f config] info [-a account] 6 sievemgr [-f config] info [-A authzid] [-a account]
7 sievemgr [-f config] list [-a account] 7 sievemgr [-f config] list [-A authzid] [-a account]
8 sievemgr [-f config] get [-a account] script 8 sievemgr [-f config] get [-A authzid] [-a account] script
9 sievemgr [-f config] put [-a account] script [file] 9 sievemgr [-f config] put [-A authzid] [-a account] script [file]
10 sievemgr [-f config] activate [-a account] script 10 sievemgr [-f config] activate [-A authzid] [-a account] script
11 sievemgr [-f config] deactivate [-a account] 11 sievemgr [-f config] deactivate [-A authzid] [-a account]
12 sievemgr [-f config] delete [-a account] script 12 sievemgr [-f config] delete [-A authzid] [-a account] script
13 sievemgr [-f config] check [-a account] [file] 13 sievemgr [-f config] check [-A authzid] [-a account] [file]
14 sievemgr [-f config] checkspace [-a account] script [file] 14 sievemgr [-f config] checkspace [-A authzid] [-a account] script [file]
15 sievemgr [-f config] rename [-a account] old new 15 sievemgr [-f config] rename [-A authzid] [-a account] old new
16 sievemgr [-f config] edit [-a account] script 16 sievemgr [-f config] edit [-A authzid] [-a account] script
17 sievemgr [-f config] man 17 sievemgr [-f config] man
18 18
19 Description: 19 Description:
20 20
21 sievemgr is a client for managing Sieve scripts on remote servers via the 21 sievemgr is a client for managing Sieve scripts on remote servers via the
107 -f config 107 -f config
108 Set the name of the configuration file to config. 108 Set the name of the configuration file to config.
109 109
110 Common Options: 110 Common Options:
111 111
112 -A authzid
113 Specify the authorization identity to assume if permitted by
114 the given account credentials.
115
112 -a account 116 -a account
113 Select account from the configuration file. 117 Select account from the configuration file.
114 118
115 Subcommands: 119 Subcommands:
116 120
117 sievemgr [-f config] info [-a account] 121 sievemgr [-f config] info [-A authzid] [-a account]
118 122
119 Displays information about the ManageSieve server. This includes conformance to 123 Displays information about the ManageSieve server. This includes conformance to
120 RFC 5804, support for TLS connections, supported extensions, available SASL 124 RFC 5804, support for TLS connections, supported extensions, available SASL
121 authentication mechanisms, and supported notification methods. 125 authentication mechanisms, and supported notification methods.
122 126
123 sievemgr [-f config] list [-a account] 127 sievemgr [-f config] list [-A authzid] [-a account]
124 128
125 Lists all scripts on the server and indicate which of the is the currently 129 Lists all scripts on the server and indicate which of the is the currently
126 active script. 130 active script.
127 131
128 sievemgr [-f config] get [-a account] script 132 sievemgr [-f config] get [-A authzid] [-a account] script
129 133
130 Fetch the contents of script from the server. 134 Fetch the contents of script from the server.
131 135
132 sievemgr [-f config] put [-a account] script [file] 136 sievemgr [-f config] put [-A authzid] [-a account] script [file]
133 137
134 Submit file under the name script to the server. If file is not specified, 138 Submit file under the name script to the server. If file is not specified,
135 read the script from standard input. The server will reject a script if it is 139 read the script from standard input. The server will reject a script if it is
136 invalid or a storage quota is exceeded. 140 invalid or a storage quota is exceeded.
137 141
138 sievemgr [-f config] activate [-a account] script 142 sievemgr [-f config] activate [-A authzid] [-a account] script
139 143
140 Set script as the active script on the server. 144 Set script as the active script on the server.
141 145
142 sievemgr [-f config] deactivate [-a account] 146 sievemgr [-f config] deactivate [-A authzid] [-a account]
143 147
144 Deactivate the currently active script on the server. 148 Deactivate the currently active script on the server.
145 149
146 sievemgr [-f config] delete [-a account] script 150 sievemgr [-f config] delete [-A authzid] [-a account] script
147 151
148 Delete script from the server. 152 Delete script from the server.
149 153
150 sievemgr [-f config] check [-a account] [file] 154 sievemgr [-f config] check [-A authzid] [-a account] [file]
151 155
152 Check if file is a valid sieve script. If file is not specified, read the 156 Check if file is a valid sieve script. If file is not specified, read the
153 script from standard input. 157 script from standard input.
154 158
155 sievemgr [-f config] checkspace [-a account] script [file] 159 sievemgr [-f config] checkspace [-A authzid] [-a account] script [file]
156 160
157 Check if the script in file can be stored on the server without exceeding the 161 Check if the script in file can be stored on the server without exceeding the
158 storage quota. If script already exists the server will take overwriting it 162 storage quota. If script already exists the server will take overwriting it
159 into account. If file is not specified, read the script from standard input. 163 into account. If file is not specified, read the script from standard input.
160 164
161 sievemgr [-f config] rename [-a account] old new 165 sievemgr [-f config] rename [-A authzid] [-a account] old new
162 166
163 Rename the script old to new. 167 Rename the script old to new.
164 168
165 sievemgr [-f config] edit [-a account] script 169 sievemgr [-f config] edit [-A authzid] [-a account] script
166 170
167 Retrieve a copy of script and start the editor referred to in the $EDITOR 171 Retrieve a copy of script and start the editor referred to in the $EDITOR
168 environment variable. If the local copy has not been modified or the editor 172 environment variable. If the local copy has not been modified or the editor
169 exits with a non-zero exit status the local copy of script will not be 173 exits with a non-zero exit status the local copy of script will not be
170 submitted to the server. In case of errors the local copy of the script will 174 submitted to the server. In case of errors the local copy of the script will