Skip to main content

​
SYNOPSIS

Retrieves all Exchange mailboxes for a specified domain.

​
SYNTAX

Get-ExMailboxByDomain [-Domain] <String> [-RecipientTypeDetails <String>] [-ExportToExcel]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

​
DESCRIPTION

This function retrieves all Exchange mailboxes that belong to a specified domain. It filters the mailboxes based on their primarySMTP address to ensure they match the provided domain.

​
EXAMPLES

​
EXAMPLE 1

Get-ExMailboxByDomain -Domain "example.com"
Returns all Exchange mailboxes associated with the domain “example.com”.

​
PARAMETERS

​
-Domain

The domain for which to retrieve the mailboxes. This should be a string representing the domain (e.g., “example.com”). 
Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

​
-RecipientTypeDetails

Filters the mailboxes by their recipient type details. Acceptable values include:
  • UserMailbox
  • SharedMailbox
  • RoomMailbox
  • EquipmentMailbox
  • LinkedMailbox
  • SchedulingMailbox
Type: String
Parameter Sets: (All)
Aliases:

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

​
-ExportToExcel

If specified, exports the retrieved mailbox information to an Excel file in the user’s profile directory. 
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

​
CommonParameters

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

​
INPUTS

​
OUTPUTS

​
NOTES

https://ps365.clidsys.com/docs/commands/Get-ExMailboxByDomain