Set-MailboxCalendarFolder

 

Applies to: Exchange Online, Exchange Server 2016

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

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 Exchange cmdlet syntax.

Set-MailboxCalendarFolder -Identity <MailboxFolderIdParameter> [-Confirm [<SwitchParameter>]] [-DetailLevel <AvailabilityOnly | LimitedDetails | FullDetails | Editor>] [-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>]]

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

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

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

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

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.

 

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 specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

  • Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.

  • Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

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

  • Editor

The default value is AvailabilityOnly.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

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

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

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 simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this 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.

 
Show: