Cyrus-mbox

This is a small console tool which allows to create, modify or delete Cyrus mailboxes according to a predefined scheme (inlcluding subfolders).

cyrus-mbox doesn't create mail accounts! It is supposed, that accounts are administrated independently.

The configuration can be customized in the file /etc/cyrus-mbox.conf.

cyrus-mbox-0.4.0 (hjb -- 2008-04-27)
Mailbox administration tool for Cyrus IMAPd

usage: cyrus-mbox -i mbox

       cyrus-mbox [ -q n ] [ -f list ] [ -r acl ] -c mbox

       cyrus-mbox [ -q n ] [ -f list ] [ -r acl ] -m mbox

       cyrus-mbox -d mbox

       cyrus-mbox -l

       cyrus-mbox -h
  mbox           mailbox name

options:
  -h             Display this help
  -v level       Be verbose if level > 0 (default: 1)
  -C file        Use config file instead of /etc/cyrus-mbox.conf
  -i mbox        Show infos about mailbox mbox
  -l             List alls mailboxes and show some numbers
  -d mbox        Delete mailbox mbox including all subfolders
  -D mbox        Same as -d but without asking "Are you really sure...?"
  -c mbox        Create mailbox mbox
  -m mbox        Modify mailbox mbox
  -q n           Set quota to n MB (n=0: none; default: 1024)
  -f list        Create additional subfolders (default: 'Learn Learn.Spam Learn.Ham')
                 (folders 'Trash Sent Drafts Templates' are created anyway)
  -r acl         Set access list of owner for all folders to acl (default: lrswipcda)
  -s server      IMAP server (default: localhost)
  -a admin       Cyrus admin (default: cyrus)
  -p password    Cyrus admin's password
                 If -p is omitted or empty cyrus-mbox tries to read the password from 
                 /etc/imap.pwd first. If this file doesn't exist, 
                 cyrus-mbox asks for the password.
Options -v, -C, -s, -a, and -p  can be used in any case.  
examples:
  Get informations about bill's mailbox
    # cyrus-mbox -i bill
  Create mailbox for fred including default subfolders and set a 50 MB quota:
    # cyrus-mbox -q 50 -p secret -c fred
  Delete wilma's mailbox including all subfolders:
    # cyrus-mbox -v1 -p secret -d wilma
  Set the quota of simon's mailbox to 30 MB:
    # cyrus-mbox -q 30 -m simon