Scroll to navigation

IMAP::Admin(3pm) User Contributed Perl Documentation IMAP::Admin(3pm)


Cyrus::IMAP::Admin - Cyrus administrative interface Perl module


  use Cyrus::IMAP::Admin;
  my $client = Cyrus::IMAP::Admin->new('mailhost'[, $flags]);
  $rc = $client->create('user.auser'[, $partition]);
  $rc = $client->delete('user.auser');
  $rc = $client->deleteacl('user.buser', 'user1', 'user2');
  %acls = $client->listacl('user.buser');
  @mailboxes = $client->list('*');
  @mailboxes = $client->list('%', 'user.');
  @mailboxes = $client->subscribed('*');
  %quota = $client->quota($root);
  ($root, %quota) = $client->quotaroot($mailbox);
  $rc = $client->rename($old, $new[, $partition]);
  $rc = $client->setacl($mailbox, $user =E<gt> $acl[, ...]);
  $rc = $client->setquota($mailbox, $resource =E<gt> $quota[, ...]);
  $rc = $client->xfer($mailbox, $server[, $partition]);


This module is a Perl interface to Cyrus administrative functions. It is used to implement Cyrus::IMAP::Admin::Shell (otherwise known as cyradm and also available for use in Perl administrative programs.


Many of the methods have a cyradm-compatible name and a shorter name. The shorter name is shown in the synopsis when it exists; the cyradm-compatible name should be reasonably obvious.

In general, methods return undef or empty lists on error. In some cases a method may return an empty list without an error (i.e. "list" of a nonexistent hierarchy), so it may be necessary to check the error state explicitly via the "error" method.

Instantiates a cyradm object. This is in fact a Cyrus::IMAP object with a few additional methods, so all Cyrus::IMAP methods are available if needed. (In particular, you will always want to use the "authenticate" method.)
Return the last error that occurred, or undef if the last operation was successful. This is in some cases (such as "list") the only way to distinguish between a successful return of an empty list and an error return.

Calling "error" does not reset the error state, so it is legal to write:

    @folders = $cyradm->list($spec);
    print STDERR "Error: ", $cyradm->error if $cyradm->error;
Create a new mailbox on the specified or default partition.
Delete a mailbox. As with cyradm, you will probably need to add the c ACL for yourself to the mailbox with "setaclmailbox" first.
Delete one or more ACL from a mailbox.
Returns a hash of mailbox ACLs, with each key being a Cyrus user and the corresponding value being the ACL.
List mailboxes matching the specified pattern, starting from the specified reference. The result is a list; each element is an array containing the mailbox name, attributes, and the separator. (This interface may change.)
Like "listmailbox" but only shows subscribed mailboxes.
Returns a hash specifying the quota for the specified quota root. Use "listquotaroot" to find the quota root for a mailbox.
Returns a list, the first element is the quota root for the mailbox and remaining elements are a hash specifying its quota.
Renames the specified mailbox, optionally moving it to a different partition.
Set ACLs on a mailbox. The ACL may be one of the special strings "none", "read" ("lrs"), "post" ("lrsp"), "append" ("lrsip"), "write" ("lrswipkxte"), "delete" ("lrxte"), or "all" ("lrswipkxte"), or any combinations of the ACL codes:
Lookup (mailbox is visible to LIST/LSUB, SUBSCRIBE mailbox)
Read (SELECT/EXAMINE the mailbox, perform STATUS)
Seen (set/clear \SEEN flag via STORE, also set \SEEN flag during
Write flags other than \SEEN and \DELETED
Insert (APPEND, COPY destination)
Post (send mail to mailbox)
Create mailbox (CREATE new sub-mailboxes, parent for new mailbox in RENAME)
Delete mailbox (DELETE mailbox, old mailbox name in RENAME)
Delete messages (set/clear \DELETED flag via STORE, also set \DELETED
flag during APPEND/COPY)
Perform EXPUNGE and expunge as part of CLOSE
Set quotas on a mailbox. Note that Cyrus currently only defines one resource, "STORAGE". As defined in RFC 2087, the units are groups of 1024 octets (i.e. Kilobytes)
Transfers (relocates) the specified mailbox to a different server.


Brandon S. Allbery,


Cyrus::IMAP Cyrus::IMAP::Shell perl(1), cyradm(1), imapd(8).

2022-07-10 perl v5.34.0