Commands › Exchange Online
Set-MailPublicFolder
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. NOTE: The settings that you configure on a public folder mailbox might interfere with the existing settings on a public folder within in the mailbox.
Quick start script
# Set-MailPublicFolder — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-ExchangeOnline -CertificateThumbprint $thumb -AppId $appId -Organization $org
# 2. Capture the current state first — you cannot roll back what you never recorded
$before = Get-MailPublicFolder
$before | Format-List
# 3. Make the change (dry run first)
Set-MailPublicFolder -Identity <MailPublicFolderIdParameter> -WhatIf
Set-MailPublicFolder -Identity <MailPublicFolderIdParameter>
# 4. Verify and diff
$after = Get-MailPublicFolder
Compare-Object ($before | Out-String) ($after | Out-String)Syntax
Set-MailPublicFolder [-Identity] <MailPublicFolderIdParameter>
[-AcceptMessagesOnlyFrom <MultiValuedProperty>]
[-AcceptMessagesOnlyFromDLMembers <MultiValuedProperty>]
[-AcceptMessagesOnlyFromSendersOrMembers <MultiValuedProperty>]
[-Alias <String>]
[-ArbitrationMailbox <MailboxIdParameter>]
[-BypassModerationFromSendersOrMembers <MultiValuedProperty>]
[-Confirm]
[-Contacts <RecipientIdParameter[]>]
[-CreateDTMFMap <Boolean>]
[-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 <Boolean>]
[-DisplayName <String>]
[-DomainController <Fqdn>]
[-EmailAddresses <ProxyAddressCollection>]
[-EmailAddressPolicyEnabled <Boolean>]
[-EntryId <String>]
[-ExtensionCustomAttribute1 <MultiValuedProperty>]
[-ExtensionCustomAttribute2 <MultiValuedProperty>]
[-ExtensionCustomAttribute3 <MultiValuedProperty>]
[-ExtensionCustomAttribute4 <MultiValuedProperty>]
[-ExtensionCustomAttribute5 <MultiValuedProperty>]
[-ExternalEmailAddress <ProxyAddress>]
[-ForwardingAddress <RecipientIdParameter>]
[-GrantSendOnBehalfTo <MultiValuedProperty>]
[-HiddenFromAddressListsEnabled <Boolean>]
[-IgnoreDefaultScope]
[-IgnoreMissingFolderLink <Boolean>]
[-MailTip <String>]
[-MailTipTranslations <MultiValuedProperty>]
[-MaxReceiveSize <Unlimited>]
[-MaxSendSize <Unlimited>]
[-ModeratedBy <MultiValuedProperty>]
[-ModerationEnabled <Boolean>]
[-Name <String>]
[-OnPremisesObjectId <Guid>]
[-PhoneticDisplayName <String>]
[-PrimarySmtpAddress <SmtpAddress>]
[-PublicFolderType <PublicFolderType>]
[-RejectMessagesFrom <MultiValuedProperty>]
[-RejectMessagesFromDLMembers <MultiValuedProperty>]
[-RejectMessagesFromSendersOrMembers <MultiValuedProperty>]
[-RequireSenderAuthenticationEnabled <Boolean>]
[-SendModerationNotifications <TransportModerationNotificationFlags>]
[-Server <ServerIdParameter>]
[-SimpleDisplayName <String>]
[-UMDtmfMap <MultiValuedProperty>]
[-WhatIf]
[-WindowsEmailAddress <SmtpAddress>]
[<CommonParameters>]Parameters (63)
| Parameter | Type | Required | What it controls |
|---|---|---|---|
| -Identity | MailPublicFolderIdParameter | yes | 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. |
| -AcceptMessagesOnlyFrom | MultiValuedProperty | The AcceptMessagesOnlyFrom parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. | |
| -AcceptMessagesOnlyFromDLMembers | MultiValuedProperty | The AcceptMessagesOnlyFromDLMembers parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. | |
| -AcceptMessagesOnlyFromSendersOrMembers | MultiValuedProperty | The AcceptMessagesOnlyFromSendersOrMembers parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. | |
| -Alias | String | The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email... | |
| -ArbitrationMailbox | MailboxIdParameter | The ArbitrationMailbox parameter specifies the mailbox used to manage the moderation process. You can use any value that uniquely identifies the mailbox. For example: | |
| -BypassModerationFromSendersOrMembers | MultiValuedProperty | The BypassModerationFromSendersOrMembers parameter specifies who is allowed to send messages to this moderated recipient without approval from a moderator. Valid values for this parameter are individual senders and... | |
| -Confirm | SwitchParameter | The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on whether the cmdlet requires confirmation before proceeding. | |
| -Contacts | 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 | Boolean | The CreateDTMFMap parameter specifies that a dual tone multi-frequency (DTMF) map be created for the user. | |
| -CustomAttribute1 | String | This parameter specifies a value for the CustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute10 | String | This parameter specifies a value for the CustomAttribute10 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute11 | String | This parameter specifies a value for the CustomAttribute11 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute12 | String | This parameter specifies a value for the CustomAttribute12 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute13 | String | This parameter specifies a value for the CustomAttribute13 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute14 | String | This parameter specifies a value for the CustomAttribute14 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute15 | String | This parameter specifies a value for the CustomAttribute15 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute2 | String | This parameter specifies a value for the CustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute3 | String | This parameter specifies a value for the CustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute4 | String | This parameter specifies a value for the CustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute5 | String | This parameter specifies a value for the CustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute6 | String | This parameter specifies a value for the CustomAttribute6 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute7 | String | This parameter specifies a value for the CustomAttribute7 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute8 | String | This parameter specifies a value for the CustomAttribute8 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute9 | String | This parameter specifies a value for the CustomAttribute9 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -DeliverToMailboxAndForward | Boolean | The DeliverToMailboxAndForward parameter specifies the message delivery behavior when a forwarding address is specified by the ForwardingAddress or ForwardingSmtpAddress parameters. Valid values are: | |
| -DisplayName | String | The DisplayName parameter specifies the display name of the Public Folder Proxy object. The display name is visible in the Exchange admin center, address lists, and Outlook. The maximum length is 256 characters. If... | |
| -DomainController | Fqdn | This parameter is available only in on-premises Exchange. | |
| -EmailAddresses | ProxyAddressCollection | The EmailAddresses parameter specifies all email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy... | |
| -EmailAddressPolicyEnabled | Boolean | The EmailAddressPolicyEnabled parameter specifies whether to apply email address policies to this recipient. Valid values are: | |
| -EntryId | String | The EntryId parameter specifies the EntryID value for the public folder. You use this parameter to correct an existing EntryID that points to a folder that can't be found. | |
| -ExtensionCustomAttribute1 | MultiValuedProperty | This parameter specifies a value for the ExtensionCustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You... | |
| -ExtensionCustomAttribute2 | MultiValuedProperty | This parameter specifies a value for the ExtensionCustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You... | |
| -ExtensionCustomAttribute3 | MultiValuedProperty | This parameter specifies a value for the ExtensionCustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You... | |
| -ExtensionCustomAttribute4 | MultiValuedProperty | This parameter specifies a value for the ExtensionCustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You... | |
| -ExtensionCustomAttribute5 | MultiValuedProperty | This parameter specifies a value for the ExtensionCustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You... | |
| -ExternalEmailAddress | ProxyAddress | The ExternalEmailAddress parameter specifies an email address outside the organization. | |
| -ForwardingAddress | RecipientIdParameter | The ForwardingAddress parameter specifies a forwarding address for messages that are sent to this public folder. A valid value for this parameter is a recipient in your organization. You can use any value that... | |
| -GrantSendOnBehalfTo | MultiValuedProperty | The GrantSendOnBehalfTo parameter specifies who can send on behalf of this public folder. Although messages sent on behalf of the mail user clearly show the sender in the From field (`<Sender> on behalf of... | |
| -HiddenFromAddressListsEnabled | Boolean | The HiddenFromAddressListsEnabled parameter specifies whether this recipient is visible in address lists. Valid values are: | |
| -IgnoreDefaultScope | SwitchParameter | The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. | |
| -IgnoreMissingFolderLink | Boolean | The IgnoreMissingFolderLink parameter specifies whether to exclude the mail-enabled public folder from a specific validation check that's used during a public folder migration. Valid values are: | |
| -MailTip | String | The MailTip parameter specifies the custom MailTip text for this recipient. The MailTip is shown to senders when they start drafting an email message to this recipient. If the value contains spaces, enclose the value... | |
| -MailTipTranslations | MultiValuedProperty | The MailTipTranslations parameter specifies additional languages for the custom MailTip text that's defined by the MailTip parameter. HTML tags are automatically added to the MailTip translation, additional HTML tags... | |
| -MaxReceiveSize | Unlimited | The MaxReceiveSize parameter specifies the maximum size of a message that can be sent to the public folder. Messages larger than the maximum size are rejected. | |
| -MaxSendSize | Unlimited | The MaxSendSize parameter specifies the maximum size of a message that can be sent by the public folder. | |
| -ModeratedBy | MultiValuedProperty | The ModeratedBy parameter specifies one or more moderators for this recipient. A moderator approves messages sent to the recipient before the messages are delivered. A moderator must be a mailbox, mail user, or mail... | |
| -ModerationEnabled | Boolean | The ModerationEnabled parameter specifies whether moderation is enabled for this recipient. Valid value are: | |
| -Name | String | The Name parameter specifies the unique name of the public folder. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). | |
| -OnPremisesObjectId | Guid | The OnPremisesObjectId parameter specifies the ObjectID (GUID) value of the mail-enabled public folder from the on-premises environment. | |
| -PhoneticDisplayName | String | The PhoneticDisplayName parameter specifies an alternate spelling of the user's name that's used for text to speech in Unified Messaging (UM) environments. Typically, you use this parameter when the pronunciation and... | |
| -PrimarySmtpAddress | SmtpAddress | The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. | |
| -PublicFolderType | PublicFolderType | The PublicFolderType parameter specifies which of the following four types is assigned to the public folder: | |
| -RejectMessagesFrom | MultiValuedProperty | The RejectMessagesFrom parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. | |
| -RejectMessagesFromDLMembers | MultiValuedProperty | The RejectMessagesFromDLMembers parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. | |
| -RejectMessagesFromSendersOrMembers | MultiValuedProperty | The RejectMessagesFromSendersOrMembers parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. | |
| -RequireSenderAuthenticationEnabled | Boolean | The RequireSenderAuthenticationEnabled parameter specifies whether to accept messages only from authenticated (internal) senders. Valid values are: | |
| -SendModerationNotifications | TransportModerationNotificationFlags | The SendModerationNotifications parameter specifies when moderation notification messages are sent. Valid values are: | |
| -Server | ServerIdParameter | The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: | |
| -SimpleDisplayName | String | The SimpleDisplayName parameter is used to display an alternative description of the object when only a limited set of characters is permitted. Valid characters are: | |
| -UMDtmfMap | MultiValuedProperty | The UMDtmfMap parameter specifies if you want to create a user-defined DTMF map for the UM-enabled user. | |
| -WhatIf | SwitchParameter | The WhatIf switch shows what the command does without making any changes. You don't need to specify a value with this switch. | |
| -WindowsEmailAddress | SmtpAddress | The WindowsEmailAddress parameter specifies the Windows email address for this recipient. This is a common Active Directory attribute that's present in all environments, including environments without Exchange. Using... |
Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.