ImapCreate - Administracion de casillas en Cyrus IMAP

Este script facilita el alta de casillas en servidores IMAP, basados en Cyrus  IMAP. Hace varios años le hice alguna modificación, esta funcionando en varios sitios. 

No existe un repositorio central para el mismo, lo dejo acá. La ventaja de usar este script, frente a cyradm, para crear casillas esta en que fue pensado para ser utilizado desde scripts. Esta programado en PERL, utilizando las APIs de Cyrus. Crea la casilla, carpetas adicionales y fija la cuota de disco del usuario.

#!/usr/bin/perl -w
#
# imapcreate: create IMAP mailboxes with quotas
#            Reads user names from standard input.
# Originally found on http://cyrus-utils.sourceforge.net
# ©2001 Garry Mills
#
# Enhanced by Clement "nodens" Hermann <clement.hermann@free.fr>
# Minor enhacements by Andres Tarallo <atarallo@gmail.com>
#
# I'd like to consider this as GPL'd (cf www.gnu.org), but won't add any
# copyright without the original author's consent.
# last modification : 2005/11/03
# Changes :
# 2005/11/03 - Added the posibility to create specific folders.
# 2005/04/19 - Added non-0 exit code on error or warning.
# 2005/03/31 - Finally found out the original author's name.
# 2004/11/23 - removed LOGIN as a default mech, now use cyrus' default
# - Added --auth option to specify mech
#
# TODO : fix STDIN collision when reading password AND mailboxes name from STDIN
#
use Getopt::Long;
use Cyrus::IMAP::Admin;
#use strict;

# CLI options
my ($debug, $user, $pass, $quota, @part, $useunixhierarchy, @mailboxes, @folders, $delete, $cyrus, $authmech);

sub usage {
    print "imapcreate - create IMAP mailboxes with quotas\n";
   print " usage:\n";
    print " imapcreate [-d] [-u user] [--auth mechanism] [-p pass] [-m     mailbox1[,mailbox2] />[,mailbox]] [-q quota] [-t partition:list]\n";
    print " [-f folder1[,folder2][,folder][-s] [-v] \n";
    print "\n";
    print "if -s is set, we'll use the unix hierarchy separator (see imapd.conf(1))\n";
    print "if -d is set, we'll delete mailboxes instead of creating them\n";
   print "You can use M or ,m to specify quotas. e.g. 10M. By default,\n";
    print "the quota is expressed in Kbytes.\n";
   print "If no password is submitted with -p, we'll prompt for one.\n";
   print "if no mailbox name is specified with -m, read user names from standard input\n";
   print "if -v is set, we'll run in debug mode, and print information on stdout\n";
    print "\n";
    print "The default mechanism is used for authentication. If you need another\nmechanism, (try LOGIN), use --auth option\n";
    print "\n";
    print " example: \n";
    print " imapcreate -u cyradm -m foo,bar,joe -q 50000 -t p1:p2  mail.testing.umanitoba.ca\n";
   print "\n";
   exit 0;
}

# Create a mailbox... usage : &CreateMailBox(user,partition[,quota]).
# You have to be authentified already. We use "$cyrus" as the connection name.
# partition can be 'default'
sub CreateMailBox {
   my $mbuser = $_[0];
   my $mbpart = $_[1];
   my $mbquota = $_[2];
   my $retval = 0;

   print "Creating $mbuser on $mbpart\n" if $debug;
   if ($mbpart eq 'default') {
      $cyrus->createmailbox($mbuser);
   } else {
      $cyrus->createmailbox($mbuser, $mbpart);
   }
   if ($cyrus->error) {
      warn $cyrus->error;
      $retval = 1;
   }

# Set the quota
   if ($mbquota){
      print "Setting quota for $mbuser to $mbquota\n" if $debug
      $cyrus->setquota($mbuser, 'STORAGE', $mbquota);
      if ($cyrus->error) {
         warn $cyrus->error;
         $retval = 1;
      }
   }
   return $retval;
}

# Create a Folder. Usage: &CreateFolder($folder, $part)
sub CreateFolder {
   my $folder = $_[0];
   my $mbpart = $_[1];
   my $retval = 0;

   print "Creating $folder on $mbpart\n" if $debug;
   if ($folder eq 'default') {
      $cyrus->createmailbox($folder);
   } else {
      $cyrus->createmailbox($folder, $mbpart);
   }
   if ($cyrus->error) {
      warn $cyrus->error;
      $retval = 1;
   }
   return $retval;
}

