CommuniGate Pro Perl Interface

---

Named Task Administration Commands

ListDomainNamedTasks( [domain] )

ListAccountNamedTasks(account)

CreateNamedTask(taskName,account)

RenameNamedTask(taskName,newName)

DeleteNamedTask(taskName)

GetNamedTask(taskName)

UpdateNamedTask(taskName,settings)

---

Domain Administration Commands

ListDomains

Example:

  my $DomainList = $cli->ListDomains()
     || die "Can't get the domain list: ".$cli->getErrMessage.", quitting";
  print "The domain(s):\n";
  print "  $_\n" foreach(@$DomainList);

MainDomainName

Example:

  my $MainDomainName=$cli->MainDomainName()
     || die "Error: ".$cli->getErrMessage.", quitting";
  print "The main domain name is $MainDomainName\n";

GetDomainSettings( [domainName] )

Example:

  if($Settings=$cli->GetDomainSettings) {
    print "The domain settings are:\n";
      print "  $_ = \"@$Settings{$_}\"\n" foreach (keys %$Settings);
  } else {
    die "Error: ".$cli->getErrMessage.", quitting" if(!$cli->isSuccess);
  }

GetDomainEffectiveSettings( [domainName] )

UpdateDomainSettings(domain => domainName, settings => newSettings)

Example:

  $cli->UpdateDomainSettings(domain => 'www.company.com',
                     settings => { WebUserCache => "NO" })
        || die "Error: ".$cli->getErrMessage.", quitting";

SetDomainSettings(domain => domainName, settings => newSettings)

CreateDomainStorage($path[,'SHARED'])

Example:

$cli->CreateDomainStorage("Volume1",'SHARED')
 || die "Can't create mount point: ".$cli->getErrMessage.", quitting";

ListDomainStorage(['SHARED'])

Example:

my $data=$cli->ListDomainStorage('SHARED');
die "Error: ".$cli->getErrMessage.", quitting" if(!$cli->isSuccess);
print "mount point: $_\n" foreach(@$data);

CreateDomain(domainName [, settings [,$path[,'SHARED']]])

Example:

  $cli->CreateDomain('mail.company.com',{AutoSignup => 'YES'})
        || die "Error: ".$cli->getErrMessage.", quitting";

CreateDirectoryDomain(domainName, [ settings ])

RenameDomain(oldDomainName,newDomainName)

Example:

  $cli->RenameDomain('old.company.com','new.company.com')
        || die "Error: ".$cli->getErrMessage.", quitting";

DeleteDomain(domainName, [force])

Example:

  $cli->DeleteDomain('test.company.com',1)
        || die "Error: ".$cli->getErrMessage.", quitting";

SuspendDomain(domainName)

ResumeDomain(domainName)

CreateAccountStorage(domainName,path)

ListAccountStorage(domainName)

Example:

$cli->CreateDomainStorage('test.company.com',"my_dir")
 || die "Can't create mount point: ".$cli->getErrMessage.", quitting";

my $data=$cli->ListAccountStorage('test.company.com');
die "Error: ".$cli->getErrMessage.", quitting" if(!$cli->isSuccess);
print "mount point: $_\n" foreach(@$data);

GetDomainAliases(domainName)

Example:

  if($Aliases=$cli->GetDomainAliases('company.com')) {
    print "The aliases are:\n";
    print "  $_\n" foreach (@$Aliases);
  } else {
    ($cli->isSuccess) ? print "No aliases\n"
                      : die "Error: ".$cli->getErrMessage.", quitting";
  }

SetDomainAliases(domainName, newAliases)

Example:

  my @Aliases=(
    'mail.company.com',
    'smtp.company.com'
  );
  $cli->SetDomainAliases('company.com',\@Aliases)
        || die "Error: ".$cli->getErrMessage.", quitting";

GetDomainMailRules(domainName)

SetDomainMailRules(domainName, newRules)

GetDomainSignalRules(domainName)

SetDomainSignalRules(domainName, newRules)

ListAdminDomains( [domainName] )

Example:

  my $DomainList = $cli->ListAdminDomains('company.com')
     || die "Can't get the list of admin domains: ".$cli->getErrMessage.", quitting";
  print "The admin domain(s):\n";
  print "  $_\n" foreach(@$DomainList);

