Applies to: Exchange Server 2013

Topic Last Modified: 2013-01-13

Use the Set-MailPublicFolder cmdlet to configure the mail-related settings of mail-enabled public folders. If you want to configure basic settings that aren't mail related, use the Set-PublicFolder cmdlet.

For information about the parameter sets in the Syntax section below, see Syntax.

Syntax

Set-MailPublicFolder -Identity <MailPublicFolderIdParameter> [-AcceptMessagesOnlyFrom <MultiValuedProperty>] [-AcceptMessagesOnlyFromDLMembers <MultiValuedProperty>] [-AcceptMessagesOnlyFromSendersOrMembers <MultiValuedProperty>] [-Alias <String>] [-ArbitrationMailbox <MailboxIdParameter>] [-BypassModerationFromSendersOrMembers <MultiValuedProperty>] [-Confirm [<SwitchParameter>]] [-Contacts <RecipientIdParameter[]>] [-CreateDTMFMap <$true | $false>] [-CustomAttribute1 <String>] [-CustomAttribute10 <String>] [-CustomAttribute11 <String>] [-CustomAttribute12 <String>] [-CustomAttribute13 <String>] [-CustomAttribute14 <String>] [-CustomAttribute15 <String>] [-CustomAttribute2 <String>] [-CustomAttribute3 <String>] [-CustomAttribute4 <String>] [-CustomAttribute5 <String>] [-CustomAttribute6 <String>] [-CustomAttribute7 <String>] [-CustomAttribute8 <String>] [-CustomAttribute9 <String>] [-DeliverToMailboxAndForward <$true | $false>] [-DisplayName <String>] [-DomainController <Fqdn>] [-EmailAddresses <ProxyAddressCollection>] [-EmailAddressPolicyEnabled <$true | $false>] [-ExtensionCustomAttribute1 <MultiValuedProperty>] [-ExtensionCustomAttribute2 <MultiValuedProperty>] [-ExtensionCustomAttribute3 <MultiValuedProperty>] [-ExtensionCustomAttribute4 <MultiValuedProperty>] [-ExtensionCustomAttribute5 <MultiValuedProperty>] [-ExternalEmailAddress <ProxyAddress>] [-ForwardingAddress <RecipientIdParameter>] [-GrantSendOnBehalfTo <MultiValuedProperty>] [-HiddenFromAddressListsEnabled <$true | $false>] [-IgnoreDefaultScope <SwitchParameter>] [-MailTip <String>] [-MailTipTranslations <MultiValuedProperty>] [-MaxReceiveSize <Unlimited>] [-MaxSendSize <Unlimited>] [-ModeratedBy <MultiValuedProperty>] [-ModerationEnabled <$true | $false>] [-Name <String>] [-PhoneticDisplayName <String>] [-PrimarySmtpAddress <SmtpAddress>] [-RejectMessagesFrom <MultiValuedProperty>] [-RejectMessagesFromDLMembers <MultiValuedProperty>] [-RejectMessagesFromSendersOrMembers <MultiValuedProperty>] [-RequireSenderAuthenticationEnabled <$true | $false>] [-SendModerationNotifications <Never | Internal | Always>] [-SimpleDisplayName <String>] [-UMDtmfMap <MultiValuedProperty>] [-WhatIf [<SwitchParameter>]] [-WindowsEmailAddress <SmtpAddress>]

Examples

EXAMPLE 1

This example sets the primary SMTP address of the mail-enabled public folder MyPublicFolder@contoso.com to MyPublicFolder@fabrikam.com.

Copy Code
Set-MailPublicFolder -Identity MyPublicFolder@contoso.com -PrimarySmtpAddress MyPublicFolder@fabrikam.com

Detailed Description

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Public folders, mail-enabled" section in the Sharing and Collaboration Permissions topic.

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.MailPublicFolderIdParameter

The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format \TopLevelPublicFolder\PublicFolder.

You can omit the parameter label so that only the public folder name or GUID is supplied.

AcceptMessagesOnlyFrom

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The AcceptMessagesOnlyFrom parameter specifies the mailbox users, mail users, and mail contacts that can send email messages to this mail-enabled public folder. You can also specify Microsoft Exchange as a valid recipient for this parameter. If you configure a mail-enabled public folder to accept messages only from the Microsoft Exchange recipient, it only receives system-generated messages.

The AcceptMessagesOnlyFrom parameter can take any of the following values for valid senders:

  • Distinguished name (DN)

  • Canonical name

  • GUID

  • Name

  • Display name

  • Alias

  • Exchange DN

  • Primary SMTP email address

By default, this parameter is blank. This default value enables the mail-enabled public folder to accept messages from all senders.

AcceptMessagesOnlyFromDLMembers

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The AcceptMessagesOnlyFromDLMembers parameter specifies the distribution groups whose members are allowed to send email messages to this mail-enabled public folder. You can use any of the following values for the allowed distribution groups:

  • DN

  • Canonical name

  • GUID

  • Name

  • Display name

  • Legacy Exchange DN

  • Primary SMTP email address

By default, this parameter is blank. This default value enables the mail-enabled public folder to accept messages from all senders.

AcceptMessagesOnlyFromSendersOrMembers

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The AcceptMessagesOnlyFromSendersOrMembers parameter specifies the mailbox users, mail users, mail contacts, and distribution groups who are allowed to send email messages to this mail-enabled public folder. You can use any of the following values for the allowed distribution groups:

  • DN

  • Canonical name

  • GUID

  • Name

  • Display name

  • Legacy Exchange DN

  • Primary SMTP email address

By default, this parameter is blank. This default value enables the mail-enabled public folder to accept messages from all senders.

Alias

Optional

System.String

The Alias parameter specifies the alias (mail nickname) of the public folder. If not specified, the Alias parameter value is stamped with the name of the public folder.

The string must comply with RFC 2821 requirements for valid "local part" SMTP addresses.

ArbitrationMailbox

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

The ArbitrationMailbox parameter specifies the mailbox used to manage the moderation process.

BypassModerationFromSendersOrMembers

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The BypassModerationFromSendersOrMembers parameter specifies the recipients whose messages bypass moderation when sending to this mail-enabled public folder. You can use any of the following values:

  • DN

  • Canonical name

  • GUID

  • Name

  • Display name

  • Legacy Exchange DN

  • Primary SMTP email address

By default, this parameter is blank. This default value enables the mail-enabled public folder to accept messages from all senders.

Senders designated as moderators for this mail-enabled public folder are allowed to send messages to this mail-enabled public folder.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch.

Contacts

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]

The Contacts parameter specifies the contacts for the public folder. Contacts are persons about whom you can save several types of information, such as addresses, telephone numbers, and web page URLs.

CreateDTMFMap

Optional

System.Boolean

The CreateDTMFMap parameter specifies that a dual tone multi-frequency (DTMF) map be created for the user.

CustomAttribute1

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute10

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute11

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute12

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute13

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute14

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute15

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute2

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute3

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute4

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute5

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute6

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute7

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute8

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute9

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

DeliverToMailboxAndForward

Optional

System.Boolean

The DeliverToMailboxAndForward parameter specifies whether email messages are sent to a forwarding address.

DisplayName

Optional

System.String

The DisplayName parameter specifies the display name of the Public Folder Proxy object.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.

EmailAddresses

Optional

Microsoft.Exchange.Data.ProxyAddressCollection

The EmailAddresses parameter specifies proxy addresses (for example, user@contoso.com).

EmailAddressPolicyEnabled

Optional

System.Boolean

The EmailAddressPolicyEnabled parameter specifies whether to enable an email address policy that's applied to the folder.

ExtensionCustomAttribute1

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values.

For more information about custom attributes, see Custom Attributes.

For more information about using multivalued properties, see Modifying Multivalued Properties.

ExtensionCustomAttribute2

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values.

For more information about custom attributes, see Custom Attributes.

For more information about using multivalued properties, see Modifying Multivalued Properties.

ExtensionCustomAttribute3

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values.

For more information about custom attributes, see Custom Attributes.

For more information about using multivalued properties, see Modifying Multivalued Properties.

ExtensionCustomAttribute4

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values.

For more information about custom attributes, see Custom Attributes.

For more information about using multivalued properties, see Modifying Multivalued Properties.

ExtensionCustomAttribute5

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values.

For more information about custom attributes, see Custom Attributes.

For more information about using multivalued properties, see Modifying Multivalued Properties.

ExternalEmailAddress

Optional

Microsoft.Exchange.Data.ProxyAddress

The ExternalEmailAddress parameter specifies an email address outside the organization.

ForwardingAddress

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter

The ForwardingAddress parameter specifies the forwarding address of the folder.

GrantSendOnBehalfTo

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The GrantSendOnBehalfTo parameter specifies the DN of other mailboxes that can send on behalf of this folder.

HiddenFromAddressListsEnabled

Optional

System.Boolean

The HiddenFromAddressListsEnabled parameter specifies whether the mailbox is viewable from address lists.

IgnoreDefaultScope

Optional

System.Management.Automation.SwitchParameter

The IgnoreDefaultScope parameter instructs the command to ignore the default recipient scope setting for the Exchange Management Shell session and use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently in the default scope. Using the IgnoreDefaultScope parameter introduces the following restrictions:

  • You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically.

MailTip

Optional

System.String

The MailTip parameter specifies the message that's displayed to senders when they start drafting an email message to this recipient. The MailTip parameter message must be less than or equal to 250 characters.

MailTipTranslations

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The MailTipTranslations parameter specifies additional languages when you want to provide the MailTip parameter information for this recipient in multiple languages. For each language, you must provide the locale, followed by a colon and the specific MailTip parameter value in that language. Each MailTip parameter value must be less than or equal to 250 characters. Multiple languages can be separated by commas.

MaxReceiveSize

Optional

Microsoft.Exchange.Data.Unlimited

The MaxReceiveSize parameter specifies the maximum size of email messages that can be received by the folder. Valid values are from 1 kilobyte (KB) to 2,097,151 KB. If a value isn't specified for this parameter, no size limit is imposed.

MaxSendSize

Optional

Microsoft.Exchange.Data.Unlimited

The MaxSendSize parameter specifies the maximum size of email messages that can be sent. Valid values are from 1 KB to 2,097,151 KB. If a value isn't specified for this parameter, no size limit is imposed.

ModeratedBy

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ModeratedBy parameter specifies the users who are responsible for moderating the messages sent to the mail-enabled public folder. To designate more than one user, separate the users with commas.

This parameter is required if you set the ModerationEnabled parameter to $true. If you leave this parameter blank and there is a user who is already specified as the manager of this distribution group, the ModeratedBy parameter is automatically set by the ManagedBy parameter of the mail-enabled public folder. Otherwise, an error is returned.

ModerationEnabled

Optional

System.Boolean

The ModerationEnabled parameter specifies whether to enable moderation for the mail-enabled public folder. To enable moderation, set this parameter to $true. To disable moderation, set this parameter to $false.

The default value is $false.

Name

Optional

System.String

The Name parameter specifies the name of the public folder. Use this parameter if you want to change the name of the public folder.

PhoneticDisplayName

Optional

System.String

The PhoneticDisplayName parameter specifies a phonetic pronunciation of the DisplayName parameter.

The maximum length of this parameter value is 255 characters.

PrimarySmtpAddress

Optional

Microsoft.Exchange.Data.SmtpAddress

The PrimarySmtpAddress parameter specifies the primary SMTP address for the folder.

RejectMessagesFrom

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The RejectMessagesFrom parameter specifies the recipients from which to reject messages. You can use any of the following values to specify the recipients:

  • DN

  • Canonical name

  • GUID

  • Name

  • Display name

  • LegacyExchangeDN

  • Primary SMTP email address

By default, this parameter is blank. This default value enables the mail-enabled public folder to accept messages from all senders.

RejectMessagesFromDLMembers

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The RejectMessagesFromDLMembers parameter specifies the distribution list members from which to reject messages. You can use any of the following values to specify the recipients:

  • DN

  • Canonical name

  • GUID

  • Name

  • Display name

  • LegacyExchangeDN

  • Primary SMTP email address

By default, this parameter is blank. This default value enables the mail-enabled public folder to accept messages from all senders.

RejectMessagesFromSendersOrMembers

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The RejectMessagesFromSendersOrMembers parameter specifies the mailbox users, mail users, mail contacts, and distribution groups whose members aren't allowed to send email messages to this mail-enabled public folder. You can use any of the following values to specify the recipients:

  • DN

  • Canonical name

  • GUID

  • Name

  • Display name

  • LegacyExchangeDN

  • Primary SMTP email address

By default, this parameter is blank. This default value enables the mail-enabled public folder to accept messages from all senders.

RequireSenderAuthenticationEnabled

Optional

System.Boolean

The RequireSenderAuthenticationEnabled parameter specifies whether senders must be authenticated.

SendModerationNotifications

Optional

Microsoft.Exchange.Data.Directory.Recipient.TransportModerationNotificationFlags

The SendModerationNotifications parameter specifies whether status notifications are sent to users when they send a message to the moderated distribution group. You can specify one of the following values:

  • Always

  • Internal

  • Never

Set this parameter to Always if you want notifications to be sent to all senders.

Set this parameter to Internal if you want notifications to be sent only to the senders who are internal to your organization.

Set this parameter to Never to disable all status notifications.

Note:
The sender is always notified if the message is rejected by the moderators, regardless of the value of this parameter.

The default value is Never.

SimpleDisplayName

Optional

System.String

The SimpleDisplayName parameter is used to display an alternative description of the object when only a limited set of characters is permitted. This limited set of characters consists of ASCII characters 26 through 126, inclusively.

UMDtmfMap

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The UMDtmfMap parameter specifies if you want to create a user-defined DTMF map for the UM-enabled user.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch.

WindowsEmailAddress

Optional

Microsoft.Exchange.Data.SmtpAddress

The WindowsEmailAddress parameter specifies an email address in the format EmailAddress@contoso.com.

Input Types

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

Return Types

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.