< Back

Get-MgaMailboxSetting

Sat Jan 18, 2020 4:40 pm

NAME Get-MgaMailboxSetting



SYNOPSIS

Get the mailbox settings from Exchange Online using the graph api.





SYNTAX

Get-MgaMailboxSetting [-User <String>] [-Token <AzureAccessToken>] [<CommonParameters>]



Get-MgaMailboxSetting [-AutomaticReplySetting] [-User <String>] [-Token <AzureAccessToken>] [<CommonParameters>]



Get-MgaMailboxSetting [-LanguageSetting] [-User <String>] [-Token <AzureAccessToken>] [<CommonParameters>]



Get-MgaMailboxSetting [-TimeZoneSetting] [-User <String>] [-Token <AzureAccessToken>] [<CommonParameters>]



Get-MgaMailboxSetting [-WorkingHoursSetting] [-User <String>] [-Token <AzureAccessToken>] [<CommonParameters>]



Get-MgaMailboxSetting [-ArchiveFolderSetting] [-User <String>] [-Token <AzureAccessToken>] [<CommonParameters>]





DESCRIPTION

Get the mailbox settings from Exchange Online using the graph api.

This includes settings for automatic replies (notify people automatically

upon receipt of their email), locale (language and country/region),

and time zone, and working hours.



You can view all mailbox settings, or get specific settings by

specifing switch parameters.





PARAMETERS

-AutomaticReplySetting [<SwitchParameter>]

If specified, only the settings for automatic notifications to

senders of an incoming email are outputted.



Fun fact:

Here's an interesting historical question - when we say Out of Office,

why does it sometimes get shortened to ???????OOF????????? Shouldn????????t it be ???????OOO?????????

https://blogs.technet.microsoft.com/exc ... ot-an-ooo/



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-LanguageSetting [<SwitchParameter>]

If specified, only the information about the locale, including the

preferred language and country/region are displayed.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-TimeZoneSetting [<SwitchParameter>]

If specified, only the timezone settings from the users mailbox are displayed.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-WorkingHoursSetting [<SwitchParameter>]

If specified, only the settings for the days of the week and hours in a

specific time zone that the user works are displayed.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-ArchiveFolderSetting [<SwitchParameter>]

If specified, only the archive folder settings from the users mailbox are displayed.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-User <String>

The user-account to access. Defaults to the main user connected as.

Can be any primary email name of any user the connected token has access to.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Token <AzureAccessToken>

The token representing an established connection to the Microsoft Graph Api.

Can be created by using New-MgaAccessToken.

Can be omitted if a connection has been registered using the -Register parameter on New-MgaAccessToken.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



NOTES





For addiontional information about Microsoft Graph API go to:

https://docs.microsoft.com/en-us/graph/ ... h-rest-1.0



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Get-MgaMailboxSetting



Return all mailbox settings for the user connected to through the registered token.









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Get-MgaMailboxSetting -AutomaticReplySetting



Return only the settings for automatic notifications to senders of an incoming email

for the user connected to through the registered token.









-------------------------- EXAMPLE 3 --------------------------



PS C:\\>Get-MgaMailboxSetting -LanguageSetting



Return only the information about the locale, including the preferred language and

country/region, for the user connected to through the registered token.









-------------------------- EXAMPLE 4 --------------------------



PS C:\\>Get-MgaMailboxSetting -TimeZoneSetting



Return only the timezone settings for the user connected to through the registered token.









-------------------------- EXAMPLE 5 --------------------------



PS C:\\>Get-MgaMailboxSetting -WorkingHoursSetting



Return only the settings for the days of the week and hours in a specific time zone

the user connected to through the registered token works.









-------------------------- EXAMPLE 6 --------------------------



PS C:\\>Get-MgaMailboxSetting -ArchiveFolderSetting



Return only the settings for the folder where mails are archived in the user

connected to through the registered token works.











RELATED LINKS