1IMAP::Admin(3) User Contributed Perl Documentation IMAP::Admin(3)
2
6 Cyrus::IMAP::Admin - Cyrus administrative interface Perl module
7
9 use Cyrus::IMAP::Admin;
10 my $client = Cyrus::IMAP::Admin->new('mailhost'[, $flags]);
12 $rc = $client->create('user.auser'[, $partition]);
13 $rc = $client->delete('user.auser');
14 $rc = $client->deleteacl('user.buser', 'user1', 'user2');
15 %acls = $client->listacl('user.buser');
16 @mailboxes = $client->list('*');
17 @mailboxes = $client->list('%', 'user.');
18 @mailboxes = $client->subscribed('*');
19 %quota = $client->quota($root);
20 ($root, %quota) = $client->quotaroot($mailbox);
21 $rc = $client->rename($old, $new[, $partition]);
22 $rc = $client->setacl($mailbox, $user =E<gt> $acl[, ...]);
23 $rc = $client->setquota($mailbox, $resource =E<gt> $quota[, ...]);
24 $rc = $client->xfer($mailbox, $server[, $partition]);
25
27 This module is a Perl interface to Cyrus administrative functions. It
28 is used to implement Cyrus::IMAP::Admin::Shell (otherwise known as
29 cyradm and also available for use in Perl administrative programs.
30
32 Many of the methods have a cyradm-compatible name and a shorter name.
33 The shorter name is shown in the synopsis when it exists; the
34 cyradm-compatible name should be reasonably obvious.
35 In general, methods return undef or empty lists on error. In some
37 cases a method may return an empty list without an error (i.e. "list"
38 of a nonexistent hierarchy), so it may be necessary to check the error
39 state explicitly via the "error" method.
40 new($server[, $flags])
42 Instantiates a cyradm object. This is in fact a Cyrus::IMAP object
43 with a few additional methods, so all Cyrus::IMAP methods are
44 available if needed. (In particular, you will always want to use
45 the "authenticate" method.)
46 error
48 Return the last error that occurred, or undef if the last operation
49 was successful. This is in some cases (such as "list") the only
50 way to distinguish between a successful return of an empty list and
51 an error return.
52 Calling "error" does not reset the error state, so it is legal to
54 write:
55 @folders = $cyradm->list($spec);
57 print STDERR "Error: ", $cyradm->error if $cyradm->error;
58 createmailbox($mailbox[[, $partition], \%opts])
60 create($mailbox[, $partition])
61 Create a new mailbox on the specified or default partition.
62 deletemailbox($mailbox)
64 delete($mailbox)
65 Delete a mailbox. As with cyradm, you will probably need to add
66 the c ACL for yourself to the mailbox with "setaclmailbox" first.
67 deleteaclmailbox($mailbox, $user[, ...])
69 deleteacl($mailbox, $user[, ...])
70 Delete one or more ACL from a mailbox.
71 listaclmailbox($mailbox)
73 listacl($mailbox)
74 Returns a hash of mailbox ACLs, with each key being a Cyrus user
75 and the corresponding value being the ACL.
76 listmailbox($pattern[[, $reference], \%opts])
78 list($pattern[[, $reference], \%opts])
79 List mailboxes matching the specified pattern, starting from the
80 specified reference. The result is a list; each element is an
81 array containing the mailbox name, attributes, and the separator.
82 (This interface may change.)
83 listsubscribed($pattern[, $reference])
85 subscribed($pattern[, $reference])
86 Like "listmailbox" but only shows subscribed mailboxes.
87 listquota($root)
89 quota($root)
90 Returns a hash specifying the quota for the specified quota root.
91 Use "listquotaroot" to find the quota root for a mailbox.
92 listquotaroot($mailbox)
94 quotaroot($mailbox)
95 Returns a list, the first element is the quota root for the mailbox
96 and remaining elements are a hash specifying its quota.
97 renamemailbox($from, $to[, $partition])
99 rename($from, $to[, $partition])
100 Renames the specified mailbox, optionally moving it to a different
101 partition.
102 setaclmailbox($mailbox, $user => $acl[, ...])
104 setacl($mailbox, $user => $acl[, ...])
105 Set ACLs on a mailbox. The ACL may be one of the special strings
106 "none", "read" ("lrs"), "post" ("lrsp"), "append" ("lrsip"),
107 "write" ("lrswipkxte"), "delete" ("lrxte"), or "all"
108 ("lrswipkxte"), or any combinations of the ACL codes:
109 l Lookup (mailbox is visible to LIST/LSUB, SUBSCRIBE mailbox)
111 r Read (SELECT/EXAMINE the mailbox, perform STATUS)
113 s Seen (set/clear \SEEN flag via STORE, also set \SEEN flag
115 during
116 APPEND/COPY/FETCH BODY[...])
117 w Write flags other than \SEEN and \DELETED
119 i Insert (APPEND, COPY destination)
121 p Post (send mail to mailbox)
123 k Create mailbox (CREATE new sub-mailboxes, parent for new
125 mailbox in RENAME)
126 x Delete mailbox (DELETE mailbox, old mailbox name in RENAME)
128 t Delete messages (set/clear \DELETED flag via STORE, also set
130 \DELETED
131 flag during APPEND/COPY)
132 e Perform EXPUNGE and expunge as part of CLOSE
134 a Administer (SETACL/DELETEACL/GETACL/LISTRIGHTS)
136 setquota($mailbox, $resource, $quota[, ...])
138 Set quotas on a mailbox. Note that Cyrus currently only defines
139 one resource, "STORAGE". As defined in RFC 2087, the units are
140 groups of 1024 octets (i.e. Kilobytes)
141 xfermailbox($mailbox, $server[, $partition])
143 xfer($mailbox, $server[, $partition])
144 Transfers (relocates) the specified mailbox to a different server.
145
147 Brandon S. Allbery, allbery@ece.cmu.edu
148
150 Cyrus::IMAP Cyrus::IMAP::Shell perl(1), cyradm(1), imapd(8).
151perl v5.38.0 2023-09-13 IMAP::Admin(3)