Get-VEXItem

Short Description

Returns items added to Microsoft Exchange mailboxes.

Product: Veeam Backup & Replication, Veeam Backup for Microsoft 365

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

Syntax

This cmdlet provides the following parameter sets:

QueryByFolderParameterSet (Default)

Get-VEXItem -Folder <VEXFolder> [-Query <String>] [-Recurse] [<CommonParameters>]
QueryByDatabaseParameterSet

Get-VEXItem -Database <VEXDatabase[]> [-Query <String>] [<CommonParameters>]
QueryByMailboxParameterSet

Get-VEXItem -Mailbox <VEXMailbox> [-Query <String>] [<CommonParameters>]

Detailed Description

This cmdlet returns items added to Microsoft Exchange mailboxes. You can search the folder, mailbox or the entire mailbox database to get the necessary item.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Database	Specifies an array of mailbox databases. The cmdlet will return items from these databases. Accepts the `VEXDatabase[]` object. To get this object, run the `Get-VEXDatabase` cmdlet.	`VEXDatabase[]`	True	Named	True (ByValue)
Folder	Specifies a mailbox folder. The cmdlet will return items from this folder. Accepts the `VEXFolder` object. To get this object, run the `Get-VEXFolder` cmdlet.	`VEXFolder`	True	Named	True (ByValue)
Mailbox	Specifies a mailbox. The cmdlet will return items from this mailbox. Accepts the `VEXMailbox` object. To get this object, run the `Get-VEXMailbox` cmdlet.	`VEXMailbox`	True	Named	True (ByValue)
Query	Specifies a query string for mailbox item search. The cmdlet will return items that match the search query from the specified folder, database or mailbox. For more information, see the Appendix A. Item Search Parameters section of the Veeam Backup for Microsoft 365 User Guide.	`String`	False	Named	False
Recurse	Defines that the cmdlet will return items from all subfolders of the specified parent folder. Default: False	`SwitchParameter`	False	Named	False

<CommonParameters>

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

Output Object

The cmdlet returns the VEXItem[] array that contains Microsoft Exchange mailbox items.

Examples

Get-VEXItem Example 1. Getting Mailbox Items from Database [For Veeam Backup & Replication]

This example shows how to get mailbox items with the support keyword from the DB_0754907780.edb mailbox database.

$session = Get-VBRExchangeItemRestoreSession

$database = Get-VEXDatabase -Session $session -Name "DB_0754907780.edb"

Get-VEXItem -Database $database -Query "support"

Perform the following steps:

Get a mailbox database:
1. Run the Get-VBRExchangeItemRestoreSession cmdlet. Save the result to the $session variable.
2. Run the Get-VEXDatabase cmdlet. Set the $session variable as the Session parameter value. Specify the Name parameter value. Save the result to the $database variable.
Run the Get-VEXitem cmdlet. Set the $database variable as the Database parameter value. Specify the Query parameter value.

Get-VEXItem Example 2. Getting Mailbox Items from Mailbox [For Veeam Backup & Replication]

This example shows how to get mailbox items from the Sales mailbox.

$session = Get-VBRExchangeItemRestoreSession

$database = Get-VEXDatabase -Session $session -Name "DB_0754907780.edb"

$salesmailbox = Get-VEXMailbox -Database $database -Name "Sales"

Get-VEXItem -Mailbox $salesmailbox

Perform the following steps:

Get the Sales mailbox:
1. Run the Get-VBRExchangeItemRestoreSession cmdlet. Save the result to the $session variable.
2. Run the Get-VEXDatabase cmdlet. Set the $session variable as the Session parameter value. Specify the Name parameter value. Save the result to the $database variable.
3. Run the Get-VEXMailbox cmdlet. Set the $database variable as the Database parameter value. Specify the Name parameter value. Save the result to the $salesmailbox variable.
Run the Get-VEXitem cmdlet. Set the $salesmailbox variable as the Mailbox parameter value.

Get-VEXItem Example 3. Getting Mailbox Items from Mailbox Folder [For Veeam Backup & Replication]

This example shows how to get items from the Contacts mailbox folder.

$session = Get-VBRExchangeItemRestoreSession

$database = Get-VEXDatabase -Session $session -Name "DB_0754907780.edb"

