Win32::Exchange::Mailbox - Exchange 5.5, 2000 and 2003 mailbox maintenance functions


NAME

Win32::Exchange::Mailbox - Exchange 5.5, 2000 and 2003 functions


SYNOPSIS

  $provider = Win32::Exchange::Mailbox->new($info_store_server)) ||
      die " - error creating new object\n';

  #--- Exchange 5.5
  $mailbox = $provider->CreateMailbox($mailbox_alias_name);
  if (!$mailbox) {
    die "Error creating mailbox\n";
  }
  print "Create successful\n";
  $mailbox->SetAttributes(\%Attributes);
  $mailbox->SetOwner("$domain\\$mailbox_alias_name");
  $mailbox->SetPerms(\@Perms);

  #--- Exchange 2000/2003
  $mailbox = $provider->CreateMailbox($mailbox_alias_name) ||
    print 'Mailbox create failed\n';
  $mailbox->Win32::Exchange::SetAttributes(\%Attributes) ||
        print 'Set Attributes failed\n';
  $mailbox->SetPerms(\@Perms);


DESCRIPTION

For now, this module creates and modifies Exchange 5.5, 2000 and 2003* mailboxes, has growing support for distribution lists, and some server API queries. Eventually it will do more, but for now, that's it. Kind of vague.. isn't it?

Win32::Exchange uses Win32::OLE exclusively (and technically is just a wrapper for the underlying OLE calls) so feel free to look at them, and make a suggestion or two.

Exchange 5.5 mailbox creation uses the LDAP interface on the Exchange server exclusively. If the LDAP protocol is disabled on your Server, you will not be able to use this module until you turn it on.

Exchange 2000 mailbox creation is a little bit different because it is based on COM objects, instead of LDAP, and you need the Exchange 2000 client tools loaded on the box you want to do the creation on in order to work correctly. These are kind of modest requirements, but please check the NOTES section for more on software requirements and good ideas.

A note on Exchange 2003: Though it looks to be almost identical to Exchange 2000 in the various calls, not everything is tested (thoroughly). That is to say that, I've created one mailbox on a 2003 server. Bug Reports are welcome. Please recheck the docs first as the various functions have changed what parameters they expect as of build 042.

All methods return 0 (or undef) on failure and 1 for success unless otherwise noted.

Functions

$provider = Win32::Exchange->new($server_name);
The new() class method starts a new instance of an Exchange provider object. It returns a reference to this object or undef if the creation fails.

It should be noted strongly that the parameters for just about every Mailbox function changed in release 042. Most of these changes are pulling out the exchange server name and/or DC name. Sorry for the changes.
This model is much better (cleaner code) and allows much more flexibility.
It should also be noted that the provider object is now server specific as the provider object tells the various functions which domain controller to talk to (namely, the one that this exchange server is currently taking auth/AD requests from).

