TechNet
Export (0) Print
Expand All

Set-MailboxCalendarConfiguration

 

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-MailboxCalendarConfiguration cmdlet to modify mailbox calendar settings for Outlook on the web. This affects how the user's calendar looks and how reminders work in Outlook on the web. This also affects settings that define how meeting invitations, responses, and notifications are sent to the user.

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

Set-MailboxCalendarConfiguration -Identity <MailboxIdParameter> [-AgendaMailEnabled <$true | $false>] [-CalendarFeedsPreferredLanguage <String>] [-CalendarFeedsPreferredRegion <String>] [-CalendarFeedsRootPageId <String>] [-Confirm [<SwitchParameter>]] [-CreateEventsFromEmailAsPrivate <$true | $false>] [-DefaultReminderTime <TimeSpan>] [-DiningEventsFromEmailEnabled <$true | $false>] [-DomainController <Fqdn>] [-EntertainmentEventsFromEmailEnabled <$true | $false>] [-EventsFromEmailEnabled <$true | $false>] [-FirstWeekOfYear <LegacyNotSet | FirstDay | FirstFourDayWeek | FirstFullWeek>] [-FlightEventsFromEmailEnabled <$true | $false>] [-HotelEventsFromEmailEnabled <$true | $false>] [-PackageDeliveryEventsFromEmailEnabled <$true | $false>] [-RemindersEnabled <$true | $false>] [-ReminderSoundEnabled <$true | $false>] [-RentalCarEventsFromEmailEnabled <$true | $false>] [-ShowWeekNumbers <$true | $false>] [-SkipAgendaMailOnFreeDays <$true | $false>] [-TimeIncrement <FifteenMinutes | ThirtyMinutes>] [-UseBrightCalendarColorThemeInOwa <$true | $false>] [-WeatherEnabled <FirstRun | Disabled | Enabled>] [-WeatherLocationBookmark <Int32>] [-WeatherLocations <MultiValuedProperty>] [-WeatherUnit <Default | Celsius | Fahrenheit>] [-WeekStartDay <Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday>] [-WhatIf [<SwitchParameter>]] [-WorkDays <None | Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Weekdays | WeekendDays | AllDays>] [-WorkingHoursEndTime <TimeSpan>] [-WorkingHoursStartTime <TimeSpan>] [-WorkingHoursTimeZone <ExTimeZoneValue>]

This example disables the calendar reminders for the calendar of the user peter@contoso.com.

Set-MailboxCalendarConfiguration -Identity peter@contoso.com -RemindersEnabled $false

This example sets the time zone of the work hours' start and end times to Pacific Standard Time for the calendar of the user peter@contoso.com.

Set-MailboxCalendarConfiguration -Identity peter@contoso.com -WorkingHoursTimeZone "Pacific Standard Time"

This example sets the working day's starting hour to 7 A.M. for the calendar of the user Tony.

Set-MailboxCalendarConfiguration -Identity Tony -WorkingHoursStartTime 07:00:00

The Set-MailboxCalendarConfiguration cmdlet primarily allows users to manage their own calendar settings in Outlook on the web Options. However, administrators who have the Organization Management or Recipient Management management roles may configure the calendar settings for users by using this cmdlet.

You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox.

For example:

  • Name

  • Display name

  • Alias

  • Distinguished name (DN)

  • Canonical DN

  • <domain name>\<account name>

  • Email address

  • GUID

  • LegacyExchangeDN

  • SamAccountName

  • User ID or user principal name (UPN)

AgendaMailEnabled

Optional

System.Boolean

PARAMVALUE: $true | $false

CalendarFeedsPreferredLanguage

Optional

System.String

PARAMVALUE: String

CalendarFeedsPreferredRegion

Optional

System.String

PARAMVALUE: String

CalendarFeedsRootPageId

Optional

System.String

PARAMVALUE: String

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.

CreateEventsFromEmailAsPrivate

Optional

System.Boolean

PARAMVALUE: $true | $false

DefaultReminderTime

Optional

System.TimeSpan

The DefaultReminderTime parameter specifies the length of time before a meeting or appointment when the reminder is first displayed.

To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds.

Note that the value can't contain seconds. Valid values are:

  • 00:00:00

  • 00:05:00   5 minutes

  • 00:10:00   10 minutes

  • 00:15:00   15 minutes. This is the default value.

  • 00:30:00   30 minutes

  • 01:00:00   1 hour

  • 02:00:00   2 hours

  • 03:00:00   3 hours

  • 04:00:00   4 hours

  • 08:00:00   8 hours

  • 12:00:00   12 hours

  • 1.00:00:00   1 day

  • 2.00:00:00   2 days

  • 3.00:00:00   3 days

  • 7.00:00:00   7 days

  • 14.00:00:00   14 days

This parameter is ignored when the RemindersEnabled parameter is set to $false.

DiningEventsFromEmailEnabled

Optional

System.Boolean

PARAMVALUE: $true | $false

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.

EntertainmentEventsFromEmailEnabled

Optional

System.Boolean

PARAMVALUE: $true | $false

EventsFromEmailEnabled

Optional

System.Boolean

PARAMVALUE: $true | $false

FirstWeekOfYear

Optional

Microsoft.Exchange.Data.Storage.Management.FirstWeekRules

The FirstWeekOfYear parameter specifies the first week of the year. Valid values are:

  • FirstDay   Week numbers start on the first day of the year. This is the default value.

  • FirstFourDayWeek   Week numbers start on the first week that has at least four days.

  • FirstFullWeek   Week numbers start on the first week that has seven days.

  • LegacyNotSet   You can't set this value. This is a null value that appears only when the mailbox has been moved from an earlier version of Exchange.

You configure the first day of the week by using the WeekStartDay parameter.

FlightEventsFromEmailEnabled

Optional

System.Boolean

PARAMVALUE: $true | $false

HotelEventsFromEmailEnabled

Optional

System.Boolean

PARAMVALUE: $true | $false

PackageDeliveryEventsFromEmailEnabled

Optional

System.Boolean

PARAMVALUE: $true | $false

RemindersEnabled

Optional

System.Boolean

The RemindersEnabled parameter enables or disables reminders for calendar items. Valid values are:

  • $true   Reminders are enabled. This is the default value.

  • $false   Reminders are disabled.

When the reminder is first displayed is controlled by the DefaultReminderTime parameter.

ReminderSoundEnabled

Optional

System.Boolean

The ReminderSoundEnabled parameter specifies whether a sound is played along with the reminder. Valid values are:

  • $true   A sound is played with the reminder. This is the default value.

  • $false   No sound is played with the reminder.

This parameter is ignored when the RemindersEnabled parameter is set to $false.

RentalCarEventsFromEmailEnabled

Optional

System.Boolean

PARAMVALUE: $true | $false

ShowWeekNumbers

Optional

System.Boolean

The ShowWeekNumbers parameter specifies whether the week number is displayed in the Outlook on the web calendar. Valid values are:

  • $true   The week number is displayed.

  • $false   The week number isn't displayed. This is the default value.

SkipAgendaMailOnFreeDays

Optional

System.Boolean

PARAMVALUE: $true | $false

TimeIncrement

Optional

Microsoft.Exchange.Data.Storage.Management.HourIncrement

The TimeIncrement parameter specifies the scale that the Outlook on the web calendar uses to show time. Valid values are:

  • FifteenMinutes

  • ThirtyMinutes   This is the default value.

UseBrightCalendarColorThemeInOwa

Optional

System.Boolean

The UseBrightCalendarColorThemeInOwa parameter specifies whether to use light colors or bright colors for the calendar in Outlook on the web. Valid values are:

  • $true   Use bright colors in the calendar.

  • $false   Use light colors in the calendar. This is the default value.

WeatherEnabled

Optional

Microsoft.Exchange.Data.Storage.Management.WeatherEnabledStatus

This parameter is available only in the cloud-based service.

The WeatherEnabled specifies whether weather is displayed in the calendar in Outlook on the web. Valid values are:

  • FirstRun   This is the default value.

  • Disabled   Hide weather on the calendar.

  • Enabled   Show weather on the calendar.

WeatherLocationBookmark

Optional

System.Int32

This parameter is available only in the cloud-based service.

The WeatherLocationBookmark parameter specifies the default weather information that's displayed in the calendar in Outlook on the web. This parameter is based on an index value of the configured weather locations. The first weather location has the index value 0, the second weather location has the index value 1, and so on.

A valid value for this parameter depends on the number of weather locations that are configured for the mailbox. For example, if there are 3 weather locations configured, you can specify the value 0, 1, or 2 for this parameter.

WeatherLocations

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter is available only in the cloud-based service.

The WeatherLocations parameter specifies one or more locations to display the weather for in the calendar in Outlook on the web.

This parameter uses the syntax: LocationId:<LocationID>;Name:<Name>;Latitude:<Latitude>;Longitude:<Longitude>. For example, LocationId:105808079;Name:Redmond, WA;Latitude:47.679;Longitude:-122.132.

To enter multiple values and overwrite any existing entries, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "<value1>","<value2>"....

To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="<value1>","<value2>"...; Remove="<value1>","<value2>"...}.

For this parameter, "<value1>" is "LocationId:<LocationID1>;Name:<Name1>;Latitude:<Latitude1>;Longitude:<Longitude1>", and "<value2>" is "LocationId:<LocationID2>;Name:<Name2>;Latitude:<Latitude2>;Longitude:<Longitude2>"

You can configure a maximum of 5 weather locations.

WeatherUnit

Optional

Microsoft.Exchange.Data.Storage.Management.WeatherTemperatureUnit

This parameter is available only in the cloud-based service.

The WeatherUnit parameter specifies the temperature scale that's used to display the weather in the calendar in Outlook on the web. Valid values are:

  • Default   This is the default value.

  • Celsius

  • Fahrenheit

WeekStartDay

Optional

Microsoft.Exchange.Data.Storage.Management.DayOfWeek

The WeekStartDay parameter specifies the first day of the week. Valid values are:

  • Sunday   This is the default value.

  • Monday

  • Tuesday

  • Wednesday

  • Thursday

  • Friday

  • Saturday

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.

WorkDays

Optional

Microsoft.Exchange.Data.DaysOfWeek

The WorkDays parameter specifies the work days in the calendar. Valid values are:

  • None

  • AllDays

  • Weekdays   This is the default value.

  • WeekEndDays

  • Sunday

  • Monday

  • Tuesday

  • Wednesday

  • Thursday

  • Friday

  • Saturday

You can specify multiple values separated by commas, but redundant values are ignored. For example, entering Weekdays,Monday results in the value Weekdays.

WorkingHoursEndTime

Optional

System.TimeSpan

The WorkingHoursEndTime parameter specifies the time that the work day ends.

To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds.

The default value is 17:00:00 (5:00 P.M.).

WorkingHoursStartTime

Optional

System.TimeSpan

The WorkingHoursStartTime parameter specifies the time that the work day starts.

To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds.

The default value is 08:00:00(8:00 A.M.).

WorkingHoursTimeZone

Optional

Microsoft.Exchange.Data.Storage.Management.ExTimeZoneValue

The WorkingHoursTimeZone parameter specifies the time zone that's used by the WorkingHoursStartTime and WorkingHoursEndTime parameters.

A valid value for this parameter is a supported time zone key name (for example, "Pacific Standard Time").

To see the available values, run the following command: $TimeZone = Get-ChildItem "HKLM:\Software\Microsoft\Windows NT\CurrentVersion\Time zones" | foreach {Get-ItemProperty $_.PSPath}; $TimeZone | sort Display | Format-Table -Auto PSChildname,Display

If the value contains spaces, enclose the value in quotation marks ("). The default value is the time zone setting of the Exchange server.

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:
© 2016 Microsoft