$mailbox = Get-VEXMailbox -Database $database -Name "Sales"

$contacts = Get-VEXFolder -Mailbox $mailbox -Name "Contacts"

Get-VEXItem -Folder $contacts -Recurse

Perform the following steps:

Get the Contacts folder:
1. Run the Get-VBRExchangeItemRestoreSession cmdlet. Save the result to the $session variable.
2. Run the Get-VEXDatabase cmdlet. Set the $session variable as the Session parameter value. Specify the Name parameter value. Save the result to the $database variable.
3. Run the Get-VEXMailbox cmdlet. Set the $database variable as the Database parameter value. Specify the Name parameter value. Save the result to the $mailbox variable.
4. Run the Get-VEXFolder cmdlet. Set the $mailbox variable as the Mailbox parameter value. Specify the Name parameter value. Save the result to the $contacts variable.
Run the Get-VEXitem cmdlet. Set the $contacts variable as the Folder parameter value. Provide the Recurse parameter.

Get-VEXItem Example 4. Getting Mailbox Items from Database [For Veeam Backup for Microsoft 365]

This example shows how to get mailbox items with the support keyword from a mailbox database.

$session = Get-VBOExchangeItemRestoreSession

$database = Get-VEXDatabase -Session $session -Name "support3backup*"

Get-VEXItem -Database $database -Query "support"

Perform the following steps:

Get the mailbox database:
1. Run the Get-VBOExchangeItemRestoreSession cmdlet. Save the result to the $session variable.
2. Run the Get-VEXDatabase cmdlet. Set the $session variable as the Session parameter value. Specify the Name parameter value. Use the * wildcard character to substitute the timestamp. Save the result to the $database variable.
Run the Get-VEXitem cmdlet. Set the $database variable as the Database parameter value. Specify the Query parameter value.

Get-VEXItem Example 5. Getting Mailbox Items from Mailbox [For Veeam Backup for Microsoft 365]

This example shows how to get mailbox items from the Sales mailbox.

$session = Get-VBOExchangeItemRestoreSession

$database = Get-VEXDatabase -Session $session -Name "support3backup*"

$salesmailbox = Get-VEXMailbox -Database $database -Name "Sales"

Get-VEXItem -Mailbox $salesmailbox

Perform the following steps:

Get the Sales mailbox:
1. Run the Get-VBOExchangeItemRestoreSession cmdlet. Save the result to the $session variable.
2. Run the Get-VEXDatabase cmdlet. Set the $session variable as the Session parameter value. Specify the Name parameter value. Use the * wildcard character to substitute the timestamp. Save the result to the $database variable.
3. Run the Get-VEXMailbox cmdlet. Set the $database variable as the Database parameter value. Specify the Name parameter value. Save the result to the $salesmailbox variable.
Run the Get-VEXitem cmdlet. Set the $salesmailbox variable as the Mailbox parameter value.

Get-VEXItem Example 6. Getting Mailbox Items from Folder [For Veeam Backup for Microsoft 365]

This example shows how to get items from the Contacts mailbox folder.

$session = Get-VBOExchangeItemRestoreSession

$database = Get-VEXDatabase -Session $session -Name "support3backup*"

$mailbox = Get-VEXMailbox -Database $database -Name "Sales"

$contacts = Get-VEXFolder -Mailbox $mailbox -Name "Contacts"

Get-VEXItem -Folder $contacts -Recurse

Get the Contacts folder:
1. Run the Get-VBOExchangeItemRestoreSession cmdlet. Save the result to the $session variable.
2. Run the Get-VEXDatabase cmdlet. Set the $session variable as the Session parameter value. Specify the Name parameter value. Use the * wildcard character to substitute the timestamp. Save the result to the $database variable.
3. Run the Get-VEXMailbox cmdlet. Set the $database variable as the Database parameter value. Specify the Name parameter value. Save the result to the $mailbox variable.
4. Run the Get-VEXFolder cmdlet. Set the $mailbox variable as the Mailbox parameter value. Specify the Name parameter value. Save the result to the $contacts variable.
Run the Get-VEXitem cmdlet. Set the $contacts variable as the Folder parameter value. Provide the Recurse parameter.