This should be a noticable improvement. Namely, waiting on replication in large environments could potentially break simple scripts while waiting on replication, and mailbox creation could be stalled while waiting on repl. Now, the changes should take place on the same server (providing you code for AD user creates on the server that your exchange server is talking to. ($provider->{dc}).


$provider = Win32::Exchange::Mailbox->new($server_name); #new performs a check on your exchange server for versioning

$provider->AddDLMembers($dl_name,\@new_dl_members[,1]);#Exchange 5.5 sending an alias name
$provider->AddDLMembers($dl_dn,\@new_dl_members);#Exchange 5.5 sending a "distinguished name"
$provider->AddDLMembers($dl_name,\@new_dl_members);#Exchange 2000
The only noticable differences between Exchange 5.5 and 2000 for this call are where the data gets set, and provider version. In either case, both functions check parameters and provider versions, so you shouldn't hit any snafus.

The Exchange 5.5 version now accepts either that "alias name" or the "distinguished name" of both the distribution list and the mailbox. As well, the module searches for both the DL and MB "distinguished name".

#Exchange 5.5
if ($provider->AddDLMembers($dl_name,/@new_dl_members),1) { #Search for $dl_name
print "Added members successfully\n";
}

#Exchange 2000
if ($provider->AddDLMembers($dl_name,/@new_dl_members)) {
print "Added members successfully\n";
}



$provider->CreateMailbox($mailbox_name,[$container]);#Exchange 5.5 using a specific container
$provider->CreateMailbox($mailbox_name,[$storage_group,$mailbox_store]);#Exchange 2000
$provider->CreateMailbox($mailbox_name,[$mailbox_store_dn]);#Exchange 2000 using dn
The CreateMailbox() function behaves differently depending on which type of version of the provider it is passed. As well, the arguments for the Exchange 5.5 and 2000 functions can be slightly different.

When making Exchange 2000 Mailboxes, it should be noted that if you are using multiple "storage groups", or multiple "mailbox stores" on the Exchange Server, the presence of $storage_group and $mailbox_store are not optional (unless replaced by a valid mailbox store distinguished name as the fifth parameter), as the function will fail because it doesn't know where to put your new mailbox.

Lastly, if you plan on running LocateMailboxStore before the CreateMailbox, you can pass the distinguished name of the "located" mailbox store instead of the "storage group" and "mailbox store" names.

For the Exchange 5.5 call, you can optionally pass a container name, something like this... (similarly, a dn can be passed for Exchange 2000)
$container = "CN=Talahassee,CN=Recipients,OU=Corporate,O=MegaCompany";

If you don't specify a container, Win32::Exchange::Mailbox will try to create your mailbox in the default (my default) container of:
"CN=Recipients,ou=YourOU,O=YourOrg"



$mailbox->DeleteMailbox();#E2K
$provider->DeleteMailbox($mailbox_name,);#E55
The DeleteMailbox() function is implemented for Exchange 5.5 and 2000.

The base object that this function uses for Exchange 5.5 is the LDAP provider object as created by the new function.

The base object that this function uses for Exchange 2000 is the mailbox object as retrieved by the GetMailbox() function.
$provider = Win32::Exchange::Mailbox->new($exch_server);
sub e2k { $mailbox = $provider->GetMailbox("thisisatest");
if ($mailbox) {
print "Got Mailbox\n";
} else {
print "Mailbox was not gotten.\n";
}

if ($mailbox->DeleteMailbox()) {
print "Mailbox deletion successful.\n";
} else {
print "Mailbox deletion failed.\n";
}
}

sub e55 {
if ($provider->DeleteMailbox($mailbox_alias)) {
print "Mailbox deletion successful.\n";
} else {
print "Mailbox deletion failed.\n";
}
}

Note: The Exchange 5.5 version of DeleteMailbox is using ADSI and is subject to the problem described in this article, entitled "Using ADSI/LDAP API to Delete Exchange 5.5 Mailbox Orphans Mailbox Resources (284199)"

Ultimately, the delete is successful, but the mailbox resources are available to any newly created directory object of the same cn/uid. This is not an ideal situation, but the alternative involves C code, and I do not have the talents to create a DAPI C interface for use by perl modules, and rely on COM objects which are easily manipulatable by perl, and a substandard interface is revealed. Sorry.


$provider->GetDLMembers($dl_name,\@new_dl_members[,$prop_name]);
If you do not send a $prop_name, the returning array will be the "distinguidhedname" of the member(s) in the Distribution List. Use an LDAP viewer to view the available properties of your Exchange object.
If there are no members in your distribution list, Your array will be empty. This is different than the function returning 0, because the function worked, but the group/distribution list was empty (no members).

The Exchange 5.5 version hasn't been fully tested. Sorry. I don't have an Exchange 5.5 server anymore to do testing on.


$prop = "displayname";#change this to see different values for your members
$provider = Win32::Exchange::Mailbox->new($server_name);
if ($provider->{ver} eq "5.5") {
#Exchange 5.5
if ($provider->GetDLMembers("distlistname",\@members,$prop)) {
print "worked -- E55\n";
} else {
print "didn't work -- E55\n";
}
} elsif ($provider->{ver} eq "6.0") {
#Exchange 2000
if ($provider->GetDLMembers("distlistname",\@members,$prop)) {
print "worked - E2K\n";
} else {
print "didn't work -- E55\n";
}
} foreach $member (@members) {
print "$prop = $member\n";
}



$provider->GetMailbox($mailbox_name);
The GetMailbox() function is implemented for Exchange 5.5 and 2000. There is no more need to send the Org or OU

#E2K or E55
$mailbox = $provider->GetMailbox($mailbox_alias_name);
if ($mailbox) {
print "Mailbox exists\n";
}

$mailbox->GetOwner($nt_user,[$sid_type]);#Exchange 5.5
The GetOwner() method takes an Exchange 5.5 mailbox object like one provided by GetMailbox() or CreateMailbox() along with a variable to store the results in, and an optional "SID type", in order for the function to return a string type of your choosing.

This function defaults to ADS_SID_WINNT_PATH if no sid_type is specified. I don't believe there is an E2K equivelant due to the nature of E2K integration with AD.

$mailbox->GetOwner($nt_user,0x2) || print 'Error getting owner\n'; #0x2 == ADS_SID_SAM


$provider->MailDisable();#E2K only (for now)
This method allows you mail-disable an AD user account.
You must call GetUserObject method before trying to MailDisable an account.

$provider = Win32::Exchange->new($exch_server_name);
$user_object = $provider->GetUserObject("username");
if ($user_object->MailDisable() {
print "Success!";
}


$user_object = $provider->GetUserObject($mailbox_name);#Exchange 2K
The GetUserObject() function is intended for use only with Exchange 2000 and (currently), MailEnable and MailDisable.

$provider = Win32::Exchange->new($exch_server_name);
$user_obj = $provider->GetUserObject($mailbox_alias_name);
if ($user_obj) {
print "user exists\nLet's go create them a mailenabled address!\n";
if ($provider->MailEnable($user_obj,'someone@somewhere_else.org')) {
print "Wow, that worked\n";
}
}


$provider->IsMapiAware($dc,$aliasname);#E2K only (for now)
$provider->IsMailboxEnabled($dc,$aliasname);#E2K only (for now)
$provider->IsMailboxEnabled($dc,$aliasname);#E2K only (for now)
Note: More testing needs to be done with these functions because they might not work as expected in Native-Mode Exchange (E2K/E2K03) organizations These 3 functions were designed in determining quickly whether or not an AD user object:

--was addressable via email. I.E. it is either MailEnabled or has a mailbox (IsMapiAware)
--was MailEnabled (IsMailEnabled)
--has a mailbox (IsMailboxEnabled)

These functions all return 1 for yes, and 0 for no.

if ($provider->IsMailEnabled($mailbox_name)) {
print "This username is mailable, but does not currently have a mailbox at this address\n";
}
if ($provider->IsMailboxEnabled($mailbox_name)) {
print "This username is mailable, and currently has a mailbox at this address\n";
}
if ($provider->IsMapiAware($mailbox_name)) {
print "This username is mailable, either by a mail-enabled address or Mailbox\n";
}


$provider->MailEnable([$address]);#E2K only (for now)
This method allows you mail-enable an AD user account. Optionally, you can set the address to send mail for the user if it was to be redirected to an off-site account (perhaps, the user's hotmail.com, juno.com, or yahoo.com mail account).

The provider is an object that was created with Win32::Exchange::Mailbox->new. The $user_obj is an object created by the GetUserObject method.

$user_obj = $provider->GetUserObject($username);
if ($user_obj->MailEnable("pcgeek@bigfoot.com") {
print "Success!";
}


$provider->MoveMailbox($mailbox_alias_name,$move_to_server,$move_to_message_store,$move_to_storage_group);#E2K only
This funcion uses Exchange 2000/2003's MoveMailbox functionality. Sorry, Exchange 5.5 Admins, you still need to use EXMERGE to complete this task.

if ($provider->MoveMailbox("someone","EXCHANGE1","First Mailbox Store","First Storage Group")) {
print "Success moving someone's mailbox!\n";
} else {
print "Failed moving someone's mailbox\n";
}

$mailbox->SetAttributes(\%attrs);Exchange 5.5
$ad_user_object->SetAttributes(\%attrs);Exchange 2000
The SetAttributes() method takes a specially formed hash structure, and is different depending on which version of Exchange you are trying to set attributes for:

Exchange 5.5:

$Exchange_Info{'Deliv-Cont-Length'}='6000';
$Exchange_Info{'Submission-Cont-Length'}='6000';
$Exchange_Info{'givenName'}="This";
$Exchange_Info{'sn'}="Isatest";
$Exchange_Info{'cn'}=$mailbox_full_name;
$Exchange_Info{'mail'}="$mailbox_alias_name\@manross.net";
$Exchange_Info{'rfc822Mailbox'}="$mailbox_alias_name\@manross.net";

push (@$Other_MBX,"RFAX:$Exchange_Info{'cn'}\@");
push (@$Other_MBX,"smtp:secondary\@$mail_domain");
push (@$Other_MBX,"smtp:tertiary\@$mail_domain");
$Exchange_Info{'otherMailbox'}=$Other_MBX;

Note:
See Also (Exchange 5.5):
Exchange 5.5 and ADSI (ADSI Exchange)

Exchange 2000:

push (@$proxies,'SMTP:'.$mailbox_alias_name.'@manross.net');
push (@$proxies,'smtp:secondary@manross.net');
push (@$proxies,'smtp:tertiary@manross.net');
$Attributes{"IMailRecipient"}{ProxyAddresses} = $proxies;
$Attributes{"IMailRecipient"}{IncomingLimit} = 6000;
$Attributes{"IMailRecipient"}{OutgoingLimit} = 6000;
$Attributes{"IMailboxStore"}{EnableStoreDefaults} = 0;
$Attributes{"IMailboxStore"}{StoreQuota} = 100;
$Attributes{"IMailboxStore"}{OverQuotaLimit} = 120;
$Attributes{"IMailboxStore"}{HardLimit} = 130;

See Also (Exchange 2000):
Interfaces and attributes


$mailbox->SetOwner($user);
The SetOwner() method takes a string reference (ex. "DOMAIN\USERNAME") and is currently only applicable for use in setting the owner on Exchange 5.5 mailboxes (the "Assoc-NT-Account" property of the mailbox). I don't believe there is an E2K equivelant.

$mailbox->SetOwner("DOMAIN\username") || print 'Error setting owner\n'


$mailbox->SetPerms(\@users);
The SetPerms() method takes an array reference of user or group names. This function works on Exchange 5.5 and Exchange 2000 mailboxes. The Exchange 2000 version requires Service Pack 1, with a hotfix, Service Pack 2, or later Service pack release, and is reccommended that the Exchange Client Tools be of the same Service Pack level as the server.

push (@PermsUsers,"$domain\\$mailbox_name");
push (@PermsUsers,"$domain\\Some Group");
$mailbox->SetPerms(\@PermsUsers) || print 'Error setting perms\n'


Module Options

Currently there are none, but I intend to make DEBUG a passable parameter as it is currently hard-coded to 1 (enabled).

EXAMPLES

use Win32::Exchange;

$domain = Win32::DomainName();
$info_store_server="YOURMAILBOXSERVERNAME";
$mta_server=$info_store_server; # this could be different, but for testing, we'll set them the same

#  start E2K only
$storage_group = ""; # you'd need to define this if you had more than 1 storage group on 1 server.
$mailbox_store = ""; # you'd need to define this if you had more than 1 mailbox store on 1 or more storage groups.
#  end E2K only

# runtime variables

$mailbox_alias_name='bgates'; # username
$givenName = "Bill"; # firstname
$sn = "Gates"; # lastname
$mailbox_full_name="$givenName $mailbox_alias_name $sn";
$distribution_list="Users"; # group the user will be in.
$email_domain = "microsoft.com"; # remote part of the final email address
$trustee_group = "Domain Admins"; # the group that has permission to log into this mailbox as well as the recipient

if (!Win32::Exchange::GetVersion($info_store_server,\%ver) ) {
  print "$rtn - Error returning into main from GetVersion\n";
  exit 0;
}

print "version      = $ver{ver}\n";
print "build        = $ver{build}\n";
print "service pack = $ver{sp}\n";
if (!($provider = Win32::Exchange::Mailbox->new($info_store_server))) {
  print "$rtn - Error returning into main from new ($Win32::Exchange::VERSION)\n";
  exit 0;
}
$dc = $provider->{dc};

my @PermsUsers;
push (@PermsUsers,"$domain\\$mailbox_alias_name");
push (@PermsUsers,"$domain\\$trustee_group"); #Group that needs perms to the mailbox...

if ($ver{ver} eq "5.5") {

        e55(); # Exchange 5.5 instructions.

} elsif ($ver{ver} eq "6.0") {

        e60(); # Exchange 6.0 instructions.
}

sub e55 {

  if ($mailbox = $provider->GetMailbox($mailbox_alias_name)) {
    print "Mailbox already existed\n";
    if ($mailbox->SetOwner("$domain\\$mailbox_alias_name")) {
      print "SetOwner in GetMailbox worked!\n";
    }
    if ($mailbox->SetPerms(\@PermsUsers)) {
      print "Successfully set perms in GetMailbox\n";
    } else {
      print "Error setting perms from GetMailbox\n";
      exit 0;
    }
  } else {
    $mailbox = $provider->CreateMailbox($mailbox_alias_name);
    if (!$mailbox) {
      print "error creating mailbox\n";
      exit 0;
    }
    print "We created a mailbox!\n";
    if ($mailbox->SetOwner("$domain\\$mailbox_alias_name")) {
      print "SetOwner worked\n";
    } else {
      print "SetOwner failed\n";
    }
    if ($mailbox->GetOwner($nt_user,0x2)) {
      print "GetOwner worked: owner = $nt_user\n";
    } else {
      print "GetOwner failed\n";
    }

    $mailbox->GetPerms(\@array);

    foreach my $acl (@array) {
      print "   trustee - $acl->{Trustee}\n";
      print "accessmask - $acl->{AccessMask}\n";
      print "   acetype - $acl->{AceType}\n";
      print "  aceflags - $acl->{AceFlags}\n";
      print "     flags - $acl->{Flags}\n";
      print "   objtype - $acl->{ObjectType}\n";
      print "inhobjtype - $acl->{InheritedObjectType}\n";
    }

    if ($mailbox->SetPerms(\@PermsUsers)) {
      print "Successfully set perms\n";
    } else {
      print "Error setting perms\n";
      exit 0;
    }
  }

  #$Exchange_Info{'Deliv-Cont-Length'}='6000';
  #$Exchange_Info{'Submission-Cont-Length'}='6000';
  $Exchange_Info{'givenName'}=$givenName;
  $Exchange_Info{'sn'}=$sn;
  $Exchange_Info{'cn'}=$mailbox_full_name;
  $Exchange_Info{'mail'}="$mailbox_alias_name\@$email_domain";
  $Exchange_Info{'rfc822Mailbox'}="$mailbox_alias_name\@$email_domain";
  #You can add any attributes to this hash that you can set via exchange for a mailbox

  #$rfax="RFAX:$Exchange_Info{'cn'}\@"; #this can set the Rightfax SMTP name for Exchange-enabled Rightfax mail delivery
  #push (@$Other_MBX,$rfax);

  $smtp="smtp:another_name_to_send_to\@$email_domain";
  push (@$Other_MBX,$smtp);
  #be careful with 'otherMailbox'es..  You are deleting any addresses that may exist already
  #if you set them via 'otherMailbox' and don't get them first (you are now forewarned).
  $Exchange_Info{'otherMailbox'}=$Other_MBX;

  if (!Win32::Exchange::GetDistinguishedName($mta_server,"Home-MTA",$Exchange_Info{"Home-MTA"})) {
    print "Failed getting distinguished name for Home-MTA on $info_store_server\n";
    exit 0;
  }
  if (!Win32::Exchange::GetDistinguishedName($info_store_server,"Home-MDB",$Exchange_Info{"Home-MDB"})) {
    print "Failed getting distinguished name for Home-MDB on $info_store_server\n";
    exit 0;
  }

  if ($mailbox->SetAttributes(\%Exchange_Info)) {
    print "SetAttributes worked\n";
  } else {
    print "SetAttributes failed\n";
  }

  my @new_dl_members;
  push (@new_dl_members,$mailbox_alias_name);
  $provider->AddDLMembers("newdltest",\@new_dl_members);

}

sub e60 {

  if (Win32::Exchange::LocateMailboxStore($info_store_server,$storage_group,$mailbox_store,$store_name,\@counts)) {
    print "storage group = $storage_group\n";
    print "mailbox store = $mailbox_store\n";
    print "located store distinguished name= $store_name\n";
    print "$info_store_server\n";
    print "  Total:\n";
    print "    storage groups = $counts[0]\n";
    print "    mailbox stores = $counts[1]\n";
  }
  if ($mailbox = $provider->GetMailbox($mailbox_alias_name)) {
    print "Got Mailbox successfully\n";
  } else {
    print "Mailbox did not exist\n";
    if ($mailbox = $provider->CreateMailbox($mailbox_alias_name,
                                            $email_domain
                                            )
       ) {
      print "Mailbox create succeeded.\n";
    } else {
      print "Mailbox creation failed.\n";
      exit 0;
    }

  }
  #be careful with proxy addresses..  You are deleting any addresses that may exist already
  #if you set them via ProxyAddresses (you are now forewarned).
  push (@$proxies,'SMTP:'.$mailbox_alias_name.'@'.$email_domain);
  push (@$proxies,'SMTP:secondary@'.$email_domain);
  push (@$proxies,'SMTP:primary@'.$email_domain);
  push (@$proxies,'SMTP:tertiary@'.$email_domain);

  $Attributes{"IMailRecipient"}{ProxyAddresses} = $proxies;

  #  $Attributes{"ExchangeInterfaceName"}{Property} = value; #with this method you should be able to set any value
  #                                                           imaginable.....  Here's a few to start with

  $Attributes{"IMailRecipient"}{IncomingLimit} = 6000;
  $Attributes{"IMailRecipient"}{OutgoingLimit} = 6000;
  $Attributes{"IMailboxStore"}{EnableStoreDefaults} = 0;
  $Attributes{"IMailboxStore"}{StoreQuota} = 100; #at 100KB starts getting warnings
  $Attributes{"IMailboxStore"}{OverQuotaLimit} = 120; #at 120KB can't send...  I THINK...
  $Attributes{"IMailboxStore"}{HardLimit} = 130; #at 130KB, can't do anything...  I THINK...
  if (!$mailbox->SetAttributes(\%Attributes)) {
    print "Error setting 2K Attributes\n";
    exit 0;

  } else {
    print "Set Attributes correctly\n";
  }

  my @PermUsers;
  push (@PermUsers,"$domain\\$mailbox_alias_name");
  push (@PermUsers,"$domain\\$trustee_group"); #Group that needs perms to the mailbox...

  if (!$mailbox->SetPerms(\@PermUsers)) {
    print "Error setting 2K Perms\n";
    exit 0;
  } else {
    print "Set 2K Perms correctly\n";
  }
  my @new_dl_members;
  push (@new_dl_members,$mailbox_alias_name);
  if ($provider->AddDLMembers($distribution_list,\@new_dl_members)) {
    print "Add successful to DL\n";
  } else {
    print "Error adding distlist member\n";
    exit 0;
  }
  exit 1;

}

NOTES

Incompatabilities

Bugs and Limitations


SEE ALSO


AUTHORS

This module is based on an Exchange 5.5 mailbox creation script that has been traveling around the Internet and Activestate's mailing list archives for years.

I picked up on the thread that started my mailbox creation frenzy in 1999, and have been modifying the subroutines ever since.

With the advent of Exchange 2000, another script came to light, that tried to parse the Storage Group name and Mailbox Store names into an incredibly long string to allow for Exchange 2000 mailbox creation (circa 2001?).

I knew that the entire string had to be all parsed together somewhere in the Directory, and it was just a matter of finding it.

It was; LocateMailboxStore is an implementation of that idea.

As it turns out, there are a lot of tricks like LocateMailboxStore that have helped develop this module from a string concatenation mess into a lot of fancy searches for the complete ldap paths and distinguished names that power mailbox creation.

Most of the fancy searches were created by poking around in the objects themselves with ADSVW.EXE (an ADSI SDK tool), and then writing an ADODB search to return the right result set.

Thanks for taking the time to read all of this..

I'd like to extend thanks to the following:

Please send questions, comments or suggestions about this module to Steven Manross <steven@manross.net>.


VERSION

Version 0.046 June 8, 2004

Copyright

Microsoft, Active Directory, ADSI, Windows, Windows NT, MSDN, and Exchange are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.


 Win32::Exchange::Mailbox - Microsoft Exchange mailbox related functions