Applies to: Exchange Server 2013, Exchange Online

Topic Last Modified: 2012-09-18

Use the Set-MailboxCalendarFolder cmdlet to configure publishing or sharing settings on a calendar folder of a specified mailbox.

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

Syntax

Set-MailboxCalendarFolder -Identity <MailboxFolderIdParameter> [-Confirm [<SwitchParameter>]] [-DetailLevel <AvailabilityOnly | LimitedDetails | FullDetails>] [-DomainController <Fqdn>] [-PublishDateRangeFrom <OneDay | ThreeDays | OneWeek | OneMonth | ThreeMonths | SixMonths | OneYear>] [-PublishDateRangeTo <OneDay | ThreeDays | OneWeek | OneMonth | ThreeMonths | SixMonths | OneYear>] [-PublishEnabled <$true | $false>] [-ResetUrl <SwitchParameter>] [-SearchableUrlEnabled <$true | $false>] [-WhatIf [<SwitchParameter>]]

Examples

EXAMPLE 1

This example sets the level of details to publish for Kai's shared calendar to LimitedDetails, which means limited details are displayed.

Copy Code
Set-MailboxCalendarFolder -Identity kai:\Calendar -DetailLevel LimitedDetails

EXAMPLE 2

This example enables the calendar in Kai's mailbox to be searchable on the web.

Copy Code
Set-MailboxCalendarFolder -Identity kai:\Calendar -SearchableUrlEnabled $true

Detailed Description

The Set-MailboxCalendarFolder cmdlet configures publishing information. The calendar folder can be configured as follows:

  • Whether the calendar folder is enabled for publishing

  • Range of start and end calendar days to publish

  • Level of detail to publish for the calendar

  • Whether the published URL of the calendar is enabled for search on the web

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 "Calendar configuration" entry in the Recipients Permissions topic.

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.MailboxFolderIdParameter

The Identity parameter specifies the mailbox and folder path or folder name to the calendar folder that has the publishing settings configured. You can use the following values:

  • GUID

  • ADObjectID

  • Distinguished name (DN)

  • Domain\Account

  • User principal name (UPN)

  • LegacyExchangeDN

  • SmtpAddress

  • Alias

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.

DetailLevel

Optional

Microsoft.Exchange.Data.Storage.DetailLevelEnumType

The DetailLevel parameter specifies the level of calendar detail that's published and available to anonymous users. You can use the following values:

  • AvailabilityOnly

  • LimitedDetails

  • FullDetails

The default value is AvailabilityOnly.

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.

PublishDateRangeFrom

Optional

Microsoft.Exchange.Data.Storage.Management.DateRangeEnumType

The PublishDateRangeFrom parameter specifies the number of days of calendar information to publish before the current date. You can use the following values:

  • OneDay

  • ThreeDays

  • OneWeek

  • OneMonth

  • ThreeMonths

  • SixMonths

  • OneYear

The default value is ThreeMonths.

PublishDateRangeTo

Optional

Microsoft.Exchange.Data.Storage.Management.DateRangeEnumType

The PublishDateRangeTo parameter specifies the number of days of calendar information to publish after the current date. You can use the following values:

  • OneDay

  • ThreeDays

  • OneWeek

  • OneMonth

  • ThreeMonths

  • SixMonths

  • OneYear

The default value is ThreeMonths.

PublishEnabled

Optional

System.Boolean

The PublishEnabled parameter specifies whether the specified calendar should be enabled for publishing. The default value is $true.

ResetUrl

Optional

System.Management.Automation.SwitchParameter

The ResetUrl parameter replaces the existing non-public URL with a new URL for a calendar that has been published without being publicly searchable.

SearchableUrlEnabled

Optional

System.Boolean

The SearchableUrlEnabled parameter specifies whether the published calendar URL can be searched on the web. The default value is $false.

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.