Export (0) Print
Expand All

Set-PublicFolder

 

Applies to: Exchange Server 2013, Exchange Online

Topic Last Modified: 2014-03-14

This cmdlet is available in on-premises Exchange Server 2013 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-PublicFolder cmdlet to set the attributes of public folders.

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

Set-PublicFolder -Identity <PublicFolderIdParameter> [-AgeLimit <EnhancedTimeSpan>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-EformsLocaleId <CultureInfo>] [-Force <SwitchParameter>] [-IssueWarningQuota <Unlimited>] [-LastMovedTime <ExDateTime>] [-MaxItemSize <Unlimited>] [-Name <String>] [-OverrideContentMailbox <MailboxIdParameter>] [-Path <PublicFolderIdParameter>] [-PerUserReadStateEnabled <$true | $false>] [-ProhibitPostQuota <Unlimited>] [-RetainDeletedItemsFor <EnhancedTimeSpan>] [-WhatIf [<SwitchParameter>]]

This example changes the content location of the public folder hierarchy mailbox to North_America.

Set-PublicFolder "\Customer Service Requests" -OverrideContentMailbox North_America

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" entry in the Sharing and collaboration permissions topic.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.PublicFolderIdParameter

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.

AgeLimit

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The AgeLimit parameter specifies the overall age limit on the folder. Replicas of this public folder are automatically deleted when the age limit is exceeded.

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.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is available only in on-premises Exchange 2013.

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

EformsLocaleId

Optional

System.Globalization.CultureInfo

The EformsLocaleId parameter specifies the locale-specific version of the e-forms library. The valid input for the EformsLocaleId parameter is the string names listed in the Culture Name column in the Microsoft .NET Class Library class reference available at CultureInfo Class.

Force

Optional

System.Management.Automation.SwitchParameter

The Force switch specifies whether to suppress warning or confirmation messages. This switch can be used when the task is run programmatically and prompting for administrative input is inappropriate. If the Force switch isn't provided in the command, you're prompted for administrative input. You don't have to specify a value with this parameter.

IssueWarningQuota

Optional

Microsoft.Exchange.Data.Unlimited

The IssueWarningQuota parameter specifies the public folder size that triggers a warning to public folder owners stating that the folder is almost full.

The default value is unlimited, which is 2 terabytes. 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 kilobytes. The valid input range for this parameter is from 1 through 2TB.

LastMovedTime

Optional

Microsoft.Exchange.ExchangeSystem.ExDateTime

The LastMovedTime parameter specifies the date and time that the public folder was last moved.

Use the short date format defined in the Regional Options settings for the computer on which the command is run. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 03/01/2010 to specify March 1, 2010. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, you must enclose the argument in quotation marks ("), for example, "10/05/2010 5:00 PM".

MaxItemSize

Optional

Microsoft.Exchange.Data.Unlimited

The MaxItemSize parameter specifies the maximum size for posted items. Items larger than the value of the MaxItemSize parameter are rejected. The default value is unlimited, which is 2 gigabytes. 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 kilobytes. The valid input range for this parameter is from 1 through 2GB.

Name

Optional

System.String

The Name parameter specifies the name for the public folder.

OverrideContentMailbox

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

This parameter is available only in on-premises Exchange 2013.

The OverrideContentMailbox parameter specifies the identity of the public folder mailbox that you want to move this public folder's content to.

Path

Optional

Microsoft.Exchange.Configuration.Tasks.PublicFolderIdParameter

The Path parameter specifies the path of the public folder, for example, \TopLevelPublicFolder\PublicFolder.

PerUserReadStateEnabled

Optional

System.Boolean

The PerUserReadStateEnabled parameter specifies whether to maintain read and unread data on a per-user basis.

ProhibitPostQuota

Optional

Microsoft.Exchange.Data.Unlimited

The ProhibitPostQuota parameter specifies the size of a public folder at which users are notified that the public folder is full. Users can't post to a folder whose size is larger than the ProhibitPostQuota parameter value. The default value is unlimited, which is 2 terabytes.

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 kilobytes. The valid input range for this parameter is from 1 through 2TB.

RetainDeletedItemsFor

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The RetainDeletedItemsFor parameter specifies the retention time for deleted items.

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.

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.

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.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft