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 sta‐
78 tus 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 pat‐
96 tern. The pattern may have embedded wildcards '*' or '%', which
97 match anything or anything except the separator character, respec‐
98 tively.
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 indi‐
107 cate that it is a root for other mailboxes, as opposed to a mailbox
108 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 listquota‐
114 root 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 "sieve"
138 Indicates the name of the global sieve script that should be
139 run when a message is delivered to the shared mailbox (not used
140 for personal mailboxes).
141 "squat"
143 Indicates that the mailbox should have a squat index created
144 for it.
145 "news2mail"
147 Sets an email address to which messages injected into the
148 server via NNTP will be sent.
149 "renamemailbox" ["--partition" partition] oldname newname
151 "rename" ["--partition" partition] oldname newname
152 "renm" ["--partition" partition] oldname newname
153 "renamemailbox" oldname newname [partition]
154 "rename" oldname newname [partition]
155 "renm" oldname newname [partition]
156 Rename the specified mailbox, optionally moving it to a different
157 partition. Both old-style and getopt-style usages are accepted;
158 combining them will produce an error.
159 server [--noauthenticate] [server]
161 connect [--noauthenticate] [server]
162 servername [--noauthenticate] [server]
163 With no arguments, show the current server. With an argument, con‐
164 nect to that server. It will prompt for automatic login unless the
165 "--noauthenticate" option is specified. (This may change; in par‐
166 ticular, either automatic authentication will be removed or all
167 "authenticate" options will be added.)
168 When connected to a server, cyradm's prompt changes from "cyradm>"
170 to "servername>", where servername is the fully qualified domain
171 name of the connected server.
172 "setaclmailbox" mailbox id rights [id rights ...]
174 "setacl" mailbox id rights [id rights ...]
175 "sam" mailbox id rights [id rights ...]
176 Set ACLs on a mailbox. The ACL may be one of the special strings
177 "none", "read" ("lrs"), "post" ("lrsp"), "append" ("lrsip"),
178 "write" ("lrswipkxte"), "delete" ("lrxte"), or "all" ("lrswip‐
179 kxte"), or any combinations of the ACL codes:
180 l Lookup (mailbox is visible to LIST/LSUB, SUBSCRIBE mailbox)
182 r Read (SELECT/EXAMINE the mailbox, perform STATUS)
184 s Seen (set/clear \SEEN flag via STORE, also set \SEEN flag dur‐
186 ing
187 APPEND/COPY/FETCH BODY[...])
188 w Write flags other than \SEEN and \DELETED
190 i Insert (APPEND, COPY destination)
192 p Post (send mail to mailbox)
194 k Create mailbox (CREATE new sub-mailboxes, parent for new mail‐
196 box in RENAME)
197 x Delete mailbox (DELETE mailbox, old mailbox name in RENAME)
199 t Delete messages (set/clear \DELETED flag via STORE, also set
201 \DELETED
202 flag during APPEND/COPY)
203 e Perform EXPUNGE and expunge as part of CLOSE
205 a Administer (SETACL/DELETEACL/GETACL/LISTRIGHTS)
207 "setinfo" attribute value
209 Set server metadata. A value of "none" will remove the attribute.
210 The currently supported attributes are:
211 "motd"
213 Sets a "message of the day". The message gets displayed as an
214 ALERT after authentication.
215 "comment"
217 Sets a comment or description associated with the server.
218 "admin"
220 Sets the administrator email address for the server.
221 "shutdown"
223 Sets a shutdown message. The message gets displayed as an
224 ALERT and all users are disconnected from the server (subse‐
225 quent logins are disallowed).
226 "expire"
228 Sets the number of days after which messages will be expired
229 from the server (unless overridden by a mailbox annotation).
230 "squat"
232 Indicates that all mailboxes should have a squat indexes cre‐
233 ated for them (unless overridden by a mailbox annotation).
234 "setquota" root resource value [resource value ...]
236 "sq" root resource value [resource value ...]
237 Set a quota on the specified root, which may or may not be an
238 actual mailbox. The only resource understood by Cyrus is "STOR‐
239 AGE". The value may be the special string "none" which will remove
240 the quota.
241 "version"
243 "ver"
244 Display the version info of the current server.
245 "xfermailbox" ["--partition" partition] mailbox server
247 "xfer" ["--partition" partition] mailbox server
248 "xfermailbox" mailbox server [partition]
249 "xfer" mailbox server [partition]
250 Transfer (relocate) the specified mailbox to a different server.
251 Both old-style and getopt-style usages are accepted; combining them
252 will produce an error.
253
255 GNU-style long options must be given in their entirety; Tcl-style
256 options may be abbreviated.
257 Tcl-style options are provided as a compatibility feature. They will
259 probably go away in the future.
260 Multiple commands can be given on a line, separated by ';' characters.
262 All commands set an exit status, which at present is not useful.
264 Unknown commands are passed to a subshell for execution.
266 The Tcl version of cyradm is used for scripting as well as interac‐
268 tively. While this is possible to a limited extent by use of the "run"
269 method, scripting would normally be done with "Cyrus::IMAP::Admin",
270 which is far more flexible than either interactive "cyradm" or the Tcl
271 scripting mechanism for Cyrus.
272 cyradm understands /bin/sh-style redirection: any command can have its
274 standard or error output redirected, with all sh-style redirections
275 (except "<>") supported. It does not currently understand pipes or
276 backgrounding.
277 If the "Term::Readline::Perl" or "Term::Readline::GNU" modules are
279 available, cyradm will use it.
280 An alias facility is implemented internally, but no access is currently
282 provided to it. This will change, if only to allow some of the prede‐
283 fined aliases to be removed if they conflict with useful shell com‐
284 mands.
285
287 Brandon S. Allbery, allbery@ece.cmu.edu
288
290 Cyrus::IMAP::Admin Term::ReadLine sh(1), perl(1), imapd(8).
291perl v5.8.8 2007-10-21 CYRADM(1)