Get-VEXItem

In this article

Short Description

Returns items added to Microsoft Exchange mailboxes.

Applies to: Veeam Backup & Replication, Veeam Backup for Microsoft Office 365

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

Syntax

This cmdlet provides parameter sets that allow you to:

Get mailbox items from a mailbox database.

Get-VEXItem -Database <VEXDatabase[]> [-Query <string>] [<CommonParameters>]

Get mailbox items from a mailbox.

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

Get mailbox items from a folder.

Get-VEXItem -Folder <VEXFolder> [-Query <string>] [-Recurse] [<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

Parameter	Description	Type	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Database	Specifies a mailbox database. The cmdlet will return items from this database.	Accepts the VEXDatabase[] object. To get this object, run the Get-VEXDatabase cmdlet.	True	True Named	True (ByValue)	False
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.	True	Named	True (ByValue)	False
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.	True	Named	True (ByValue)	False
Query	Allows using keywords for mailbox item search. The cmdlet will return items that match the search query from the specified folder, database or mailbox.	String	False	Named	False	True
Recurse	Defines that the cmdlet will return items from all subfolders of the specified parent folder.	SwitchParameter	False	Named	False	False

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 object that contains folders items added to Microsoft Exchange mailboxes.

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 form 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:

Run the Get-VBRExchangeItemRestoreSession cmdlet. Save the result to the $session variable.
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:

Run the Get-VBRExchangeItemRestoreSession cmdlet. Save the result to the $session variable.
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-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 mailbox 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:

Run the Get-VBRExchangeItemRestoreSession cmdlet. Save the result to the $session variable.
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-VEXMailbox cmdlet. Set the $database variable as the Database parameter value. Specify the Name parameter value. Save the result to the $mailbox variable.
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 Office 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.onmicrosoft.com

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

Perform the following steps:

Get the mailbox database:

Run the Get-VBOExchangeItemRestoreSession cmdlet. Save the result to the $session variable.
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 5. Getting Mailbox Items from Mailbox [For Veeam Backup for Microsoft Office 365]

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

$session = Get-VBOExchangeItemRestoreSession

$database = Get-VEXDatabase -Session $session -Name support3backup.onmicrosoft.com

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

Get-VEXItem -Mailbox $salesmailbox

Perform the following steps:

Get the Sales mailbox:

Run the Get-VBOExchangeItemRestoreSession cmdlet. Save the result to the $session variable.
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-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 Office 365]

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

$session = Get-VBOExchangeItemRestoreSession

$database = Get-VEXDatabase -Session $session -Name support3backup.onmicrosoft.com

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

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

Get-VEXItem -Folder $contacts -Recurse

Get the Contacts folder:

Run the Get-VBOExchangeItemRestoreSession cmdlet. Save the result to the $session variable.
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-VEXMailbox cmdlet. Set the $database variable as the Database parameter value. Specify the Name parameter value. Save the result to the $mailbox variable.
Run the Get-VEXFolder cmdlet. Set the $mailbox variable as the Mailbox 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.

Related Commands