Export-M365Mailboxes

SYNOPSIS

Exports all mailboxes from a Microsoft 365 tenant.

SYNTAX

Action

Export-M365Mailboxes -ConfigNode <String> [-Format <String>] [<CommonParameters>]

Help

Export-M365Mailboxes [-ShowPrereqs] [<CommonParameters>]

DESCRIPTION

Use the Export-M365Mailboxes cmdlet to export all mailboxes from a Microsoft 365 tenant.

Note that the export includes all mailboxes. If you only want shared mailboxes, use Export-M365SharedMailboxes instead.

EXAMPLES

Example 1

Description

This example exports all mailboxes from a Microsoft 365 tenant. The exported data is formatted as CSV and saved to the file mailboxes.csv.

Tenant configuration

Tenant	Direction	APIs	Scopes
Microsoft 365	Source	Microsoft Graph	Directory.Read.All

TMCTools

@{
  Source = @{
    M365ClientId     = '11111111-2222-3333-4444-555555555555'
    M365ClientSecret = 'abcDeFghij1lMn23OpQrStUVwx4YzAbCD5EfghIJkLM='
    M365Tenant       = 'source.org'
  }
}

Export-M365Mailboxes -ConfigNode Source -Format Csv >'mailboxes.csv'

PARAMETERS

-ConfigNode

The TMCTools.psd1 configuration node to use.

Type: String
Parameter Sets: Action
Aliases:
Accepted values: Source, Target

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

-Format

The output type for exported data.

Note that extended properties cannot be serialized into CSV format. When using -Format Csv, extended properties will display as System.Collections.Hashtable in the output.

Type: String
Parameter Sets: Action
Aliases:
Accepted values: Csv, Json, Objects

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

-ShowPrereqs

Prints the cmdlet prerequisites.

Type: SwitchParameter
Parameter Sets: Help
Aliases:

Required: True
Position: Named
Default value: None
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

None

OUTPUTS

System.Object[]

NOTES

This cmdlet requires the ExchangeOnlineManagement PowerShell module. Install it by running Install-Module ExchangeOnlineManagement -Scope CurrentUser.
Additional TMCTools.psd1 configurations may be required for some environments.
- Use M365CloudEnvironment to configure the cloud environment for token exchange. Available options are Worldwide (default), Germany, and USGovernment.

TMCTools configuration options