Skip to content

IAdmExchangeProxyAddressModificationCollection

The IAdmExchangeProxyAddressModificationCollection interface represents a collection of email addresses of an Exchange account or distribution list. Each item in the collection is represented by the IAdmExchangeProxyAddress interface that contains the email address and the associated modification to be performed on the address.

Inheritance: The IAdmExchangeProxyAddressModificationCollection interface inherits from the IEnumerable interface.

Methods

Properties

  • Property

  • Description

  • Count

  • Gets the number of addresses in the collection.

  • OverrideOldValues

  • If set to TRUE, the current email addresses of the mailbox will be removed and replaced with the addresses contained in the collection.

  • AreValueReferencesAllowed

  • Gets or sets a value indicating whether the email addresses in the collection can contain value references.

Details

Add()

Adds an email address to the collection.

void Add(ADS_PROPERTY_OPERATION_ENUM operation, IAdmExchangeProxyAddress addressToAdd)

Parameters

  • operation - Specifies the operation to be performed on the email address.
  • addressToAdd - Specifies the email address to be added.

Clear()

Removes all addresses from the collection.

void Clear()

CreateAddress()

Creates an instance of the IAdmExchangeProxyAddress interface using the specified address type and prefix.

IAdmExchangeProxyAddress CreateAddress(ADM_EXCHANGE_ADDRTYPE_ENUM addressType,
                                       String customPrefix)

Parameters

  • addressType - Specifies the address type. If this parameter is set to ADM_EXCHANGE_ADDRTYPE_CUSTOM, the customPrefix parameter must contain a custom prefix for the email address (e.g. x400).
  • customPrefix - Specifies a custom prefix for the email address.

GetAddress()

Returns an address by index.

IAdmExchangeProxyAddress GetAddress(Int32 index, out ADS_PROPERTY_OPERATION_ENUM operation)

Parameters

  • index - Specifies the index of the address to return.
  • operation is an output (OUT) parameter that returns the type of the operation to be performed on the email address.

GetAllPrefixes()

Gets an array of all prefixes of email addresses in the collection.

String[] GetAllPrefixes()

GetAddressesByPrefix()

Gets all addresses in the collection that have the specified prefix.

IAdmExchangeProxyAddress[] GetAddressesByPrefix(String prefix)

GetOperation()

Gets the operation to be performed on the specified address.

ADS_PROPERTY_OPERATION_ENUM GetOperation(IAdmExchangeProxyAddress address)

SetOperation()

Sets the operation to be performed on the specified address.

void SetOperation(IAdmExchangeProxyAddress address,
                  ADS_PROPERTY_OPERATION_ENUM operation)

Parameters

  • address - Specifies the address, for which the operation is set.
  • operation - Specifies the operation to be performed on the address.

Remove()

Removes the specified address from the collection.

void Remove(IAdmExchangeProxyAddress addressToRemove)

Count

Gets the number of addresses in the collection.

  • Type:
  • Int32
  • Access:
  • Read-only

OverrideOldValues

If set to TRUE, the current email addresses of the mailbox will be removed and replaced with the addresses contained in the collection.

  • Type:
  • Boolean
  • Access:
  • Read/Write

AreValueReferencesAllowed

Gets or sets a value indicating whether the email addresses in the collection can contain value references.

  • Type:
  • Boolean
  • Access:
  • Read/Write

Requirements

Minimum required version: 2013.1

See also