Help Center
Choose product document...
Veeam Backup & Replication 9.5 Update 4
Veeam Explorers PowerShell Reference

Send-VESPItem

Short Description

Sends SharePoint items as attachments to e-mails.

Applies to

Product Edition: Community, Standard, Enterprise, Enterprise Plus

Syntax

This cmdlet provides parameter sets that allow you to:

  • To send a SharePoint document library:

Send-VESPItem [-DocumentLibrary] <VESPDocumentLibrary> -To <string> [-From <string>] [-Subject <string>] [-Body <string>]  [<CommonParameters>]

  • To send a SharePoint document:

Send-VESPItem [-Document] <VESPDocument[]> -To <string> [-From <string>] [-Subject <string>] [-Body <string>]  [<CommonParameters>]

  • To send a SharePoint attachment file:

Send-VESPItem [-Attachment] <VESPItemAttachment[]> -To <string> [-From <string>] [-Subject <string>] [-Body <string>]  [<CommonParameters>]

Detailed Description

This cmdlet sends SharePoint organization attachments, documents and document libraries as attachments to e-mails.

Send-VESPItem Note:

Before sending restored Exchange organization mailbox data, check the following prerequisites:

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

DocumentLibrary

Specifies SharePoint document library that you want to send in the e-mail message.

True

0

True (ByValue)

False

From

Specifies the e-mail address from which Veeam Explorer for Microsoft SharePoint will send restored data.

This e-mail address must have the rights to connect to an SMTP server if the SMTP server requires authentication.

If this parameter is omitted, Veeam Explorer for Microsoft SharePoint will use the e-mail address, specified in SMTP settings. To learn more, see Set-VESPSmtpSettings.

False

Named

False

False

To

Specifies the e-mail address to which Veeam Explorer for Microsoft SharePoint will send restored data.

True

Named

False

False

Subject

Specifies the subject of the e-mail message.

False

Named

False

False

Body

Specifies the body of the e-mail message.

False

Named

False

False

Document

Specifies SharePoint items that you want to send in the e-mail message.

True

0

True (ByValue)

False

Attachment

Specifies SharePoint attachment that you want to send in the e-mail message.

True

0

True (ByValue)

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Example 1

[For Veeam Backup for Microsoft Office 365] This example shows how to send the Regulations document library to a test mailbox.

  1. Run the Get-VBOSharePointItemRestoreSession cmdlet to get an active restore session. Save the result to the $session variable.
  2. Run the Get-VESPOrganization cmdlet with the $session variable to get the ABC organization. Save the result to the $organization variable.
  3. Run the Get-VESPDocumentLibrary cmdlet with the $organization variable and the Name parameter to get the Regulations document library. Save the result to the $documentLibrary variable.
  4. Run the Send-VESPItem cmdlet with the $documentLibrary variable and the To parameter to send the Regulations document library to the test mailbox.

$session = Get-VBOSharePointItemRestoreSession

$organization = Get-VESPOrganization -Session $session -Name "ABC"

$documentLibrary = Get-VESPDocumentLibrary -Organization $organization -Name "Regulations"

Send-VESPItem -DocumentLibrary $documentLibrary -To administrator@test.local

Example 2

[For Veeam Backup for Microsoft Office 365] This example shows how to send the document with the name reports.txt to a test mailbox.

  1. Run the Get-VBOSharePointItemRestoreSession cmdlet to get an active restore session. Save the result to the $session variable.
  2. Run the Get-VESPOrganization cmdlet with the $session variable to get the ABC organization. Save the result to the $organization variable.
  3. Run the Get-VESPDocument cmdlet with the $organization variable and the reports.txt value for the Query parameter to get the reports.txt SharePoint document. Save the result to the $document variable.
  4. Run the Send-VESPItem cmdlet with the $document variable and the To parameter to send the reports.txt document to the test mailbox.

$session = Get-VBOSharePointItemRestoreSession

$organization = Get-VESPOrganization -Session $session -Name "ABC"

$document = Get-VESPDocument -Organization $organization -Query "reports.txt"

Send-VESPItem -Document $document -To administrator@test.local

Example 3

