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 "condstore"
130 Enables the IMAP CONDSTORE extension (modification sequences)
131 on the mailbox.
132 "expire"
134 Sets the number of days after which messages will be expired
135 from the mailbox.
136 "news2mail"
138 Sets an email address to which messages injected into the
139 server via NNTP will be sent.
140 "sharedseen"
142 Enables the use of a shared \Seen flag on messages rather than
143 a per-user \Seen flag. The 's' right in the mailbox ACL still
144 controls whether a user can set the shared \Seen flag.
145 "sieve"
147 Indicates the name of the global sieve script that should be
148 run when a message is delivered to the shared mailbox (not used
149 for personal mailboxes).
150 "squat"
152 Indicates that the mailbox should have a squat index created
153 for it.
154 "renamemailbox" ["--partition" partition] oldname newname
156 "rename" ["--partition" partition] oldname newname
157 "renm" ["--partition" partition] oldname newname
158 "renamemailbox" oldname newname [partition]
159 "rename" oldname newname [partition]
160 "renm" oldname newname [partition]
161 Rename the specified mailbox, optionally moving it to a different
162 partition. Both old-style and getopt-style usages are accepted;
163 combining them will produce an error.
164 server [--noauthenticate] [server]
166 connect [--noauthenticate] [server]
167 servername [--noauthenticate] [server]
168 With no arguments, show the current server. With an argument,
169 connect to that server. It will prompt for automatic login unless
170 the "--noauthenticate" option is specified. (This may change; in
171 particular, either automatic authentication will be removed or all
172 "authenticate" options will be added.)
173 When connected to a server, cyradm's prompt changes from "cyradm>"
175 to "servername>", where servername is the fully qualified domain
176 name of the connected server.
177 "setaclmailbox" mailbox id rights [id rights ...]
179 "setacl" mailbox id rights [id rights ...]
180 "sam" mailbox id rights [id rights ...]
181 Set ACLs on a mailbox. The ACL may be one of the special strings
182 "none", "read" ("lrs"), "post" ("lrsp"), "append" ("lrsip"),
183 "write" ("lrswipkxte"), "delete" ("lrxte"), or "all"
184 ("lrswipkxte"), or any combinations of the ACL codes:
185 l Lookup (mailbox is visible to LIST/LSUB, SUBSCRIBE mailbox)
187 r Read (SELECT/EXAMINE the mailbox, perform STATUS)
189 s Seen (set/clear \SEEN flag via STORE, also set \SEEN flag
191 during
192 APPEND/COPY/FETCH BODY[...])
193 w Write flags other than \SEEN and \DELETED
195 i Insert (APPEND, COPY destination)
197 p Post (send mail to mailbox)
199 k Create mailbox (CREATE new sub-mailboxes, parent for new
201 mailbox in RENAME)
202 x Delete mailbox (DELETE mailbox, old mailbox name in RENAME)
204 t Delete messages (set/clear \DELETED flag via STORE, also set
206 \DELETED
207 flag during APPEND/COPY)
208 e Perform EXPUNGE and expunge as part of CLOSE
210 a Administer (SETACL/DELETEACL/GETACL/LISTRIGHTS)
212 "setinfo" attribute value
214 Set server metadata. A value of "none" will remove the attribute.
215 The currently supported attributes are:
216 "motd"
218 Sets a "message of the day". The message gets displayed as an
219 ALERT after authentication.
220 "comment"
222 Sets a comment or description associated with the server.
223 "admin"
225 Sets the administrator email address for the server.
226 "shutdown"
228 Sets a shutdown message. The message gets displayed as an
229 ALERT and all users are disconnected from the server
230 (subsequent logins are disallowed).
231 "expire"
233 Sets the number of days after which messages will be expired
234 from the server (unless overridden by a mailbox annotation).
235 "squat"
237 Indicates that all mailboxes should have a squat indexes
238 created for them (unless overridden by a mailbox annotation).
239 "setquota" root resource value [resource value ...]
241 "sq" root resource value [resource value ...]
242 Set a quota on the specified root, which may or may not be an
243 actual mailbox. The only resource understood by Cyrus is
244 "STORAGE". The value may be the special string "none" which will
245 remove the quota.
246 "version"
248 "ver"
249 Display the version info of the current server.
250 "xfermailbox" ["--partition" partition] mailbox server
252 "xfer" ["--partition" partition] mailbox server
253 "xfermailbox" mailbox server [partition]
254 "xfer" mailbox server [partition]
255 Transfer (relocate) the specified mailbox to a different server.
256 Both old-style and getopt-style usages are accepted; combining them
257 will produce an error.
258
260 GNU-style long options must be given in their entirety; Tcl-style
261 options may be abbreviated.
262 Tcl-style options are provided as a compatibility feature. They will
264 probably go away in the future.
265 Multiple commands can be given on a line, separated by ';' characters.
267 All commands set an exit status, which at present is not useful.
269 Unknown commands are passed to a subshell for execution.
271 The Tcl version of cyradm is used for scripting as well as
273 interactively. While this is possible to a limited extent by use of
274 the "run" method, scripting would normally be done with
275 "Cyrus::IMAP::Admin", which is far more flexible than either
276 interactive "cyradm" or the Tcl scripting mechanism for Cyrus.
277 cyradm understands /bin/sh-style redirection: any command can have its
279 standard or error output redirected, with all sh-style redirections
280 (except "<>") supported. It does not currently understand pipes or
281 backgrounding.
282 If the "Term::Readline::Perl" or "Term::Readline::GNU" modules are
284 available, cyradm will use it.
285 An alias facility is implemented internally, but no access is currently
287 provided to it. This will change, if only to allow some of the
288 predefined aliases to be removed if they conflict with useful shell
289 commands.
290
292 Brandon S. Allbery, allbery@ece.cmu.edu
293
295 Cyrus::IMAP::Admin Term::ReadLine sh(1), perl(1), imapd(8).
296perl v5.10.1 2017-03-22 CYRADM(1)