[ Index ]

PHP Cross Reference of DokuWiki

title

Body

[close]

/lib/plugins/authad/adLDAP/classes/ -> adLDAPExchange.php (summary)

PHP LDAP CLASS FOR MANIPULATING ACTIVE DIRECTORY Version 4.0.4 PHP Version 5 with SSL and LDAP support

Author: Scott Barnett, Richard Hyland
Copyright: (c) 2006-2012 Scott Barnett, Richard Hyland
License: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html LGPLv2.1
Link: http://adldap.sourceforge.net/
Version: 4.0.4
File Size: 390 lines (17 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

adLDAPExchange:: (10 methods):
  __construct()
  createMailbox()
  addX400()
  addAddress()
  deleteAddress()
  primaryAddress()
  contactMailEnable()
  servers()
  storageGroups()
  storageDatabases()


Class: adLDAPExchange  - X-Ref

MICROSOFT EXCHANGE FUNCTIONS

__construct(adLDAP $adldap)   X-Ref
The current adLDAP connection via dependency injection


createMailbox($username, $storageGroup, $emailAddress, $mailNickname=NULL, $useDefaults=TRUE, $baseDn=NULL, $isGUID=false)   X-Ref
Create an Exchange account

return: bool
param: string $username The username of the user to add the Exchange account to
param: array $storageGroup The mailbox, Exchange Storage Group, for the user account, this must be a full CN
param: string $emailAddress The primary email address to add to this user
param: string $mailNickname The mail nick name.  If mail nickname is blank, the username will be used
param: bool $mdbUseDefaults Indicates whether the store should use the default quota, rather than the per-mailbox quota.
param: string $baseDn Specify an alternative base_dn for the Exchange storage group
param: bool $isGUID Is the username passed a GUID or a samAccountName

addX400($username, $country, $admd, $pdmd, $org, $surname, $givenName, $isGUID=false)   X-Ref
Add an X400 address to Exchange
See http://tools.ietf.org/html/rfc1685 for more information.
An X400 Address looks similar to this X400:c=US;a= ;p=Domain;o=Organization;s=Doe;g=John;

return: bool
param: string $username The username of the user to add the X400 to to
param: string $country Country
param: string $admd Administration Management Domain
param: string $pdmd Private Management Domain (often your AD domain)
param: string $org Organization
param: string $surname Surname
param: string $givenName Given name
param: bool $isGUID Is the username passed a GUID or a samAccountName

addAddress($username, $emailAddress, $default = FALSE, $isGUID = false)   X-Ref
Add an address to Exchange

return: bool
param: string $username The username of the user to add the Exchange account to
param: string $emailAddress The email address to add to this user
param: bool $default Make this email address the default address, this is a bit more intensive as we have to demote any existing default addresses
param: bool $isGUID Is the username passed a GUID or a samAccountName

deleteAddress($username, $emailAddress, $isGUID=false)   X-Ref
Remove an address to Exchange
If you remove a default address the account will no longer have a default,
we recommend changing the default address first

return: bool
param: string $username The username of the user to add the Exchange account to
param: string $emailAddress The email address to add to this user
param: bool $isGUID Is the username passed a GUID or a samAccountName

primaryAddress($username, $emailAddress, $isGUID = false)   X-Ref
Change the default address

return: bool
param: string $username The username of the user to add the Exchange account to
param: string $emailAddress The email address to make default
param: bool $isGUID Is the username passed a GUID or a samAccountName

contactMailEnable($distinguishedName, $emailAddress, $mailNickname = NULL)   X-Ref
Mail enable a contact
Allows email to be sent to them through Exchange

return: bool
param: string $distinguishedName The contact to mail enable
param: string $emailAddress The email address to allow emails to be sent through
param: string $mailNickname The mailnickname for the contact in Exchange.  If NULL this will be set to the display name

servers($attributes = array('cn','distinguishedname','serialnumber')   X-Ref
Returns a list of Exchange Servers in the ConfigurationNamingContext of the domain

return: array
param: array $attributes An array of the AD attributes you wish to return

storageGroups($exchangeServer, $attributes = array('cn','distinguishedname')   X-Ref
Returns a list of Storage Groups in Exchange for a given mail server

return: array
param: string $exchangeServer The full DN of an Exchange server.  You can use exchange_servers() to find the DN for your server
param: array $attributes An array of the AD attributes you wish to return
param: bool $recursive If enabled this will automatically query the databases within a storage group

storageDatabases($storageGroup, $attributes = array('cn','distinguishedname','displayname')   X-Ref
Returns a list of Databases within any given storage group in Exchange for a given mail server

return: array
param: string $storageGroup The full DN of an Storage Group.  You can use exchange_storage_groups() to find the DN
param: array $attributes An array of the AD attributes you wish to return