Applies to: Exchange Server 2013, Exchange Online
Topic Last Modified: 2013-01-17
Use the Set-MailboxCalendarConfiguration cmdlet to apply calendar settings for users using Microsoft Office Outlook Web App calendars. This affects how the user's calendar looks and how reminders work in Outlook Web App. 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 Syntax.
Syntax
Set-MailboxCalendarConfiguration -Identity
<MailboxIdParameter> [-Confirm [<SwitchParameter>]]
[-DefaultReminderTime <TimeSpan>] [-DomainController
<Fqdn>] [-FirstWeekOfYear <LegacyNotSet | FirstDay |
FirstFourDayWeek | FirstFullWeek>] [-RemindersEnabled <$true
| $false>] [-ReminderSoundEnabled <$true | $false>]
[-ShowWeekNumbers <$true | $false>] [-TimeIncrement
<FifteenMinutes | ThirtyMinutes>] [-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>]
|
Examples
EXAMPLE 1
This example disables the calendar reminders for the user Peter.
Copy Code | |
---|---|
Set-MailboxCalendarConfiguration -Identity Peter -RemindersEnabled $false |
EXAMPLE 2
This example sets the time zone of the work hours' start and end times to Pacific Standard Time for the user Peter.
Copy Code | |
---|---|
Set-MailboxCalendarConfiguration -Identity Peter -WorkingHoursTimeZone "Pacific Standard Time" |
EXAMPLE 3
This example sets the working day's starting hour in Tony's calendar to the specified time.
Copy Code | |
---|---|
Set-MailboxCalendarConfiguration -Identity tony -WorkingHoursStartTime 07:00:00 |
Detailed Description
The Set-MailboxCalendarConfiguration cmdlet was created primarily to allow users to manage their calendar settings. However, administrators who have the Organization Management or Recipient Management management roles may configure the calendar settings for users by using the Exchange Management Shell.
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.MailboxIdParameter |
The Identity parameter specifies the user account to be set. |
||
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. |
||
DefaultReminderTime |
Optional |
System.TimeSpan |
The DefaultReminderTime parameter specifies the length of time before each meeting or appointment that Outlook Web App should show the reminder. Values are expressed in "DD.HH:MM:SS" time span format within quotation marks, where DD refers to days, HH refers to hours, MM refers to minutes, and SS refers to seconds. Valid values are as follows: 00:00:00, 00:05:00, 00:10:00, 00:15:00, 00:30:00, 01:00:00, 02:00:00, 03:00:00, 04:00:00, 08:00:00, 12:00:00, 1.00:00:00, 2.00:00:00, 3.00:00:00, 7.00:00:00, 14.00:00:00 |
||
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. |
||
FirstWeekOfYear |
Optional |
Microsoft.Exchange.Data.Storage.Management.FirstWeekRules |
The FirstWeekOfYear parameter specifies when the first
week of the year will start when show week numbers has been turned
on in Outlook Web App by the user, or by using the Shell to set the
ShowWeekNumbers parameter to
|
||
RemindersEnabled |
Optional |
System.Boolean |
The RemindersEnabled parameter specifies whether Outlook
Web App provides a visual indicator when a calendar reminder is
due. Reminders are enabled by default ( |
||
ReminderSoundEnabled |
Optional |
System.Boolean |
The ReminderSoundEnabled parameter specifies whether a
sound is played when a reminder is due. The reminder sound is
enabled by default ( |
||
ShowWeekNumbers |
Optional |
System.Boolean |
The ShowWeekNumbers parameter specifies whether the date picker in the Outlook Web App calendar shows the week number. |
||
TimeIncrement |
Optional |
Microsoft.Exchange.Data.Storage.Management.HourIncrement |
The TimeIncrement parameter specifies the minutes in
which the Outlook Web App calendar shows time. For example,
|
||
WeekStartDay |
Optional |
Microsoft.Exchange.Data.Storage.Management.DayOfWeek |
The WeekStartDay parameter specifies the first day of the
work week. The valid values for this parameter are
|
||
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. |
||
WorkDays |
Optional |
Microsoft.Exchange.Data.DaysOfWeek |
The WorkDays parameter specifies the days that appear in the Outlook Web App calendar as work days. |
||
WorkingHoursEndTime |
Optional |
System.TimeSpan |
The WorkingHoursEndTime parameter specifies the time in hours, minutes, and seconds (hh:mm:ss) that the work day ends. For example, to state the time as 5:00 P.M., use 17:00:00. |
||
WorkingHoursStartTime |
Optional |
System.TimeSpan |
The WorkingHoursStartTime parameter specifies the time in hours, minutes, and seconds (hh:mm:ss) that the work day starts. For example, to state the time as 8:00 A.M., use 08:00:00. |
||
WorkingHoursTimeZone |
Optional |
Microsoft.Exchange.Data.Storage.Management.ExTimeZoneValue |
The WorkingHoursTimeZone parameter specifies the time zone used by the user's working hour start and end times. Two types of formats are supported as follows:
|
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.