Help Center
Choose product document...
Veeam Backup for Microsoft Office 365 3.0
PowerShell Reference

Send-VESPItem

Short Description

Sends SharePoint items as attachments to e-mails.

Syntax

This cmdlet provides 3 parameter sets.

  • For sending a SharePoint document library:

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

  • For sending a SharePoint document:

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

  • For sending a SharePoint attachment file:

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

Detailed Description

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

Send-VESPItem Note:

Before sending restored Exchange organization's 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 mailbox data.

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

If you do not provide this parameter, 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 mailbox 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 http://go.microsoft.com/fwlink/p/?LinkID=113216.

Example 1

This example shows how to send a SharePoint document library with a name "Test Document Library" to a test mailbox.

  1. Run Get-VBOSharePointItemRestoreSession to get the active restore session. Save the result to the $session variable.
  2. Run Get-VESPOrganization with the $session variable to get the organization with the name "ABC". Save the result to the $organization variable.
  3. Run Get-VESPDocumentLibrary with the $organization variable and Name parameter to get a document library with a name "Test Document Library". Save the result to the $documentLibrary variable.
  4. Run Sent-VESPItem with the $documentLibrary variable and To parameter to send the document library to the test mailbox.

$session = Get-VBOExchangeItemRestoreSession

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

$documentLibrary = Get-VESPDocumentLibrary -Organization $organization -Name "Test Document Library"

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

Example 2

This example shows how to send a SharePoint document with a name "document.txt" to a test mailbox.

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

$session = Get-VBOSharePointItemRestoreSession

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

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

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

Example 3

This example shows how to send a SharePoint document with a name "document.txt" to a test mailbox.

  1. Run Get-VBOSharePointItemRestoreSession to get the active restore session. Save the result to the $session variable.
  2. Run Get-VESPOrganization with the $session variable to get the organization with the name "ABC". Save the result to the $organization variable.
  3. Run Get-VESPItem with the $organization variable and enter a "document.txt" value for a Query parameter to get a SharePoint item with a name "document.txt". Save the result to the $item variable.
  4. Run Get-VESPItemAttachment with the $item variable to get SharePoint item attachments. Save the result to the $attachment variable.
  5. Run Sent-VESPItem with the $document variable and To parameter to send the document library to the test mailbox.

$session = Get-VBOSharePointItemRestoreSession

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

$item = Get-VESPItem -Organization $organization -Query "document.txt"

$attachment = Get-VESPItemAttachment -Item $item

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

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference