Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2

Topic Last Modified: 2012-11-15

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

Syntax

Set-PublicFolder -Identity <PublicFolderIdParameter> [-AgeLimit <EnhancedTimeSpan>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-EformsLocaleId <CultureInfo>] [-HiddenFromAddressListsEnabled <$true | $false>] [-IssueWarningQuota <Unlimited>] [-MaxItemSize <Unlimited>] [-Name <String>] [-PerUserReadStateEnabled <$true | $false>] [-ProhibitPostQuota <Unlimited>] [-Replicas <DatabaseIdParameter[]>] [-ReplicationSchedule <Schedule>] [-RetainDeletedItemsFor <EnhancedTimeSpan>] [-Server <ServerIdParameter>] [-UseDatabaseAgeDefaults <$true | $false>] [-UseDatabaseQuotaDefaults <$true | $false>] [-UseDatabaseReplicationSchedule <$true | $false>] [-UseDatabaseRetentionDefaults <$true | $false>] [-WhatIf [<SwitchParameter>]]
Set-PublicFolder -Identity <PublicFolderIdParameter> [-AgeLimit <EnhancedTimeSpan>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-EformsLocaleId <CultureInfo>] [-HiddenFromAddressListsEnabled <$true | $false>] [-IssueWarningQuota <Unlimited>] [-LocalReplicaAgeLimit <EnhancedTimeSpan>] [-MaxItemSize <Unlimited>] [-Name <String>] [-PerUserReadStateEnabled <$true | $false>] [-ProhibitPostQuota <Unlimited>] [-Replicas <DatabaseIdParameter[]>] [-ReplicationSchedule <Schedule>] [-RetainDeletedItemsFor <EnhancedTimeSpan>] [-Server <ServerIdParameter>] [-UseDatabaseAgeDefaults <$true | $false>] [-UseDatabaseQuotaDefaults <$true | $false>] [-UseDatabaseReplicationSchedule <$true | $false>] [-UseDatabaseRetentionDefaults <$true | $false>] [-WhatIf [<SwitchParameter>]]

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" entry in the Mailbox Permissions topic.

Parameters

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. This parameter is mutually exclusive with the UseDatabaseAgeDefaults parameter.

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

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.

HiddenFromAddressListsEnabled

Optional

System.Boolean

The HiddenFromAddressListsEnabled parameter specifies whether to hide the public folder from address lists.

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 250 megabytes (MB). 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. The valid input range for this parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the public folder.

LocalReplicaAgeLimit

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The LocalReplicaAgeLimit parameter specifies the age limit of the replica on the connected server, if there is a replica on it.

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. 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. The valid input range for this parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the public folder.

Name

Optional

System.String

The Name parameter specifies the name for the public folder.

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.

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. The valid input range for this parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the public folder.

Replicas

Optional

Microsoft.Exchange.Configuration.Tasks.DatabaseIdParameter[]

The Replicas parameter specifies a list of public folder databases with which to replicate this public folder.

ReplicationSchedule

Optional

Microsoft.Exchange.Data.Schedule

The ReplicationSchedule parameter specifies the replication schedule for the folder.

The format is StartDay.Hour:Minute [AM/PM]-EndDay.Hour:Minute [AM/PM]. You can use the following values for the start and end days:

  • Full name of the day

  • Abbreviated name of the day

  • Integer from 0 through 6, where 0 = Sunday

If you prefer to use a 24-hour clock, omit AM/PM. If you use AM/PM, you must include a space between the time and AM or PM.

Formats can be mixed.

The start time and end time must be at least 15 minutes apart. Minutes are rounded down to 0, 15, 30, or 45. If you specify more than one interval, there must be at least 15 minutes between each interval.

The following are examples:

  • "Sun.11:30 PM-Mon.1:30 AM"

  • 6.22:00-6.22:15 (Maintenance will run from Saturday at 10:00 PM until Saturday at 10:15 PM.)

  • "Monday.4:30 AM-Monday.5:30 AM","Wednesday.4:30 AM-Wednesday.5:30 AM" (Maintenance will run on Monday and Wednesday mornings from 4:30 until 5:30.)

  • "Sun.1:15 AM-Monday.23:00"

RetainDeletedItemsFor

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The RetainDeletedItemsFor parameter specifies the retention time for deleted items. This parameter is mutually exclusive with the UseDatabaseRetentionDefaults parameter.

Server

Optional

Microsoft.Exchange.Configuration.Tasks.ServerIdParameter

The Server parameter specifies the server on which to perform the selected operations.

UseDatabaseAgeDefaults

Optional

System.Boolean

The UseDatabaseAgeDefaults parameter specifies whether to use the database age limit.

UseDatabaseQuotaDefaults

Optional

System.Boolean

The UseDatabaseQuotaDefaults parameter specifies whether to use the public store quota limits.

UseDatabaseReplicationSchedule

Optional

System.Boolean

The UseDatabaseReplicationSchedule parameter specifies whether to use the public folder replication schedule.

UseDatabaseRetentionDefaults

Optional

System.Boolean

The UseDatabaseRetentionDefaults parameter specifies whether to use the database retention defaults.

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.

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.

Examples

EXAMPLE 1

This example changes a public folder so that it doesn't use the database default replication schedule.

Copy Code
Set-PublicFolder "\Customer Service Requests" -UseDatabaseReplicationSchedule $false

EXAMPLE 2

This example sets the folder to replicate only on weekends.

Copy Code
Set-PublicFolder \MyPublicFolder -ReplicationSchedule "Saturday.12:00 AM-Monday.12:00 AM"