Get-ExMailboxProtocol

SYNOPSIS

Retrieves mailbox protocol settings for Exchange Online mailboxes.

SYNTAX

Get-ExMailboxProtocol [[-Identity] <string>] [-ByDomain <string>] [-ExportToExcel]
 [-ExportPath <string>]

DESCRIPTION

This function retrieves the protocol settings (MAPI, OWA, IMAP, POP, EWS, ActiveSync) for Exchange Online mailboxes. It can filter mailboxes by identity or by domain. Additionally, it provides information about SMTP Client Authentication settings at both the mailbox and tenant levels.

EXAMPLES

EXAMPLE 1

Get-ExMailboxProtocol

Retrieves mailbox protocol settings for all Exchange Online mailboxes.

EXAMPLE 2

Get-ExMailboxProtocol -Identity "user@example.com"

Retrieves mailbox protocol settings for the specified mailbox.

EXAMPLE 3

Get-ExMailboxProtocol -ByDomain "example.com"

Retrieves mailbox protocol settings for all mailboxes in the specified domain.

EXAMPLE 4

Get-ExMailboxProtocol -ExportToExcel

Exports mailbox protocol settings for all Exchange Online mailboxes to an Excel file in the user’s profile directory.

PARAMETERS

-ByDomain

The domain to filter mailboxes by. Only mailboxes with a primary SMTP address in this domain will be processed.

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

-ExportPath

Optional output directory for the Excel export (defaults to the user profile).

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

-ExportToExcel

If specified, exports the results to an Excel file in the user’s profile directory.

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 to retrieve protocol settings for. If not specified, the function retrieves settings for all mailboxes.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: false
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: true
  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.

Getting started

Azure

Entra

Exchange

Intune

M365 Apps

Misc

MS Commerce

Share Point

Unified Logs

Get-ExMailboxProtocol

SYNOPSIS

SYNTAX

DESCRIPTION

EXAMPLES

EXAMPLE 1

EXAMPLE 2

EXAMPLE 3

EXAMPLE 4

PARAMETERS

-ByDomain

-ExportPath

-ExportToExcel

-Identity

CommonParameters

INPUTS

System.String

OUTPUTS

NOTES

​SYNOPSIS

​SYNTAX

​DESCRIPTION

​EXAMPLES

​EXAMPLE 1

​EXAMPLE 2

​EXAMPLE 3

​EXAMPLE 4

​PARAMETERS

​-ByDomain

​-ExportPath

​-ExportToExcel

​-Identity

​CommonParameters

​INPUTS

​System.String

​OUTPUTS

​NOTES

​RELATED LINKS

SYNOPSIS

SYNTAX

DESCRIPTION

EXAMPLES

EXAMPLE 1

EXAMPLE 2

EXAMPLE 3

EXAMPLE 4

PARAMETERS

-ByDomain

-ExportPath

-ExportToExcel

-Identity

CommonParameters

INPUTS

System.String

OUTPUTS

NOTES

RELATED LINKS