Set-PublicFolder (RTM)
Microsoft Exchange Server 2007 will reach end of support on April 11, 2017. To stay supported, you will need to upgrade. For more information, see Resources to help you upgrade your Office 2007 servers and clients.
Applies to: Exchange Server 2007
Use the Set-PublicFolder cmdlet to set the attributes of public folders.
Syntax
Set-PublicFolder -Identity <PublicFolderIdParameter> [-AgeLimit <EnhancedTimeSpan>] [-DomainController <Fqdn>] [-HiddenFromAddressListsEnabled <$true | $false>] [-MaxItemSize <Unlimited>] [-Name <String>] [-PerUserReadStateEnabled <$true | $false>] [-PostStorageQuota <Unlimited>] [-Replicas <DatabaseIdParameter[]>] [-ReplicationSchedule <Schedule>] [-RetainDeletedItemsFor <EnhancedTimeSpan>] [-Server <ServerIdParameter>] [-StorageQuota <Unlimited>] [-UseDatabaseAgeDefaults <$true | $false>] [-UseDatabaseQuotaDefaults <$true | $false>] [-UseDatabaseReplicationSchedule <$true | $false>] [-UseDatabaseRetentionDefaults <$true | $false>]
Set-PublicFolder -Identity <PublicFolderIdParameter> [-AgeLimit <EnhancedTimeSpan>] [-DomainController <Fqdn>] [-HiddenFromAddressListsEnabled <$true | $false>] [-LocalReplicaAgeLimit <EnhancedTimeSpan>] [-MaxItemSize <Unlimited>] [-Name <String>] [-PerUserReadStateEnabled <$true | $false>] [-PostStorageQuota <Unlimited>] [-Replicas <DatabaseIdParameter[]>] [-ReplicationSchedule <Schedule>] [-RetainDeletedItemsFor <EnhancedTimeSpan>] [-Server <ServerIdParameter>] [-StorageQuota <Unlimited>] [-UseDatabaseAgeDefaults <$true | $false>] [-UseDatabaseQuotaDefaults <$true | $false>] [-UseDatabaseReplicationSchedule <$true | $false>] [-UseDatabaseRetentionDefaults <$true | $false>]
Set-PublicFolder [-AgeLimit <EnhancedTimeSpan>] [-DomainController <Fqdn>] [-HiddenFromAddressListsEnabled <$true | $false>] [-Instance <PublicFolder>] [-MaxItemSize <Unlimited>] [-Name <String>] [-PerUserReadStateEnabled <$true | $false>] [-PostStorageQuota <Unlimited>] [-Replicas <DatabaseIdParameter[]>] [-ReplicationSchedule <Schedule>] [-RetainDeletedItemsFor <EnhancedTimeSpan>] [-Server <ServerIdParameter>] [-StorageQuota <Unlimited>] [-UseDatabaseAgeDefaults <$true | $false>] [-UseDatabaseQuotaDefaults <$true | $false>] [-UseDatabaseReplicationSchedule <$true | $false>] [-UseDatabaseRetentionDefaults <$true | $false>]
Detailed Description
To run the Set-PublicFolder cmdlet, the account you use must be delegated the following:
- Exchange Organization Administrator role
For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.PublicFolderIdParameter |
Use the Identity parameter to specify 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 Identity so that only the public folder name or GUID is supplied. |
AgeLimit |
Optional |
Microsoft.Exchange.Data.EnhancedTimeSpan |
The AgeLimit parameter specifies the overall age limit on the folder. This parameter is mutually exclusive with the UseDatabaseAgeDefaults parameter. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the domain controller to use to write this configuration change to Active Directory. Use the fully qualified domain name (FQDN) of the domain controller that you want to use. |
HiddenFromAddressListsEnabled |
Optional |
System.Boolean |
The HiddenFromAddressListsEnabled parameter specifies whether to hide the public folder from address lists. |
Instance |
Optional |
Microsoft.Exchange.Data.Mapi.PublicFolder |
The Instance parameter 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. |
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 item size in kilobytes (KB) that can be posted. This parameter is mutually exclusive with the UseDatabaseQuotaDefaults parameter. |
Name |
Optional |
System.String |
The Name parameter specifies the name for the public folder. |
PerUserReadStateEnabled |
Optional |
System.Boolean |
The PerUserReadStateEnabled parameter specifies to maintain read and unread data on a per-user basis. |
PostStorageQuota |
Optional |
Microsoft.Exchange.Data.Unlimited |
The PostStorageQuota parameter specifies the size (in KB) when a public folder doesn't allow posting. This parameter is mutually exclusive with the UseDatabaseQuotaDefaults parameter. |
Replicas |
Optional |
Microsoft.Exchange.Configuration.Tasks.DatabaseIdParameter[] |
The Replicas parameter specifies a list of Mailbox servers with which to replicate this public folder. |
ReplicationSchedule |
Optional |
Microsoft.Exchange.Data.Schedule |
The ReplicationSchedule parameter specifies the replication schedule for the folder in the following format: Weekday.Hour:Minute [AM/PM]-Weekday.Hour:Minute [AM/PM]. Weekdays can be is full form or abbreviated. If you prefer to use a 24-hour clock, omit AM/PM. Formats can be mixed. Example: Sun.1:15 AM-Monday.23:00 This parameter is mutually exclusive with the UseDatabaseReplicationSchedule parameter. |
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. |
StorageQuota |
Optional |
Microsoft.Exchange.Data.Unlimited |
The StorageQuota parameter specifies the size (in KB) when the public folder will start issuing warnings. This parameter is mutually exclusive with the UseDatabaseQuotaDefaults parameter. |
UseDatabaseAgeDefaults |
Optional |
System.Boolean |
The UseDatabaseAgeDefaults parameter specifies to use the database age limit. |
UseDatabaseQuotaDefaults |
Optional |
System.Boolean |
The UseDatabaseQuotaDefaults parameter specifies to use the public store quota limits. |
UseDatabaseReplicationSchedule |
Optional |
System.Boolean |
The UseDatabaseReplicationSchedule parameter specifies the public folder replication schedule. |
UseDatabaseRetentionDefaults |
Optional |
System.Boolean |
The UseDatabaseRetentionDefaults parameter specifies to use the database retention defaults. |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
Exceptions
| Exceptions | Description |
|---|---|
|
Example
In the first example, the Set-PublicFolder command is used to change a public folder so that it does not use the database default replication schedule.
In the second example, the Set-PublicFolder command is used to set the replication schedule to Always.
In the third example, the Set-PublicFolder command is used to set the folder to replicate only on weekends.
Set-PublicFolder "\Customer Service Requests" -UseDatabaseReplicationSchedule $false
Set-PublicFolder "\Customer Service Requests" -ReplicationSchedule Always
Set-PublicFolder \MyPublicFolder -ReplicationSchedule "Saturday.12:00 AM-Monday.12:00 AM"
All Set-PublicFolder command parameters can accept pipelined input for their argument and strong type.