# Delete a mailbox. Usage: &DeleteMailBox($user)
# Assuming we use $user as the admin.
sub DeleteMailbox {
    my $mbuser = $_[0];
    my $delacl = "c";
    my $retval = 0;

    print "Deleting $mbuser\n" if $debug;
    $cyrus->setaclmailbox($mbuser, $user, $delacl);
    $cyrus->deletemailbox($mbuser);
    if ($cyrus->error) {
       warn $cyrus->error;
       $retval = 1;
    }
    return $retval;
}

GetOptions( "d|delete" => \$delete,
    "u|user=s" => \$user,
    "auth=s" => \$authmech,
    "p|pass=s" => \$pass,
    "f|folders=s" => \@folders,
    "m|mailboxes=s" => \@mailboxes,
    "q|quota=s" => \$quota,
    "s|UnixHierarchy" => \$useunixhierarchy,
    "t|part=s" => \@part,
    "v|verbose" => \$debug );

@part = split(/:/, join(':', @part));
push @part, 'default' unless @part;
my $pn = 0;
@mailboxes = split(/,/, join(',', @mailboxes));
@folders = split(/,/, join(',', @folders));
my $server = shift(@ARGV) if (@ARGV);

usage unless $server;

# quotas formatting:
if ($quota) {
   if ($quota =~ /^(\d+)([mk]?)$/i) {
      my $numb = $1;
      my $letter = $2;
      if ($letter =~ /^m$/i) {
         $quota = $numb * 1024;
         print "debug: quota=$quota\n" if $debug;
      } elsif ($letter =~ /^k$/i) {
         $quota = $numb;
         print "debug: quota=$quota\n" if $debug;
      } else {
         die "malformed quota: $quota (must be at least one digit eventually followed by m, M, k or K\n";
      }
  } else {
      die "malformed quota: $quota (must be at least one digit eventually followed by m, M, k or K\n";
  }
}

# Authenticate
$cyrus = Cyrus::IMAP::Admin->new($server);
die "Can't connect to $server\n" if ( ! (defined $cyrus) );
if ($authmech) {
    $cyrus->authenticate(-mechanism => $authmech,
       -user => $user,
       -password => $pass);
} else {
    $cyrus->authenticate(
       -user => $user,
       -password => $pass);
}
die $cyrus->error if $cyrus->error;
# if there isn't any mailbox defined yet, get them from standard input
if (! (defined $mailboxes[0])) {
# For all users
   while (<>) {
      chomp;
      my $mbox = $_;
      push @mailboxes, $mbox;
   }
}
# create/delete mailboxes for each user
my $return = 0;
foreach my $mailbox (@mailboxes) {
   my $username = $mailbox;
   if ($useunixhierarchy) {
      $mailbox = 'user/' . $mailbox;
   } else {
        $mailbox = 'user.' . $mailbox;
   }
   if ($delete) {
       my $retval = 0;
      # We should delete childrens
      if (defined $folders[0]) {
         foreach my $folder (@folders) {
            my $f;
            if ($useunixhierarchy) {
               $f = $mailbox.'/'.$folder;
            } else {
              $f = $mailbox.'.'.$folder;
            }
            $retval = &DeleteMailbox($f);
         }
      }
# Finally we delete the Mailbox
     $retval = &DeleteMailbox($mailbox);
     $return = $retval if ($retval != 0);
   } else {
# Select the partition
     my $pt = $part[$pn];
     $pn += 1;
     $pn = 0 unless $pn < @part;
     my $retval = &CreateMailBox($mailbox,$pt,$quota);
     # Creation of aditional Folders.
     if ($retval == 0 && (defined $folders[0]) ) {
        foreach my $folder (@folders) {
           my $f;
           if ($useunixhierarchy) {
              $f = $mailbox.'/'.$folder;
           } else {
              $f = $mailbox.'.'.$folder;
           }
           $retval = &CreateFolder($f,$pt);
           last if $retval;
        }
     }
# We've created the mailbox and eventually aditional folders.
    if ($retval == 0 ) {
       my @acl;
       $cyrus->setacl($mailbox, 'cyrus' => "all");
       $cyrus->setacl($mailbox, $username => "all");
    }
    $return = $retval if ($retval != 0);
  }
}
exit $return;