Set-ExMailboxRegionalConfiguration

SYNOPSIS

Sets the regional configuration for Exchange mailboxes, including language, time zone, date format, and time format.

SYNTAX

Identity

Set-ExMailboxRegionalConfiguration [-Identity] <string[]> [-Language <string>] [-TimeZone <string>]
 [-DateFormat <string>] [-TimeFormat <string>] [-OnlyIfLanguageEmpty] [-GenerateCmdlets]
 [-OutputFile <string>] [-WhatIf] [-Confirm]

ByDomain

Set-ExMailboxRegionalConfiguration -ByDomain <string> [-Language <string>] [-TimeZone <string>]
 [-DateFormat <string>] [-TimeFormat <string>] [-OnlyIfLanguageEmpty] [-GenerateCmdlets]
 [-OutputFile <string>] [-WhatIf] [-Confirm]

FromCSV

Set-ExMailboxRegionalConfiguration -FromCSV <string> [-DateFormat <string>] [-TimeFormat <string>]
 [-OnlyIfLanguageEmpty] [-GenerateCmdlets] [-OutputFile <string>] [-WhatIf] [-Confirm]

AllMailboxes

Set-ExMailboxRegionalConfiguration -AllMailboxes [-Language <string>] [-TimeZone <string>]
 [-DateFormat <string>] [-TimeFormat <string>] [-OnlyIfLanguageEmpty] [-GenerateCmdlets]
 [-OutputFile <string>] [-WhatIf] [-Confirm]

DESCRIPTION

This function sets the regional configuration settings (language, time zone, date format, time format) for Exchange Online mailboxes. It can target mailboxes by identity, by domain, from a CSV file, or all mailboxes in the organization. It also supports generating the corresponding Set-MailboxRegionalConfiguration cmdlets without executing them.

EXAMPLES

EXAMPLE 1

Set-ExMailboxRegionalConfiguration -Identity "user@example.com" -Language "en-US" -TimeZone "+1" -DateFormat "MM/dd/yyyy" -TimeFormat "HH:mm" -GenerateCmdlets -OutputFile "C:\temp\cmdlets.txt"

Generates the Set-MailboxRegionalConfiguration cmdlet for the specified mailbox with the given regional settings and saves it to the specified file without executing it.

EXAMPLE 2

Set-ExMailboxRegionalConfiguration -ByDomain "example.com" -Language "fr-FR" -TimeZone "Romance Standard Time"

Sets the regional configuration for all mailboxes in the specified domain to French language and Romance Standard Time zone.

EXAMPLE 3

Set-ExMailboxRegionalConfiguration -FromCSV "C:\path\to\file.csv" -GenerateCmdlets -OutputFile "C:\temp\cmdlets.txt"

Generates the Set-MailboxRegionalConfiguration cmdlets for mailboxes listed in the specified CSV file and saves them to the specified file without executing them.

EXAMPLE 4

Set-ExMailboxRegionalConfiguration -ByDomain "example.com" -Language "en-US" -TimeZone "+1" -OnlyIfLanguageEmpty

Sets the regional configuration only for mailboxes in the specified domain that currently have no language configured.

PARAMETERS

-AllMailboxes

If specified, all mailboxes in the organization will be processed.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: AllMailboxes
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-ByDomain

Filter mailboxes by domain name. All mailboxes with a primary SMTP address in this domain will be processed.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: ByDomain
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases:
- cf
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-DateFormat

The date format to set for the mailbox regional configuration (e.g., ‘MM/dd/yyyy’, ‘dd/MM/yyyy’). Auto-detected based on the specified language if not provided.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: AllMailboxes
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: ByDomain
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: Identity
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-FromCSV

The path to a CSV file containing mailbox identities and optional regional configuration settings to process.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: FromCSV
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-GenerateCmdlets

If specified, the function will generate the cmdlets and save them to a file instead of executing them.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Identity

The identity of the mailbox(es) to set the regional configuration for. This can be an array of email addresses, usernames, or display names.

Type: System.String[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Identity
  Position: 0
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Language

The language code to set for the mailbox regional configuration (e.g., ‘en-US’, ‘fr-FR’). See the ValidateSet in the parameter definition for supported language codes.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: AllMailboxes
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: ByDomain
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: Identity
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-OnlyIfLanguageEmpty

If specified, the function will only modify mailboxes that currently have no language configured (empty Language property). Useful to avoid overwriting existing configurations set by users or administrators.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-OutputFile

The path to the output file where generated cmdlets will be saved. Default is a timestamped file in the current directory.

Type: System.String
DefaultValue: "\"$(Get-Date -Format 'yyyy-MM-dd_HHmmss')-SetMailboxRegionalConfig_Commands.txt\""
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-TimeFormat

The time format to set for the mailbox regional configuration (e.g., ‘HH:mm’, ‘hh:mm tt’). Auto-detected based on the specified language if not provided.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: AllMailboxes
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: ByDomain
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: Identity
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-TimeZone

The time zone to set for the mailbox regional configuration. This can be a time zone ID (e.g., ‘Pacific Standard Time’) or a simplified offset format (e.g., ‘+1’, ‘-5’). See the ValidateSet in the parameter definition for supported offset values.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: AllMailboxes
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: ByDomain
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: Identity
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-WhatIf

Runs the command in a mode that only reports what would happen without performing the actions.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases:
- wi
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

​SYNOPSIS

​SYNTAX

​Identity

​ByDomain

​FromCSV

​AllMailboxes

​DESCRIPTION

​EXAMPLES

​EXAMPLE 1

​EXAMPLE 2

​EXAMPLE 3

​EXAMPLE 4

​PARAMETERS

​-AllMailboxes

​-ByDomain

​-Confirm

​-DateFormat

​-FromCSV

​-GenerateCmdlets

​-Identity

​-Language

​-OnlyIfLanguageEmpty

​-OutputFile

​-TimeFormat

​-TimeZone

​-WhatIf

​CommonParameters

​INPUTS

​System.String[]

​OUTPUTS

​NOTES

​RELATED LINKS