InsertDirectoryRecords( [domainName] )

DeleteDirectoryRecords( [domainName] )

GetServerTrustedCerts()

SetServerTrustedCerts(newCertificates)

GetClusterTrustedCerts()

SetClusterTrustedCerts(newCertificates)

GetDirectoryIntegration

Example:

  if($Settings=$cli->GetDirectoryIntegration) {
    print "The directory integration settings are:\n";
    foreach (keys %$Settings) {
      my $data=@$Settings{$_};
      print "  $_ = ";
      if(ref ($data) eq 'ARRAY') {
        print join(",",@$data)."\n";    
      }elsif(ref($data) eq 'HASH') {
        print "{";
        print "$_=@$data{$_};" foreach (keys %$data);
        print "}\n";    
      } else {
        print "\"$data\"\n";
      }
    }
  } else {
    die "Error: ".$cli->getErrMessage.", quitting" if(!$cli->isSuccess);
  }

SetDirectoryIntegration(newSettings)

Example:

  $Settings=$cli->GetDirectoryIntegration()
    || die "Error: ".$cli->getErrMessage.", quitting";
  my $Attributes=@$Settings{'CustomAttributes'};
  push(@$Attributes,"MyAttr");
  $cli->SetDirectoryIntegration($Settings)
    || die "Error: ".$cli->getErrMessage.", quitting";

GetClusterDirectoryIntegration

SetClusterDirectoryIntegration(newSettings)

GetDomainDefaults

Example:

  if($Defaults=$cli->GetDomainDefaults()) {
    print "The default domain settings are:\n";
    print "  $_ = \"@$Defaults{$_}\"\n" foreach (keys %$Defaults);
  } else {
    ($cli->isSuccess) ? print "No default domain settings.\n"
                      : die "Error: ".$cli->getErrMessage.", quitting";
  }

UpdateDomainDefaults(newSettings)

Example:

  $cli->UpdateDomainDefaults({MailToUnknown => "Rejected"})
        || die "Error: ".$cli->getErrMessage.", quitting";

SetDomainDefaults(newSettings)

GetClusterDomainDefaults

UpdateClusterDomainDefaults(newSettings)

SetClusterDomainDefaults(newSettings)

GetServerAccountDefaults

Example:

  if($Defaults=$cli->GetServerAccountDefaults()) {
    print "The default settings are:\n";
    print "  $_ = \"@$Defaults{$_}\"\n" foreach (keys %$Defaults);
  } else {
    ($cli->isSuccess) ? print "No default settings.\n"
                      : die "Error: ".$cli->getErrMessage.", quitting";
  }

UpdateServerAccountDefaults(newSettings)

Example:

  $cli->UpdateServerAccountDefaults({AccessModes => "All"})
        || die "Error: ".$cli->getErrMessage.", quitting";

SetServerAccountDefaults(newSettings)

GetClusterAccountDefaults

SetClusterAccountDefaults(newSettings)

UpdateClusterAccountDefaults(newSettings)

GetServerAccountPrefs

UpdateServerAccountPrefs(newSettings)

SetServerAccountPrefs(newSettings)

GetClusterAccountPrefs

UpdateClusterAccountPrefs(newSettings)

SetClusterAccountPrefs(newSettings)

GetDomainLocation(domainName)

Example:

  if($path=$cli->GetDomainLocation('company.com')) {
       print "The domain directory is /var/CommuniGate/$path\n";
     } else {
       die "Error: ".$cli->getErrMessage.", quitting";
  }

ListServerTelnums (limit[,filter] )

ListClusterTelnums (limit[,filter] )

GetAccountDefaults( [domainName ] )

Example:

  if($Defaults=$cli->GetAccountDefaults) {
    print "The account defaults are:\n";
    print "  $_ = \"@$Defaults{$_}\"\n" foreach (keys %$Defaults);
  } else {
    die "Error: ".$cli->getErrMessage.", quitting" if(!$cli->isSuccess);
  }

UpdateAccountDefaults( domain => domainName, settings => newSettings)

Example:

  $cli->UpdateAccountDefaults(domain => 'company.com',
                              settings => {MaxAccountSize => '100K'})
        || die "Error: ".$cli->getErrMessage.", quitting";

SetAccountDefaults( domain => domainName, settings => newSettings)