[For Veeam Backup for Microsoft Office 365] This example shows how to send the attachments to the Reports SharePoint item to a test mailbox.

  1. Run the Get-VBOSharePointItemRestoreSession cmdlet to get an active restore session. Save the result to the $session variable.
  2. Run the Get-VESPOrganization cmdlet with the $session variable to get the ABC organization. Save the result to the $organization variable.
  3. Run the Get-VESPItem cmdlet with the $organization variable and enter the Reports value for the Query parameter to get the Reports SharePoint item. Save the result to the $item variable.
  4. Run the Get-VESPItemAttachment cmdlet with the $item variable to get the Reports SharePoint item attachments. Save the result to the $attachment variable.
  5. Run the Send-VESPItem cmdlet with the $attachment variable and the To parameter to send the Reports item attachments to the test mailbox.

$session = Get-VBOSharePointItemRestoreSession

$organization = Get-VESPOrganization -Session $session -Name "ABC"

$item = Get-VESPItem -Organization $organization -Query "Reports"

$attachment = Get-VESPItemAttachment -Item $item

Send-VESPItem -Attachment $attachment -To administrator@test.local

Example 4

[For Veeam Backup & Replication] This example shows how to send the Regulations document library to a test mailbox.

  1. Run the Get-VBRSharePointItemRestoreSession cmdlet to get an active restore session. Save the result to the $session variable.
  2. Run the Get-VESPDatabase cmdlet with the $session variable to get the WSS_Content.mdf database. Save the result to the $database variable.
  3. Run the Get-VESPDocumentLibrary cmdlet with the $database variable and the Name parameter to get the Regulations document library. Save the result to the $documentLibrary variable.
  4. Run the Send-VESPItem cmdlet with the $documentLibrary variable and the To parameter to send the Regulations document library to the test mailbox.

$session = Get-VBRSharePointItemRestoreSession

$database = Get-VESPDatabase -Session $session -Name "WSS_Content.mdf"

$documentLibrary = Get-VESPDocumentLibrary -Database $database -Name "Regulations"

Send-VESPItem -DocumentLibrary $documentLibrary -To administrator@test.local

Example 5

[For Veeam Backup & Replication] This example shows how to send the reports.txt document to a test mailbox.

  1. Run the Get-VBRSharePointItemRestoreSession cmdlet to get an active restore session. Save the result to the $session variable.
  2. Run the Get-VESPDatabase cmdlet with the $session variable to get the database with the name WSS_Content.mdf. Save the result to the $database variable.
  3. Run the Get-VESPDocument cmdlet with the $database variable and the reports.txt value for the Query parameter to get the reports.txt SharePoint document. Save the result to the $document variable.
  4. Run the Send-VESPItem cmdlet with the $document variable and the To parameter to send the reports.txt document to the test mailbox.

$session = Get-VBRSharePointItemRestoreSession

$database = Get-VESPDatabase -Session $session -Name "WSS_Content.mdf"

$document = Get-VESPDocument -Database $database -Query "reports.txt"

Send-VESPItem -Document $document -To administrator@test.local

Example 6

[For Veeam Backup & Replication] This example shows how to send the attachments of the Reports SharePoint item to the test mailbox.

  1. Run the Get-VBRSharePointItemRestoreSession cmdlet to get an active restore session. Save the result to the $session variable.
  2. Run the Get-VESPDatabase cmdlet with the $session variable to get the WSS_Content.mdf database. Save the result to the $database variable.
  3. Run the Get-VESPItem cmdlet with the $database variable and enter the Reports value for the Query parameter to get the Reports SharePoint item. Save the result to the $item variable.
  4. Run the Get-VESPItemAttachment cmdlet with the $item variable to get the Reports SharePoint item attachments. Save the result to the $attachment variable.
  5. Run the Send-VESPItem cmdlet with the $attachment variable and the To parameter to send the Reports item attachments to the test mailbox.

$session = Get-VBRSharePointItemRestoreSession

$database = Get-VESPDatabase -Session $session -Name "WSS_Content.mdf"

$item = Get-VESPItem -Database $database -Query "Reports"

$attachment = Get-VESPItemAttachment -Item $item

Send-VESPItem -Attachment $attachment -To administrator@test.local

Related Commands

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions

Veeam Availability for Nutanix AHV

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation