Set-PublicFolder
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
Use the Set-PublicFolder cmdlet to set the attributes of public folders.
Syntax
Set-PublicFolder -Identity <PublicFolderIdParameter> [-AgeLimit <EnhancedTimeSpan>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-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>] [-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>]]
Set-PublicFolder [-AgeLimit <EnhancedTimeSpan>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-HiddenFromAddressListsEnabled <$true | $false>] [-Instance <PublicFolder>] [-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>]]
Detailed Description
To run the Set-PublicFolder cmdlet, the account you use must be delegated the following:
- Exchange Public Folder Administrator role, and local Administrators group for the target server
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. Replicas of this public folder will be 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 parameter 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 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 lets you 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. |
IssueWarningQuota |
Optional |
Microsoft.Exchange.Data.Unlimited |
The IssueWarningQuota parameter specifies the public folder size that will trigger a warning to public folder owners stating that the folder is almost full. |
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. To remove the age limit, set the value of the parameter to "$null". |
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. |
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 cannot post to a folder whose size is larger than the ProhibitPostQuota parameter value. |
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. |
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. |
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
The WhatIf parameter instructs the command to simulate the actions that it would take on the object. By using the WhatIf parameter, 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 parameter. |
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.
When you set the UseDatabaseQuotaDefaults parameter to true, the following values are reset to their default values:
MaxItemSize
IssueWarningQuota
ProhibitPostQuota
You cannot use the Set-PublicFolder cmdlet to change any of the following values when the UseDatabaseQuotaDefaults parameter is true:
MaxItemSize
IssueWarningQuota
ProhibitPostQuota
This is because these values are not applicable when you use the default database quotas.
In Exchange Server 2007 Service Pack 3 (SP3), the IssueWarningQuota value must be less than or equal to the ProhibitPostQuota value. Also, the MaxItemSize value must be less than or equal to the ProhibitPostQuota value.