1CYRADM(1) User Contributed Perl Documentation CYRADM(1)
2
6 cyradm - Cyrus administration shell, alter ego of Cyrus::IMAP::Shell
7
9 $ cyradm [--user user] [--[no]rc] [--systemrc file] [--userrc file] \
10 > [--port n] [--auth mechanism] [--tlskey keyfile] [--notls] \
11 > [--server] server
12 but possibly
14 $ perl -MCyrus::IMAP::Shell -e 'run("myscript")'
16 or even (not recommended)
18 use Cyrus::IMAP::Admin::Shell;
20 run('myscriptname');
22
24 This module implements cyradm in Perl. It is a shell around
25 Cyrus::IMAP::Admin. Commands are provided in both Tcl-compatible forms
26 and GNU-style long option forms.
27
29 "authenticate" ["--minssf" N] ["--maxssf" N] ["--mechanisms" list]
30 [user]
31 "auth" ["--minssf" N] ["--maxssf" N] ["--mechanisms" list] [user]
32 "login" ["--minssf" N] ["--maxssf" N] ["--mechanisms" list] [user]
33 Authenticate to server. You must already be connected to a server
34 and Cyrus imapd will refuse to allow you to re-authenticate once
35 you have authenticated once.
36 "chdir" directory
38 "cd" directory
39 Change directory. A "pwd" builtin is not provided, but the default
40 command action will run "pwd" from a shell if invoked.
41 "createmailbox" ["--partition" partition] mailbox
43 "createmailbox" mailbox partition
44 "create" ["--partition" partition] mailbox
45 "create" mailbox partition
46 "cm" ["--partition" partition] mailbox
47 "cm" mailbox partition
48 Create a mailbox on the default or a specified partition. Both
49 old-style and getopt-style usages are accepted (combining them will
50 produce an error).
51 "deleteaclmailbox" mailbox id [...]
53 "deleteacl" mailbox id [...]
54 "dam" mailbox id [...]
55 Remove ACLs from the specified mailbox.
56 "deletemailbox" mailbox
58 "delete" mailbox
59 "dm" mailbox
60 Delete the specified mailbox.
61 Administrators do not have implicit delete rights on mailboxes.
63 Use the setaclmailbox command to grant the "x" permission to your
64 principal if you need to delete a mailbox you do not own.
65 Note that the online help admits to an optional host argument.
67 This argument is not currently used, and will be rejected with an
68 error if specified; it is reserved for IMSP.
69 "disconnect"
71 "disc"
72 Disconnect from the current server. The prompt will revert to
73 "cyradm>".
74 "exit" [number]
76 "quit" [number]
77 Exit cyradm, optionally with a specific exit status; the exit
78 status of the last command will be used if one is not specified.
79 help [command]
81 ? [command]
82 Show help for "command" or all commands.
83 "info" [mailbox]
85 Display the mailbox/server metadata.
86 "listaclmailbox" mailbox
88 "listacl" mailbox
89 "lam" mailbox
90 List ACLs on the specified mailbox.
91 "listmailbox" ["--subscribed"] [pattern [reference]]
93 "list" ["--subscribed"] [pattern [reference]]
94 "lm" ["--subscribed"] [pattern [reference]]
95 List all, or all subscribed, mailboxes matching the specified
96 pattern. The pattern may have embedded wildcards '*' or '%', which
97 match anything or anything except the separator character,
98 respectively.
99 Mailboxes returned will be relative to the specified reference if
101 one is specified. This allows a mailbox list to be limited to a
102 particular hierarchy.
103 In some cases when the '%' wildcard is used to end a pattern, it
105 may match an entry which is not a mailbox but which contains other
106 mailboxes. In this case, the entry will be parenthesized to
107 indicate that it is a root for other mailboxes, as opposed to a
108 mailbox itself.
109 "listquota" root
111 "lq" root
112 List quotas on specified root. If the specified mailbox path does
113 not have a quota assigned, an error will be raised; see
114 listquotaroot for a way to find the quota root for a mailbox.
115 "listquotaroot" mailbox
117 "lqm" mailbox
118 "lqr" mailbox?
119 show quota roots and quotas for mailbox
120 "mboxconfig" mailbox attribute value
122 "mboxcfg" mailbox attribute value
123 Set mailbox metadata. A value of "none" will remove the attribute.
124 The currently supported attributes are:
125 "comment"
127 Sets a comment or description associated with the mailbox.
128 "expire"
130 Sets the number of days after which messages will be expired
131 from the mailbox.
132 "news2mail"
134 Sets an email address to which messages injected into the
135 server via NNTP will be sent.
136 "sharedseen"
138 Enables the use of a shared \Seen flag on messages rather than
139 a per-user \Seen flag. The 's' right in the mailbox ACL still
140 controls whether a user can set the shared \Seen flag.
141 "sieve"
143 Indicates the name of the global sieve script that should be
144 run when a message is delivered to the shared mailbox (not used
145 for personal mailboxes).
146 "squat"
148 Indicates that the mailbox should have a squat index created
149 for it.
150 "/explicit/annotation"
152 Sets the annotation /explicit/annotation on mailbox to value.
153 "renamemailbox" ["--partition" partition] oldname newname
155 "rename" ["--partition" partition] oldname newname
156 "renm" ["--partition" partition] oldname newname
157 "renamemailbox" oldname newname [partition]
158 "rename" oldname newname [partition]
159 "renm" oldname newname [partition]
160 Rename the specified mailbox, optionally moving it to a different
161 partition. Both old-style and getopt-style usages are accepted;
162 combining them will produce an error.
163 server [--noauthenticate] [server]
165 connect [--noauthenticate] [server]
166 servername [--noauthenticate] [server]
167 With no arguments, show the current server. With an argument,
168 connect to that server. It will prompt for automatic login unless
169 the "--noauthenticate" option is specified. (This may change; in
170 particular, either automatic authentication will be removed or all
171 "authenticate" options will be added.)
172 When connected to a server, cyradm's prompt changes from "cyradm>"
174 to "servername>", where servername is the fully qualified domain
175 name of the connected server.
176 "setaclmailbox" mailbox id rights [id rights ...]
178 "setacl" mailbox id rights [id rights ...]
179 "sam" mailbox id rights [id rights ...]
180 Set ACLs on a mailbox. The ACL may be one of the special strings
181 "none", "read" ("lrs"), "post" ("lrsp"), "append" ("lrsip"),
182 "write" ("lrswipkxte"), "delete" ("lrxte"), or "all"
183 ("lrswipkxte"), or any combinations of the ACL codes:
184 l Lookup (mailbox is visible to LIST/LSUB, SUBSCRIBE mailbox)
186 r Read (SELECT/EXAMINE the mailbox, perform STATUS)
188 s Seen (set/clear \SEEN flag via STORE, also set \SEEN flag
190 during
191 APPEND/COPY/FETCH BODY[...])
192 w Write flags other than \SEEN and \DELETED
194 i Insert (APPEND, COPY destination)
196 p Post (send mail to mailbox)
198 k Create mailbox (CREATE new sub-mailboxes, parent for new
200 mailbox in RENAME)
201 x Delete mailbox (DELETE mailbox, old mailbox name in RENAME)
203 t Delete messages (set/clear \DELETED flag via STORE, also set
205 \DELETED
206 flag during APPEND/COPY)
207 e Perform EXPUNGE and expunge as part of CLOSE
209 a Administer (SETACL/DELETEACL/GETACL/LISTRIGHTS)
211 "setinfo" attribute value
213 Set server metadata. A value of "none" will remove the attribute.
214 The currently supported attributes are:
215 "motd"
217 Sets a "message of the day". The message gets displayed as an
218 ALERT after authentication.
219 "comment"
221 Sets a comment or description associated with the server.
222 "admin"
224 Sets the administrator email address for the server.
225 "shutdown"
227 Sets a shutdown message. The message gets displayed as an
228 ALERT and all users are disconnected from the server
229 (subsequent logins are disallowed).
230 "expire"
232 Sets the number of days after which messages will be expired
233 from the server (unless overridden by a mailbox annotation).
234 "squat"
236 Indicates that all mailboxes should have a squat indexes
237 created for them (unless overridden by a mailbox annotation).
238 "setquota" root resource value [resource value ...]
240 "sq" root resource value [resource value ...]
241 Set a quota on the specified root, which may or may not be an
242 actual mailbox. The only resource understood by Cyrus is
243 "STORAGE". The value may be the special string "none" which will
244 remove the quota.
245 "version"
247 "ver"
248 Display the version info of the current server.
249 "xfermailbox" ["--partition" partition] mailbox server
251 "xfer" ["--partition" partition] mailbox server
252 "xfermailbox" mailbox server [partition]
253 "xfer" mailbox server [partition]
254 Transfer (relocate) the specified mailbox to a different server.
255 Both old-style and getopt-style usages are accepted; combining them
256 will produce an error.
257
259 GNU-style long options must be given in their entirety; Tcl-style
260 options may be abbreviated.
261 Tcl-style options are provided as a compatibility feature. They will
263 probably go away in the future.
264 Multiple commands can be given on a line, separated by ';' characters.
266 All commands set an exit status, which at present is not useful.
268 Unknown commands are passed to a subshell for execution.
270 The Tcl version of cyradm is used for scripting as well as
272 interactively. While this is possible to a limited extent by use of
273 the "run" method, scripting would normally be done with
274 "Cyrus::IMAP::Admin", which is far more flexible than either
275 interactive "cyradm" or the Tcl scripting mechanism for Cyrus.
276 cyradm understands /bin/sh-style redirection: any command can have its
278 standard or error output redirected, with all sh-style redirections
279 (except "<>") supported. It does not currently understand pipes or
280 backgrounding.
281 If the "Term::Readline::Perl" or "Term::Readline::GNU" modules are
283 available, cyradm will use it.
284 An alias facility is implemented internally, but no access is currently
286 provided to it. This will change, if only to allow some of the
287 predefined aliases to be removed if they conflict with useful shell
288 commands.
289
291 Brandon S. Allbery, allbery@ece.cmu.edu
292
294 Cyrus::IMAP::Admin Term::ReadLine sh(1), perl(1), imapd(8).
295perl v5.16.3 2017-08-04 CYRADM(1)