IAdmExchangeQueries

The IAdmExchangeQueries interface provides methods that can be used to query Exchange-related information.

Methods

Details

GetNextMailboxStorageDatabase()

Returns the next Exchange storage database that must be used to create a mailbox.

IAdmExchangeStorageDatabase GetNextMailboxStorageDatabase(
        ADM_MAILBOXSTORAGESELECTIONTYPE_ENUM selectionType,
        string[] allowedMailboxStorageDatabases,
        IAdmTop targetObject)

Parameters

  • selectionType - Specifies a value indicating how a mailbox storage database must be selected for a new mailbox.
  • allowedMailboxStorageDatabases - Specifies a list of globally unique identifiers (GUIDs) of Exchange storage databases that are allowed to hold mailboxes for the target object.
  • targetObject - Specifies the directory object for which the mailbox will be created.

NotifyMailBoxStorageDataBaseIsUsed()

Notifies that a certain Exchange storage database was used to create a mailbox. Clients must notify about using the Exchange storage database to allow the Exchange Mailbox Database property pattern item generate the Exchange storage database for the next object.

void NotifyMailBoxStorageDataBaseIsUsed(
        ADM_MAILBOXSTORAGESELECTIONTYPE_ENUM selectionType,
        string[] allowedMailboxStorageDatabases,
        IAdmTop targetObject,
        IAdmExchangeStorageDatabase storageDatabase)

Parameters

  • selectionType - Specifies a value indicating how a mailbox storage database must be selected for a new mailbox.
  • allowedMailboxStorageDatabases - Specifies a list of globally unique identifiers (GUIDs) of Exchange storage databases that are allowed to hold mailboxes for the target object.
  • targetObject - Specifies the directory object for which a mailbox was created.
  • storageDatabase - Specifies the Exchange storage database that was used to create a mailbox.

GetExchangeUMDialPlans()

Returns Exchange Unified Messaging dial plans available for the specified recipients.

IAdmObjectReference[] GetExchangeUMDialPlans(string[] recipientPaths)

Parameters

The recipientPaths parameter specifies the ADS paths of the recipients to return Unified Messaging dial plans for. If the parameter is set to null, all available Unified Messaging dial plans are returned.

GetExpansionServers()

Returns the Exchange servers that can be used as expansion servers for the specified groups.

IAdmObjectReference[] GetExpansionServers(string[] groupPaths);

Parameters

The groupPaths parameter specifies the ADS paths of the groups to return Exchange servers for.

GetManagedFolderMailboxPolicies()

Returns managed folder policies available for the specified recipients.

IAdmObjectReference[] GetManagedFolderMailboxPolicies(string[] recipientPaths)

Parameters

The recipientPaths parameter specifies the ADS paths of the recipients to return managed folder policies plans for.

GetSharingPolicies()

Returns sharing policies available for the specified recipients.

IAdmObjectReference[] GetSharingPolicies(string[] recipientPaths)

Parameters

The recipientPaths parameter specifies the ADS paths of the recipients to return sharing policies plans for.

GetOwaMailboxPolicies()

Returns OWA mailbox policies available for the specified recipients.

IAdmObjectReference[] GetOwaMailboxPolicies(string[] recipientPaths)

Parameters

The recipientPaths parameter specifies the ADS paths of the recipients to return OWA mailbox policies for.

GetMobileDevicesMailboxPolicies()

Returns Active Sync mailbox policies available for the specified recipients.

IAdmObjectReference[] GetMobileDevicesMailboxPolicies(string[] recipientPaths)

Parameters

The recipientPaths parameter specifies the ADS paths of the recipients to return Active Sync mailbox policies for.

GetUMMailboxPolicy()

Returns Exchange UM mailbox policies available for the specified recipients.

IAdmObjectReference[] GetUMMailboxPolicy(string[] recipientPaths, bool filterPoliciesByDialPlan)

Parameters

recipientPaths – Specifies the ADS paths of the recipients to return Exchange UM mailbox policies for.
filterPoliciesByDialPlan – If set to true the method returns only the policies corresponding to the dial plans assigned to the specified recipients. If false the method returns all the policies available for the specified recipients.

GetRoleAssignmentPolicies()

Returns Role Assignment policies available for the specified recipients.

IAdmObjectReference[] GetRoleAssignmentPolicies(string[] recipientPaths)

Parameters

The recipientPaths parameter specifies the ADS paths of the recipients to return Role Assignment policies for.

GetAddressBookPolicies()

Returns Address Book policies available for the specified recipients.

IAdmObjectReference[] GetAddressBookPolicies(string[] recipientPaths)

Parameters

The recipientPaths parameter specifies the ADS paths of the recipients to return Address Book policies for.

GetRetentionPolicies()

Returns Retention policies available for the specified recipients.

IAdmObjectReference[] GetRetentionPolicies(string[] recipientPaths)

Parameters

The recipientPaths parameter specifies the ADS paths of the recipients to return Retention policies for.

GetExchangeServerVersions()

Returns versions of the Exchange servers available in the domains of the specified recipients.

ADM_EXCHANGE_VERSION[] GetExchangeServerVersions(string[] recipientPaths,
                                                 bool returnRecipientVersionsOnly)

Parameters

recipientPaths – Specifies the ADS paths of the recipients to return versions of the Exchange servers for.
returnRecipientVersionsOnly – If set to true the method returns only Exchange server versions available in the organizations of the specified recipients and set in their properties. If false the method returns all Exchange server versions available in the organizations of the specified recipients.

GetRelatedDomainsForMasterAccount()

Returns names of the domains containing directory objects that can be set in properties of an account located in the specified domain.

string[] GetRelatedDomainsForMasterAccount(string masterAccountDomain)

Requirements

Minimum required version: 2023

See also

© Softerra 2022. All rights reserved.
Send feedback