Dynamic Distribution Group operation

The Set Dynamic Distribution Group process modifies the settings of an existing dynamic distribution group. The following table describes the input parameters for Set Dynamic Distribution Group process

Adapter request parameters for Set Dynamic Distribution Group process

Element

Definition

Required

<Identity>

Identifies the object that you want to modify

The Identity parameter can take any of the following values for the dynamic distribution group object:

  • Distinguished name (DN)
  • Canonical name
  • GUID
  • Name
  • Display name
  • Alias
  • Legacy Exchange DN
  • Primary Simple Mail Transfer Protocol (SMTP) e-mail address

    The Identity parameter cannot be used if the Instance parameter is specified.

Yes

<AcceptMessagesOnlyFrom>

Specifies the mailbox users, mail users, and mail contacts that can send e-mail messages to the dynamic distribution group

You can also specify Microsoft Exchange as a valid recipient for this parameter. If you configure a dynamic distribution group to accept messages only from the Microsoft Exchange recipient, it will only receive system-generated messages.

It can take any of the following values for the valid senders:

  • Distinguished name (DN)
  • Canonical name
  • GUID
  • Name
  • Display name
  • Alias
  • Exchange DN
  • Primary SMTP e-mail address (The parameter is blank by default. This default value enables the dynamic distribution group to accept messages from all senders)

No

<AcceptMessagesOnlyFromDLMembers>

Specifies the distribution groups whose members are allowed to send e-mail messages to the dynamic distribution group You can use any of the following values for the allowed distribution groups:

  • Distinguished name (DN)
  • Canonical name
  • GUID
  • Name
  • Display name
  • Legacy Exchange DN
  • Primary SMTP e-mail address (The parameter is blank by default. This default value enables the dynamic distribution group to accept messages from all senders)

No

<Alias>

Specifies the alias of the object

The value of Alias cannot contain spaces.

No

<ConditionalCompany>

Filters the mailbox users or mail-enabled contacts that are used to build the dynamic distribution group When multiple values of the ConditionalCompany parameter are separated by commas, the OR Boolean operator is applied.

You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter.

No

<ConditionalCustomAttribute1>

Specifies conditional custom attributes You can use these attributes to store additional information. You must use the IncludedRecipients parameter if you use a Conditional parameter.

You cannot use this parameter if you use the RecipientFilter parameter.

No

<ConditionalCustomAttribute10>

Parameter specifies conditional custom attributes

You can use these attributes to store additional information. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter.

No

<ConditionalCustomAttribute11>

Specifies conditional custom attributes

You can use these attributes to store additional information. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter.

No

<ConditionalCustomAttribute12>

Specifies conditional custom attributes

You can use these attributes to store additional information. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter.

No

<ConditionalCustomAttribute13>

Specifies conditional custom attributes

You can use these attributes to store additional information. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter.

No

<ConditionalCustomAttribute14>

Specifies conditional custom attributes

You can use these attributes to store additional information. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter.

No

<ConditionalCustomAttribute15>

Specifies conditional custom attributes

You can use these attributes to store additional information. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter.

No

<ConditionalCustomAttribute2>

Specifies conditional custom attributes

You can use these attributes to store additional information. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter.

No

<ConditionalCustomAttribute3>

Specifies conditional custom attributes

You can use these attributes to store additional information. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter.

No

<ConditionalCustomAttribute4>

Specifies conditional custom attributes

You can use these attributes to store additional information. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter.

No

<ConditionalCustomAttribute5>

Specifies conditional custom attributes

You can use these attributes to store additional information. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter.

No

<ConditionalCustomAttribute6>

Specifies conditional custom attributes

You can use these attributes to store additional information. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter.

No

<ConditionalCustomAttribute7>

Specifies conditional custom attributes

You can use these attributes to store additional information. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter.

No

<ConditionalCustomAttribute8>

Specifies conditional custom attributes

You can use these attributes to store additional information. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter.

No

<ConditionalCustomAttribute9>

Specifies conditional custom attributes

You can use these attributes to store additional information. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter.

No

<ConditionalDepartment>

Filters the mailbox users or mail-enabled contacts that are used to build the dynamic distribution group

When multiple values of the ConditionalDepartment parameter are separated by commas, the OR Boolean operator is applied. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter.

No

<ConditionalStateOrProvince>

Filters the mailbox users or mail-enabled contacts that are used to build the dynamic distribution group

When multiple values of the ConditionalStateOrProvince parameter are separated by commas, the OR Boolean operator is applied. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter.

No

<CreateDTMFMap>

Specifies that a Dual Tone Multi-frequency (DTMF) map be created for the dynamic distribution group

