Get-VEXFolder

Short Description

Returns folders added to Microsoft Exchange mailboxes.

Applies to

Veeam Backup & Replication, Veeam Backup for Microsoft 365

Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

This cmdlet provides parameter sets that allow you to:

  • Get all root folders of the mailbox without their subfolders..

Get-VEXFolder [-Mailbox] <VEXMailbox> [[-Name] <String>] [-Recurse] [<CommonParameters>]

  • Get subfolders for the specified mailbox folder.

Get-VEXFolder [-Parent] <VEXFolder> [[-Name] <String>] [-Recurse] [<CommonParameters>]

Detailed Description

This cmdlet returns folders added to Microsoft Exchange mailboxes. The cmdlet will return mailbox folders on which the user has owner permissions.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Mailbox

Specifies a mailbox database. The cmdlet will return all mailboxes from this database.

Accepts the VEXMailbox object. To get this object, run the Get-VEXMailbox cmdlet.

True

0

True (ByValue)

Name

Specifies a name of the mailbox. The cmdlet will return the mailbox with this name.

String

False

1

False

Recurse

Defines that the cmdlet will return the specified parent folder and all of its subfolders.

Default: False

SwitchParameter

False

Named

False

Parent

Specifies a parent folder in the mailbox. The cmdlet will return subfolders of this parent folder.

Accepts the VEXFolder object.

True

0

True (ByValue)

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Output Object

The cmdlet returns the VEXFolder[] array that contains folders added to Microsoft Exchange mailboxes.

Examples

Get-VEXFolderExample 1. Getting Folders with Subfolders from Mailbox [For Veeam Backup & Replication]

Get-VEXFolderExample 2. Getting Subfolders of Specific Folder [For Veeam Backup & Replication]

Get-VEXFolderExample 3. Getting Folders with Subfolders from Mailbox [For Veeam Backup for Microsoft 365]

Get-VEXFolderExample 4. Getting Subfolders of Specific Folder [For Veeam Backup for Microsoft 365]

Related Commands

Page updated 3/6/2025

Page content applies to build 12.3.1.1139