1IMAP::Shell(3) User Contributed Perl Documentation IMAP::Shell(3)
2
6 Cyrus::IMAP::Shell - Perl version of cyradm
7
9 $ cyradm [--user authid] [--authz authzid] [--[no]rc] [--systemrc file] [--userrc file] \
10 > [--port n] [--auth mechanism] [--server] server
11 but possibly
13 $ perl -MCyrus::IMAP::Shell -e 'run("myscript")'
15 or even (not recommended)
17 use Cyrus::IMAP::Admin::Shell;
19 run('myscriptname');
21
23 This module implements cyradm in Perl. It is a shell around
24 Cyrus::IMAP::Admin. Commands are provided in both Tcl-compatible forms
25 and GNU-style long option forms.
26
28 "authenticate" ["--minssf" N] ["--maxssf" N] ["--mechanisms" list]
29 [user]
30 "auth" ["--minssf" N] ["--maxssf" N] ["--mechanisms" list] [user]
31 "login" ["--minssf" N] ["--maxssf" N] ["--mechanisms" list] [user]
32 Authenticate to server. You must already be connected to a server
33 and Cyrus imapd will refuse to allow you to re-authenticate once
34 you have authenticated once.
35 "chdir" directory
37 "cd" directory
38 Change directory. A "pwd" builtin is not provided, but the default
39 command action will run "pwd" from a shell if invoked.
40 "createmailbox" ["--partition" partition] mailbox
42 "createmailbox" mailbox partition
43 "create" ["--partition" partition] mailbox
44 "create" mailbox partition
45 "cm" ["--partition" partition] mailbox
46 "cm" mailbox partition
47 Create a mailbox on the default or a specified partition. Both
48 old-style and getopt-style usages are accepted (combining them will
49 produce an error).
50 "deleteaclmailbox" mailbox id [...]
52 "deleteacl" mailbox id [...]
53 "dam" mailbox id [...]
54 Remove ACLs from the specified mailbox.
55 "deletemailbox" mailbox
57 "delete" mailbox
58 "dm" mailbox
59 Delete the specified mailbox.
60 Administrators do not have implicit delete rights on mailboxes.
62 Use the setaclmailbox command to grant the "k" permission to your
63 principal if you need to delete a mailbox you do not own.
64 Note that the online help admits to an optional host argument.
66 This argument is not currently used, and will be rejected with an
67 error if specified; it is reserved for IMSP.
68 "disconnect"
70 "disc"
71 Disconnect from the current server. The prompt will revert to
72 "cyradm>".
73 "exit" [number]
75 "quit" [number]
76 Exit cyradm, optionally with a specific exit status; the exit
77 status of the last command will be used if one is not specified.
78 help [command]
80 ? [command]
81 Show help for "command" or all commands.
82 "info" [mailbox]
84 Display the mailbox/server metadata.
85 listaclmailbox mailbox
87 listacl mailbox
88 lam mailbox
89 List ACLs on the specified mailbox.
90 "listmailbox" ["--subscribed"] [pattern [reference]]
92 "list" ["--subscribed"] [pattern [reference]]
93 "lm" ["--subscribed"] [pattern [reference]]
94 List all, or all subscribed, mailboxes matching the specified
95 pattern. The pattern may have embedded wildcards '*' or '%', which
96 match anything or anything except the separator character,
97 respectively.
98 Mailboxes returned will be relative to the specified reference if
100 one is specified. This allows a mailbox list to be limited to a
101 particular hierarchy.
102 In some cases when the '%' wildcard is used to end a pattern, it
104 may match an entry which is not a mailbox but which contains other
105 mailboxes. In this case, the entry will be parenthesized to
106 indicate that it is a root for other mailboxes, as opposed to a
107 mailbox itself.
108 "listquota" root
110 "lq" root
111 List quotas on specified root. If the specified mailbox path does
112 not have a quota assigned, an error will be raised; see
113 listquotaroot for a way to find the quota root for a mailbox.
114 "listquotaroot" mailbox
116 "lqm" mailbox
117 "lqr" mailbox?
118 show quota roots and quotas for mailbox
119 "mboxconfig" mailbox attribute value
121 "mboxcfg" mailbox attribute value
122 Set mailbox metadata. A value of "none" will remove the attribute.
123 The currently supported attributes are:
124 "comment"
126 Sets a comment or description associated with the mailbox.
127 "expire"
129 Sets the number of days after which messages will be expired
130 from the mailbox.
131 "news2mail"
133 Sets an email address to which messages injected into the
134 server via NNTP will be sent.
135 "sharedseen"
137 Enables the use of a shared \Seen flag on messages rather than
138 a per-user \Seen flag. The 's' right in the mailbox ACL still
139 controls whether a user can set the shared \Seen flag.
140 "sieve"
142 Indicates the name of the global sieve script that should be
143 run when a message is delivered to the shared mailbox (not used
144 for personal mailboxes).
145 "squat"
147 Indicates that the mailbox should have a squat index created
148 for it.
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,
164 connect to that server. It will prompt for automatic login unless
165 the "--noauthenticate" option is specified. (This may change; in
166 particular, 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"
179 ("lrswipkxte"), 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
186 during
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
196 mailbox 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 upon connection.
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
225 (subsequent 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
233 created 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
239 "STORAGE". The units are as defined in RFC 2087, groups of 1024
240 octets (i.e. Kilobytes). The value may be the special string
241 "none" which will remove the quota.
242 "version"
244 "ver"
245 Display the version info of the current server.
246 "xfermailbox" ["--partition" partition] mailbox server
248 "xfer" ["--partition" partition] mailbox server
249 "xfermailbox" mailbox server [partition]
250 "xfer" mailbox server [partition]
251 Transfer (relocate) the specified mailbox to a different server.
252 Both old-style and getopt-style usages are accepted; combining them
253 will produce an error.
254
256 GNU-style long options must be given in their entirety; Tcl-style
257 options may be abbreviated.
258 Tcl-style options are provided as a compatibility feature. They will
260 probably go away in the future.
261 Multiple commands can be given on a line, separated by ';' characters.
263 All commands set an exit status, which at present is not useful.
265 Unknown commands are passed to a subshell for execution.
267 The Tcl version of cyradm is used for scripting as well as
269 interactively. While this is possible to a limited extent by use of
270 the "run" method, scripting would normally be done with
271 "Cyrus::IMAP::Admin", which is far more flexible than either
272 interactive "cyradm" or the Tcl scripting mechanism for Cyrus.
273 cyradm understands /bin/sh-style redirection: any command can have its
275 standard or error output redirected, with all sh-style redirections
276 (except "<>") supported. It does not currently understand pipes or
277 backgrounding.
278 If the "Term::Readline::Perl" or "Term::Readline::GNU" modules are
280 available, cyradm will use it.
281 An alias facility is implemented internally, but no access is currently
283 provided to it. This will change, if only to allow some of the
284 predefined aliases to be removed if they conflict with useful shell
285 commands.
286
288 Brandon S. Allbery, allbery@ece.cmu.edu
289
291 Cyrus::IMAP::Admin Term::ReadLine sh(1), perl(1), imapd(8).
292perl v5.16.3 2012-12-01 IMAP::Shell(3)