No

<CustomAttribute1>

Specifies custom attributes

You can use these attributes to store additional information.

No

<CustomAttribute10>

Specifies custom attributes

You can use these attributes to store additional information.

No

<CustomAttribute11>

Specifies custom attributes

You can use these attributes to store additional information.

No

<CustomAttribute12>

Specifies custom attributes

You can use these attributes to store additional information.

No

<CustomAttribute13>

Specifies custom attributes

You can use these attributes to store additional information.

No

<CustomAttribute14>

Specifies custom attributes

You can use these attributes to store additional information.

No

<CustomAttribute15>

Specifies custom attributes

You can use these attributes to store additional information.

No

<CustomAttribute2>

Specifies custom attributes

You can use these attributes to store additional information.

No

<CustomAttribute3>

Specifies custom attributes

You can use these attributes to store additional information.

No

<CustomAttribute4>

Specifies custom attributes

You can use these attributes to store additional information.

No

<CustomAttribute5>

Specifies custom attributes

You can use these attributes to store additional information.

No

<CustomAttribute6>

Specifies custom attributes

You can use these attributes to store additional information.

No

<CustomAttribute7>

Specifies custom attributes

You can use these attributes to store additional information.

No

<CustomAttribute8>

Specifies custom attributes

You can use these attributes to store additional information.

No

<CustomAttribute9>

Specifies custom attributes

You can use these attributes to store additional information.

No

<DisplayName>

Specifies the name of the distribution group in the Exchange Management Console and in the Exchange Global Address List (GAL)

No

<DomainController>

Specifies the Fully Qualified Domain Name (FQDN) of the domain controller that writes this configuration change to Active Directory

You should include the DomainController parameter.

No

<EmailAddresses>

Specifies the e-mail addresses of the distribution group

All Microsoft Exchange Server 2007 e-mail address types are valid. You can specify multiple values and separate them by using commas.

Important: Exchange 2007 does not validate custom addresses for proper formatting. You must ensure that the custom address you specify complies with the format requirements for that address type. As X.400 addresses are considered custom addresses in Exchange 2007, they are not validated and you must provide the correct syntax when specifying an X.400 address.

No

<EmailAddressPolicyEnabled>

Controls applying e-mail address policies to this distribution group Valid values are true or false.

The default value is true. All applicable e-mail address policies are applied to this distribution group by default.

No

<ExpansionServer>

Specifies the Exchange server to expand the distribution group

Enter the expansion server as a Legacy Exchange DN value. The default behavior is to use the closest Exchange Server 2003 computer, or the closest Exchange 2007 server that has the Hub Transport server role installed.

No

<ForceUpgrade>

Suppresses the following confirmation: To save changes on object, the object must be upgraded to the current Exchange version. After upgrade, this object cannot be managed by a previous version of Exchange System Manager. Do you want to continue to upgrade and save the object?

This confirmation occurs when you upgrade a dynamic distribution group that was created in Microsoft Exchange Server 2003 or Exchange 2000 Server. You cannot manage an Exchange 2003 or Exchange 2000 dynamic distribution group by using the Exchange Management Console till you update the object's version and change the recipient filter by using either the RecipientFilter, or the IncludedRecipients parameters.

No

<GrantSendOnBehalfTo>

Specifies a mailbox user who can send on behalf of this dynamic distribution group It can take any of the following values:

  • Distinguished name (DN)
  • GUID
  • Name
  • Display name
  • Canonical name
  • Legacy Exchange DN
  • Alias
  • Primary SMTP e-mail address

    The GrantSendOnBehalfTo parameter is blank by default. Hence, no other mailbox user has permission to send mail on behalf of this distribution group

No

<HiddenFromAddressListsEnabled>

Hides the distribution group from any Exchange address lists

Valid values: true, false (default)

No

<IgnoreDefaultScope>

Instructs the command to ignore the default recipient scope setting for the Exchange Management Shell and use the entire forest as the scope

This allows the command to access Active Directory objects that are not currently in the default scope.

Using the IgnoreDefaultScope parameter introduces the following restrictions:

  • You cannot use the DomainController parameter. The command will use an appropriate global catalog server automatically.
  • You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, are not accepted.

No

<IncludedRecipients>

Filters the recipient types that are used to build the dynamic distribution group

The available values for the IncludedRecipients parameter are AllRecipients, MailboxUsers, Resources, MailContacts, and MailGroups.

The AllRecipients value can be used only by itself. When multiple values of the IncludedRecipients parameter are separated by commas, the*OR* Boolean operator is applied.

No

<Instance>

Enables you to pass an entire object to the command to be processed

It is mainly used in scripts where an entire object must be passed to the command. The Instance parameter cannot be used if the Identity parameter is specified.

