Linux Manual Pages

Free Software * Books

Source Code

Free Media

Linux

IMAP::Admin

NAME
SYNOPSIS
DESCRIPTION
METHODS
AUTHOR
SEE ALSO

NAME

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

SYNOPSIS

  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]);

DESCRIPTION

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.

METHODS

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.
new($server[, $flags])

Instantiates a cyradm object. This is in fact an 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.)

error

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;

createmailbox($mailbox[, $partition])
create($mailbox[, $partition])

Create a new mailbox on the specified or default partition.

deletemailbox($mailbox)
delete($mailbox)

Delete a mailbox. As with cyradm, you will probably need to add the c ACL for yourself to the mailbox with "setaclmailbox" first.

deleteaclmailbox($mailbox, $user[, ...])
deleteacl($mailbox, $user[, ...])

Delete one or more ACL from a mailbox.

listaclmailbox($mailbox)
listacl($mailbox)

Returns a hash of mailbox ACLs, with each key being a Cyrus user and the corresponding value being the ACL .

listmailbox($pattern[, $reference])
list($pattern[, $reference])

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.)

listsubscribed($pattern[, $reference])
subscribed($pattern[, $reference])

Like "listmailbox" but only shows subscribed mailboxes.

listquota($root)
quota($root)

Returns a hash specifying the quota for the specified quota root. Use "listquotaroot" to find the quota root for a mailbox.

listquotaroot($mailbox)
quotaroot($mailbox)

Returns a list, the first element is the quota root for the mailbox and remaining elements are a hash specifying its quota.

renamemailbox($from, $to[, $partition])
rename($from, $to[, $partition])

Renames the specified mailbox, optionally moving it to a different partition.

setaclmailbox($mailbox, $user => $acl[, ...])
setacl($mailbox, $user => $acl[, ...])

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:

	l		Lookup (mailbox is visible to LIST/LSUB , SUBSCRIBE mailbox)
	r		Read ( SELECT/EXAMINE the mailbox, perform STATUS )
	s		Seen (set/clear \SEEN flag via STORE , also set \SEEN flag during

APPEND/COPY/FETCH BODY[...])

	w		Write flags other than \SEEN and \DELETED
	i		Insert ( APPEND , COPY destination)
	p		Post (send mail to mailbox)
	k		Create mailbox ( CREATE new sub-mailboxes, parent for new mailbox in RENAME )
	x		Delete mailbox ( DELETE mailbox, old mailbox name in RENAME )
	t		Delete messages (set/clear \DELETED flag via STORE , also set \DELETED

flag during APPEND/COPY )

	e		Perform EXPUNGE and expunge as part of CLOSE
	a		Administer ( SETACL/DELETEACL/GETACL/LISTRIGHTS )

setquota($mailbox, $resource, $quota[, ...])

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)

xfermailbox($mailbox, $server[, $partition])
xfer($mailbox, $server[, $partition])

Transfers (relocates) the specified mailbox to a different server.

AUTHOR

Brandon S. Allbery, allbery@ece.cmu.edu

Opportunity

Personal Opportunity - Free software gives you access to billions of dollars of software at no cost. Use this software for your business, personal use or to develop a profitable skill. Access to source code provides access to a level of capabilities/information that companies protect though copyrights. Open source is a core component of the Internet and it is available to you. Leverage the billions of dollars in resources and capabilities to build a career, establish a business or change the world. The potential is endless for those who understand the opportunity.

Business Opportunity - Goldman Sachs, IBM and countless large corporations are leveraging open source to reduce costs, develop products and increase their bottom lines. Learn what these companies know about open source and how open source can give you the advantage.

Free Software

Free Software provides computer programs and capabilities at no cost but more importantly, it provides the freedom to run, edit, contribute to, and share the software. The importance of free software is a matter of access, not price. Software at no cost is a benefit but ownership rights to the software and source code is far more significant.

Free Office Software - The Libre Office suite provides top desktop productivity tools for free. This includes, a word processor, spreadsheet, presentation engine, drawing and flowcharting, database and math applications. Libre Office is available for Linux or Windows.

Free Books

The Free Books Library is a collection of thousands of the most popular public domain books in an online readable format. The collection includes great classical literature and more recent works where the U.S. copyright has expired. These books are yours to read and use without restrictions.

Source Code - Want to change a program or know how it works? Open Source provides the source code for its programs so that anyone can use, modify or learn how to write those programs themselves. Visit the GNU source code repositories to download the source.

Education

Study at Harvard, Stanford or MIT - Open edX provides free online courses from Harvard, MIT, Columbia, UC Berkeley and other top Universities. Hundreds of courses for almost all major subjects and course levels. Open edx also offers some paid courses and selected certifications.

Linux Manual Pages - A man or manual page is a form of software documentation found on Linux/Unix operating systems. Topics covered include computer programs (including library and system calls), formal standards and conventions, and even abstract concepts.