GetAccountDefaultPrefs( [domainName ] )

Example:

  if($Defaults=$cli->GetAccountDefaultPrefs()) {
    print "The WebUser defaults are:\n";
    print "  $_ = \"@$Defaults{$_}\"\n" foreach (keys %$Defaults);
  } else {
    die "Error: ".$cli->getErrMessage.", quitting" if(!$cli->isSuccess);
  }

SetAccountDefaultPrefs( domain => domainName, settings => newSettings)

UpdateAccountDefaultPrefs( domain => domainName, settings => newSettings)

Example:

  my %Settings=(
    Charset =>  'ISO-8859-1',
    Fields =>  [ qw(From Sender Subject Date To Cc) ]
  );

  $cli->UpdateAccountDefaultPrefs(settings=>\%Settings)
        || die "Error: ".$cli->getErrMessage.", quitting";

GetAccountTemplate( [domainName] )

Example:

  if($Template=$cli->GetAccountTemplate) {
    print "The template account settings are:\n";
      print "  $_ = \"@$Template{$_}\"\n" foreach (keys %$Template);
  } else {
    die "Error: ".$cli->getErrMessage.", quitting" if(!$cli->isSuccess);
  }

UpdateAccountTemplate(domain => domainName, settings => newSettings);

Example:

  $cli->UpdateAccountTemplate(domain => 'company.com',
                         settings => { RealName => 'Unnamed',Password => ''})
        || die "Error: ".$cli->getErrMessage.", quitting";

SetAccountTemplate(domain => domainName, settings => newSettings);

---

Mailbox Administration Commands

ListMailboxes(accountName => account,[ filter => '*',] [authAccountName => extAccount]);

Example:

  my $Boxes= $cli->ListMailboxes(accountName=>'john',filter=>'INBOX*')
     || die "Error: ".$cli->getErrMessage.", quitting";

  foreach (sort keys %$Boxes) {
    print "$_\n";
    my $data=@$Boxes{$_};
    if(ref $data eq 'ARRAY') {
      $data=@$data[0];
    }   
    if(ref $data eq 'HASH') {
      foreach (keys %$data) {
        print "  $_ = @$data{$_}\n";
      }
    }
  }

CreateMailbox(accountName,mailboxName[,authAccountName]);

Example:

  $cli->CreateMailbox('john','SharedItems') 
    || die "Error: ".$cli->getErrMessage.", quitting";

RenameMailbox(accountName,oldMailboxName,newMailboxName[,authAccountName]);

RenameMailboxes(accountName,oldMailboxName,newMailboxName[,authAccountName]);

Example:

  $cli->RenameMailbox('john','myItems','SharedItems') 
    || die "Error: ".$cli->getErrMessage.", quitting";

DeleteMailbox(accountName,mailboxName[,authAccountName]);

DeleteMailboxes(accountName,mailboxName[,authAccountName]);

Example:

  $cli->DeleteMailbox('john','SharedItems') 
    || die "Error: ".$cli->getErrMessage.", quitting";

GetMailboxInfo(accountName,mailboxName[,authAccountName]);

Example:

  my $info = $cli->GetMailboxInfo('john','SharedItems')
           || die "Error: ".$cli->getErrMessage.", quitting";

  foreach (sort keys %$info) {
    my $data=@$info{$_};
    if(ref $data eq 'HASH') {
      print "  $_:\n";
      foreach (keys %$data) {
        print "    $_ = @$data{$_}\n";
      }
    } else {
      print "  $_ = @$info{$_}\n";
    }
  }

GetMailboxACL(accountName,mailboxName[,authAccountName]);

Example:

  my $acl = $cli->GetMailboxACL('john','SharedItems')
           || die "Error: ".$cli->getErrMessage.", quitting";
  foreach (keys %$acl) {
    print "  $_ = @$acl{$_}\n";
  }

SetMailboxACL(accountName,mailboxName,newACL[,authAccountName]);

Example:

  my %newACL=(
    "boss" =>  'ipcda',
    "+susan" =>  'lrsw',
  );
  $cli->SetMailboxACL('john','SharedItems',\%newACL)
    || die "Error: ".$cli->getErrMessage.", quitting";

GetMailboxRights(accountName,mailboxName,authAccountName);