No

<ManagedBy>

Specifies the name of the mailbox user, mail-enabled group, or mail-enabled contact that appears in the Managed by tab of the Active Directory object

You can use any of the following values for this parameter:

  • Distinguished name (DN)
  • Canonical name
  • GUID
  • Name
  • Display name
  • Legacy Exchange DN
  • Primary SMTP e-mail address

No

<MaxReceiveSize>

Used to set the maximum allowed e-mail message size that can be sent to the distribution group

When you enter a value, qualify the value with one of the following units:

  • B (bytes)
  • KB (kilobytes)
  • MB (megabytes)
  • GB (gigabytes)
  • TB (terabytes)

    Unqualified values are treated as bytes. Valid values: 0 - 2147482624 bytes Default value: unlimited

No

<MaxSendSize>

Used to specify the maximum allowed e-mail message size that can be sent from this distribution group

When you enter a value, qualify the value with one of the following units:

  • B (bytes)
  • KB (kilobytes)
  • MB (megabytes)
  • GB (gigabytes)
  • TB (terabytes)

    Unqualified values are treated as bytes. Valid values: 0 - 2147482624 bytes

    Default value: unlimited

No

<Name>

Specifies the name of the dynamic distribution group

The Name parameter specifies the distribution group name in Active Directory Users and Computers and also in the Group Name field in the Exchange Management Console.

No

<Notes>

Specifies comments about the distribution group

No

<PhoneticDisplayName>

Specifies a phonetic pronunciation of the DisplayName parameter

The maximum length of this parameter value is 255 characters.

No

<PrimarySmtpAddress>

Specifies the primary return SMTP e-mail address for the distribution group

This parameter useful only if the distribution group has multiple SMTP e-mail addresses.

No

<RecipientContainer>

Filters the recipients that are used to build the dynamic distribution group based on their location in Active Directory

The value of RecipientContainer can be the canonical name of an organizational unit (OU) or a domain. If a value for RecipientContainer is not specified, the default search filter is the location of the dynamic distribution group in Active Directory.

No

<RecipientFilter>

Filters the mail-enabled recipients that are used to build the dynamic distribution group

RecipientFilter cannot be used if the any of the following parameters are specified:

  • IncludedRecipients
  • ConditionalCompany
  • ConditionalDepartment

  • ConditionalStateorProvinceRecipientFilter (uses OPath syntax to query Active Directory and filter recipients)

    Note

    For more information about the filterable properties, see Filterable Properties for the -RecipientFilter parameter.


    RecipientFilter can use any combination of the following object types as filters:

  • RecipientType
  • ConditionalCompany
  • ConditionalDepartment
  • ConditionalStateorProvince

No

<RejectMessagesFrom>

Specifies mailbox users and mail-enabled contacts that are not allowed to send e-mail messages to the distribution group

You can use any of the following values for the prohibited senders:

  • Distinguished name (DN)
  • Canonical name
  • GUID
  • Name
  • Display name
  • Legacy Exchange DN
  • Primary SMTP e-mail address (This parameter is blank by default. This default value enables the distribution group to accept messages from all mailbox users and all mail-enabled contacts)

No

<RejectMessagesFromDLMembers>

Specifies the distribution groups who are not allowed to send e-mail messages to the distribution group

You can use any of the following values for the prohibited distribution groups:

  • Distinguished name (DN)
  • Canonical name
  • GUID
  • Name
  • Display name
  • Legacy Exchange DN
  • Primary SMTP e-mail address (This parameter is blank by default. This default value enables the distribution group to accept messages from all mailbox users and all mail-enabled contacts)

No

<ReportToManagerEnabled>

Enables delivery reports to be sent to the distribution group manager

Valid values: true, false (default)

No

<ReportToOriginatorEnabled>

Enables delivery reports to be sent to the sender of e-mail messages that are sent to the distribution group

Valid values: true (default), false

No

<RequireSenderAuthenticationEnabled>

Requires e-mail message delivery from authenticated senders

Valid values: true (default), false If the value is true, messages are accepted only from authenticated senders.

No

<SendOofMessageToOriginatorEnabled>

Enables Out of Office messages to be delivered to the sender of the e-mail messages that are sent to this distribution group

Valid values: true, false (default)

No

<SimpleDisplayName>

Used for displaying an alternative description of the object when only a limited set of characters is permitted

The limited set of characters consists of ASCII characters 26 through 126.

No

<UMDtmfMap>

Specifies if you want to create a user-defined DTMF map for the UM-enabled dynamic distribution group

No

<WindowsEmailAddress>

Specifies the value of the E-mail field of the Active Directory object

No

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*