Update-MgUserMailboxSetting

Update property mailboxSettings value.

Note

To view the beta release of this cmdlet, view Update-MgBetaUserMailboxSetting

Syntax

Update-MgUserMailboxSetting
      -UserId <String>
      [-ResponseHeadersVariable <String>]
      [-AdditionalProperties <Hashtable>]
      [-ArchiveFolder <String>]
      [-AutomaticRepliesSetting <IMicrosoftGraphAutomaticRepliesSetting>]
      [-DateFormat <String>]
      [-DelegateMeetingMessageDeliveryOptions <String>]
      [-Language <IMicrosoftGraphLocaleInfo>]
      [-TimeFormat <String>]
      [-TimeZone <String>]
      [-UserPurpose <String>]
      [-WorkingHours <IMicrosoftGraphWorkingHours>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-MgUserMailboxSetting
      -UserId <String>
      -BodyParameter <IMicrosoftGraphMailboxSettings>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-MgUserMailboxSetting
      -InputObject <IUsersIdentity>
      [-ResponseHeadersVariable <String>]
      [-AdditionalProperties <Hashtable>]
      [-ArchiveFolder <String>]
      [-AutomaticRepliesSetting <IMicrosoftGraphAutomaticRepliesSetting>]
      [-DateFormat <String>]
      [-DelegateMeetingMessageDeliveryOptions <String>]
      [-Language <IMicrosoftGraphLocaleInfo>]
      [-TimeFormat <String>]
      [-TimeZone <String>]
      [-UserPurpose <String>]
      [-WorkingHours <IMicrosoftGraphWorkingHours>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-MgUserMailboxSetting
      -InputObject <IUsersIdentity>
      -BodyParameter <IMicrosoftGraphMailboxSettings>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Update property mailboxSettings value.

Parameters

-AdditionalProperties

Additional Parameters

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ArchiveFolder

Folder ID of an archive folder for the user.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AutomaticRepliesSetting

automaticRepliesSetting To construct, see NOTES section for AUTOMATICREPLIESSETTING properties and create a hash table.

Type:IMicrosoftGraphAutomaticRepliesSetting
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-BodyParameter

mailboxSettings To construct, see NOTES section for BODYPARAMETER properties and create a hash table.

Type:IMicrosoftGraphMailboxSettings
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DateFormat

The date format for the user's mailbox.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DelegateMeetingMessageDeliveryOptions

delegateMeetingMessageDeliveryOptions

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Headers

Optional headers that will be added to the request.

Type:IDictionary
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:IUsersIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Language

localeInfo To construct, see NOTES section for LANGUAGE properties and create a hash table.

Type:IMicrosoftGraphLocaleInfo
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ProgressAction

{{ Fill ProgressAction Description }}

Type:ActionPreference
Aliases:proga
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResponseHeadersVariable

Optional Response Headers Variable.

Type:String
Aliases:RHV
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TimeFormat

The time format for the user's mailbox.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TimeZone

The default time zone for the user's mailbox.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UserId

The unique identifier of user

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-UserPurpose

userPurpose

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WorkingHours

workingHours To construct, see NOTES section for WORKINGHOURS properties and create a hash table.

Type:IMicrosoftGraphWorkingHours
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphMailboxSettings

Microsoft.Graph.PowerShell.Models.IUsersIdentity

System.Collections.IDictionary

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphMailboxSettings

Notes

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

AUTOMATICREPLIESSETTING <IMicrosoftGraphAutomaticRepliesSetting>: automaticRepliesSetting

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [ExternalAudience <String>]: externalAudienceScope
  • [ExternalReplyMessage <String>]: The automatic reply to send to the specified external audience, if Status is AlwaysEnabled or Scheduled.
  • [InternalReplyMessage <String>]: The automatic reply to send to the audience internal to the signed-in user's organization, if Status is AlwaysEnabled or Scheduled.
  • [ScheduledEndDateTime <IMicrosoftGraphDateTimeZone>]: dateTimeTimeZone
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [DateTime <String>]: A single point of time in a combined date and time representation ({date}T{time}; for example, 2017-08-29T04:00:00.0000000).
    • [TimeZone <String>]: Represents a time zone, for example, 'Pacific Standard Time'. See below for more possible values.
  • [ScheduledStartDateTime <IMicrosoftGraphDateTimeZone>]: dateTimeTimeZone
  • [Status <String>]: automaticRepliesStatus

BODYPARAMETER <IMicrosoftGraphMailboxSettings>: mailboxSettings

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [ArchiveFolder <String>]: Folder ID of an archive folder for the user.
  • [AutomaticRepliesSetting <IMicrosoftGraphAutomaticRepliesSetting>]: automaticRepliesSetting
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [ExternalAudience <String>]: externalAudienceScope
    • [ExternalReplyMessage <String>]: The automatic reply to send to the specified external audience, if Status is AlwaysEnabled or Scheduled.
    • [InternalReplyMessage <String>]: The automatic reply to send to the audience internal to the signed-in user's organization, if Status is AlwaysEnabled or Scheduled.
    • [ScheduledEndDateTime <IMicrosoftGraphDateTimeZone>]: dateTimeTimeZone
      • [(Any) <Object>]: This indicates any property can be added to this object.
      • [DateTime <String>]: A single point of time in a combined date and time representation ({date}T{time}; for example, 2017-08-29T04:00:00.0000000).
      • [TimeZone <String>]: Represents a time zone, for example, 'Pacific Standard Time'. See below for more possible values.
    • [ScheduledStartDateTime <IMicrosoftGraphDateTimeZone>]: dateTimeTimeZone
    • [Status <String>]: automaticRepliesStatus
  • [DateFormat <String>]: The date format for the user's mailbox.
  • [DelegateMeetingMessageDeliveryOptions <String>]: delegateMeetingMessageDeliveryOptions
  • [Language <IMicrosoftGraphLocaleInfo>]: localeInfo
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [DisplayName <String>]: A name representing the user's locale in natural language, for example, 'English (United States)'.
    • [Locale <String>]: A locale representation for the user, which includes the user's preferred language and country/region. For example, 'en-us'. The language component follows 2-letter codes as defined in ISO 639-1, and the country component follows 2-letter codes as defined in ISO 3166-1 alpha-2.
  • [TimeFormat <String>]: The time format for the user's mailbox.
  • [TimeZone <String>]: The default time zone for the user's mailbox.
  • [UserPurpose <String>]: userPurpose
  • [WorkingHours <IMicrosoftGraphWorkingHours>]: workingHours
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [DaysOfWeek <String- []>]: The days of the week on which the user works.
    • [EndTime <String>]: The time of the day that the user stops working.
    • [StartTime <String>]: The time of the day that the user starts working.
    • [TimeZone <IMicrosoftGraphTimeZoneBase>]: timeZoneBase
      • [(Any) <Object>]: This indicates any property can be added to this object.
      • [Name <String>]: The name of a time zone. It can be a standard time zone name such as 'Hawaii-Aleutian Standard Time', or 'Customized Time Zone' for a custom time zone.

INPUTOBJECT <IUsersIdentity>: Identity Parameter

  • [AttachmentBaseId <String>]: The unique identifier of attachmentBase
  • [AttachmentSessionId <String>]: The unique identifier of attachmentSession
  • [ChecklistItemId <String>]: The unique identifier of checklistItem
  • [DirectoryObjectId <String>]: The unique identifier of directoryObject
  • [ExtensionId <String>]: The unique identifier of extension
  • [LicenseDetailsId <String>]: The unique identifier of licenseDetails
  • [LinkedResourceId <String>]: The unique identifier of linkedResource
  • [OAuth2PermissionGrantId <String>]: The unique identifier of oAuth2PermissionGrant
  • [OutlookCategoryId <String>]: The unique identifier of outlookCategory
  • [ProfilePhotoId <String>]: The unique identifier of profilePhoto
  • [ServiceStorageQuotaBreakdownId <String>]: The unique identifier of serviceStorageQuotaBreakdown
  • [SharedInsightId <String>]: The unique identifier of sharedInsight
  • [TodoTaskId <String>]: The unique identifier of todoTask
  • [TodoTaskListId <String>]: The unique identifier of todoTaskList
  • [TrendingId <String>]: The unique identifier of trending
  • [UsedInsightId <String>]: The unique identifier of usedInsight
  • [UserId <String>]: The unique identifier of user
  • [WindowsSettingId <String>]: The unique identifier of windowsSetting
  • [WindowsSettingInstanceId <String>]: The unique identifier of windowsSettingInstance

LANGUAGE <IMicrosoftGraphLocaleInfo>: localeInfo

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [DisplayName <String>]: A name representing the user's locale in natural language, for example, 'English (United States)'.
  • [Locale <String>]: A locale representation for the user, which includes the user's preferred language and country/region. For example, 'en-us'. The language component follows 2-letter codes as defined in ISO 639-1, and the country component follows 2-letter codes as defined in ISO 3166-1 alpha-2.

WORKINGHOURS <IMicrosoftGraphWorkingHours>: workingHours

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [DaysOfWeek <String- []>]: The days of the week on which the user works.
  • [EndTime <String>]: The time of the day that the user stops working.
  • [StartTime <String>]: The time of the day that the user starts working.
  • [TimeZone <IMicrosoftGraphTimeZoneBase>]: timeZoneBase
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [Name <String>]: The name of a time zone. It can be a standard time zone name such as 'Hawaii-Aleutian Standard Time', or 'Customized Time Zone' for a custom time zone.