Example:

  if($Rights= $cli->GetMailboxRights('john','SharedItems','boss')) {
    print "The rights = $Rights\n";
  } else {
    ($cli->isSuccess) ? print "The boss account has no rights to access this mailbox\n"
                       : die "Error: ".$cli->getErrMessage.", quitting";
  }

SetMailboxClass(accountName,mailboxName,class [,authAccountName]);

Example:

  $cli->SetMailboxClass('john','Calendar','IPF.Appointment')
    || die "Error: ".$cli->getErrMessage.", quitting";

GetMailboxSubscription(accountName);

Example:

  if($Subscription= $cli->GetMailboxSubscription('john')) {
    print "The subscription: ".join(",",@$Subscription)."\n";
  } else {
    ($cli->isSuccess) ? print "This account has no subscribed mailboxes\n"
                       : die "Error: ".$cli->getErrMessage.", quitting";
  }

SetMailboxSubscription(accountName,newSubscription);

Example:

  $Subscription= $cli->GetMailboxSubscription('john')
    || die "Error: ".$cli->getErrMessage.", quitting";
  push(@$Subscription,'~user@company.com/INBOX');
  $cli->SetMailboxSubscription('john',$Subscription)
    || die "Error: ".$cli->getErrMessage.", quitting"; 

GetMailboxAliases(accountName);

Example:

  if($Aliases=$cli->GetMailboxAliases('john')) {
    print "The aliases are:\n";
    foreach (keys %$Aliases) {
      print " $_ = @$Aliases{$_}\n";
    }
  } else {
     ($cli->isSuccess) ? print "No aliases\n"
       : die "Error: ".$cli->getErrMessage.", quitting";
  }

SetMailboxAliases(accountName,newAliases);

Example:

  $Aliases=$cli->GetMailboxAliases('john')
      || die "Error: ".$cli->getErrMessage.", quitting";
  @$Aliases{'ExternalBox'}='~user@company.com/INBOX';
  $cli->SetMailboxAliases('john',$Aliases)
      || die "Error: ".$cli->getErrMessage.", quitting";

---

Alert Administration Commands

GetDomainAlerts( [domainName] )

Example:

  $Alerts=$cli->GetDomainAlerts('company.com')
          || die "Error: ".$cli->getErrMessage.", quitting";

  foreach(keys %$Alerts) {
    my ($xx,$yr,$mn,$dy,$hr,$min,$sec)=split(/(\d\d\d\d)(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)/);
    print "$dy.$mn.$yr $hr:$min:$sec - @$Alerts{$_}\n";
  }

SetDomainAlerts(domainName,alerts)

Example:

  my %Alerts =(
    '19991225235959' => 'Merry Christmas!',
    '20000101000000' => 'Happy New Year!',
  );
  $cli->SetDomainAlerts('company.com',\%Alerts)
        || die "Error: ".$cli->getErrMessage.", quitting";

PostDomainAlert(domainName,alert)

Example:

   $cli->PostDomainAlert('company.com',"We're shutting down in 10 minutes!")
        || die "Error: ".$cli->getErrMessage.", quitting";

RemoveDomainAlert(domainName,timeStamp)

Example:

   $cli->PostDomainAlert('company.com','20000101000000')
        || die "Can't remove the NewYear alert: ".$cli->getErrMessage.", quitting";

GetAccountAlerts(accountName)

SetAccountAlerts(accountName,alerts)

PostAccountAlert(accountName,alert)

RemoveAccountAlert(accountName,timeStamp)

GetServerAlerts()

SetServerAlerts(alerts)

PostServerAlert(alert)

RemoveServerAlert(timeStamp)

GetClusterAlerts()

SetClusterAlerts(alerts)

PostClusterAlert(alert)

RemoveClusterAlert(timeStamp)

---

File Storage Administration

ReadStorageFile(accountName,fileName [,position,sliceSize[,authAccountName]])

Example:

  $data=$cli->ReadStorageFile('john','logo.gif')
   || die "Error: ".$cli->getErrMessage.", quitting";
  print "File data=$data->[0]\n";
  print "File modification date: @$data[1] size: @$data[2]\n";

WriteStorageFile(accountName,fileName,data [,position[,authAccountName]]

RenameStorageFile(accountName,oldFileName,newFileName[,authAccountName])

Example:

  $cli->RenameStorageFile('john','StalkerLogo.gif','logo.gif')
   || die "Error: ".$cli->getErrMessage.", quitting";

DeleteStorageFile(accountName,fileName[,authAccountName])

Example:

  $cli->DeleteStorageFile('john','logo.gif')
   || die "Error: ".$cli->getErrMessage.", quitting";

ListStorageFiles(accountName [,filePath[,authAccountName]])

Example:

  if($Files=$cli->ListStorageFiles('john')) {
    print "The files are:\n";
    print "  $_\n" foreach (keys %$Files);
  } else {
    ($cli->isSuccess) ? print "No web files.\n"
                      : die "Error: ".$cli->getErrMessage.", quitting";
  }

GetStorageFileInfo(accountName[,filePath[,authAccountName])

Example:

  $data=$cli->GetStorageFileInfo('john')
   || die "Error: ".$cli->getErrMessage.", quitting";
  print "There are $data->[1] files $data->[0] bytes total\n";

---

Mailing Lists Administration Commands

ListLists( [domainName] )

Example:

  if($Lists=$cli->ListLists('company.com')) {
    print "The lists are:\n";
    print "  $_\n" foreach (@$Lists);
  } else {
    ($cli->isSuccess) ? print "No lists.\n"
                      : die "Error: ".$cli->getErrMessage.", quitting";
  }

GetDomainLists( [domainName] )

Example:

  $Lists=$cli->GetDomainLists('company.com')) 
    || die "Error: ".$cli->getErrMessage.", quitting";
    print "The lists are:\n";
    foreach (keys %$Lists) {
      my $nSubs=@$Lists{$_};
      $nSubs='unknown' if $nSubs==-1;
      print " $_ ($nSubs)\n";
    }

GetAccountLists(accountName)

Example:

  $Lists=$cli->GetAccountLists('listmaster')) 
    || die "Error: ".$cli->getErrMessage.", quitting";
    print "The lists are:\n";
    foreach (keys %$Lists) {
      my $nSubs=@$Lists{$_};
      $nSubs='unknown' if $nSubs==-1;
      print " $_ ($nSubs)\n";
    }

CreateList(listName,accountName)

Example:

  $cli->CreateList('TestList@company.com','john')
        || die "Error: ".$cli->getErrMessage.", quitting";

RenameList(listName,newName)

Example:

  $cli->RenameList('TestList@company.com','InfoList')
        || die "Error: ".$cli->getErrMessage.", quitting";

DeleteList(listName)

Example:

  $cli->DeleteList('InfoList@company.com')
        || die "Error: ".$cli->getErrMessage.", quitting";

GetList(listName)

Example:

  if($Settings=$cli->GetList('TestList@company.com')) {
    print "The list settings are:\n";
    print "  $_ = \"@$Settings{$_}\"\n" foreach (keys %$Settings);
  } else {
    ($cli->isSuccess) ? print "Nothing...\n"
                      : die "Error: ".$cli->getErrMessage.", quitting";
  }

UpdateList(listName,newSettings)

Example:

  $cli->UpdateList('TestList@company.com',{RealName => "the test list"})
        || die "Error: ".$cli->getErrMessage.", quitting";

List(listName, operation, subscriber, [options])

Example:

  $cli->List("myList", 'subscribe',
             '"John Smith" <john@company.com>',
             'silently','confirm')
        || die "Can't subscribe John: ".$cli->getErrMessage.", quitting";

ListSubscribers(listName [, filter[, limit]])

Example:

  my $subscribers=$cli->ListSubscribers("myList", '', 10)
        || die "Can't list subscribers: ".$cli->getErrMessage.", quitting";
  print "  $_\n" foreach(@$subscribers);

GetSubscriberInfo(listName,subscriberAddress)

Example:

if($Infos=$cli->GetSubscriberInfo('TestList@company.com','user@domain.com')) {
  print "The subscriber info:\n";
  foreach (keys %$Infos) {
    print "  $_ = \"@$Infos{$_}\"\n";
  }
} else {
  die "Error: ".$cli->getErrMessage.", quitting";
}

SetPostingMode(listName,subscriberAddress, mode)

Example:

  $cli->SetPostingMode('TestList@company.com','user@domain.com',"UNMODERATED")
        || die "Error: ".$cli->getErrMessage.", quitting";