This is an archive version of the document. To get the most up-to-date information, see the current version.

Send-VEODDocument

In this article

Short Description

Sends OneDrive documents via e-mail.

Applies to Veeam Backup for Microsoft Office 365

Product Edition: Community, Rental, Subscription

Syntax

This cmdlet provides parameter sets that allow you to:

To send a specific OneDrive document:

Send-VEODDocument [-Document] <VBOOneDriveDocument[]> -To <string> [-From <string>] [-Subject <string>] [-Text <string>] [<CommonParameters>]

To send documents of a specific OneDrive user:

Send-VEODDocument [-User] <VBOOneDriveUser> -To <string> [-From <string>] [-Subject <string>] [-Text <string>] [<CommonParameters>]

Detailed Description

This cmdlet sends OneDrive documents as attachments to e-mails.

Send-VEODDocument Note:

Before sending restored OneDrive data, check the following prerequisites:

You must specify Veeam Explorer for Microsoft OneDrive SMTP settings. For more information, see Set-VEODSmtpSettings.
You must start a restore session. For more information, see Start-VEODRestoreSession.

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Document	Specifies OneDrive document 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 OneDrive will send restored OneDrive 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 OneDrive will use the e-mail address, specified in SMTP settings. To learn more, see Set-VEODSmtpSettings.	False	Named	False	False
To	Specifies the e-mail address to which Veeam Explorer for OneDrive will send restored data.	True	Named	False	False
Subject	Specifies the subject of the e-mail message.	False	Named	False	False
Text	Specifies the body of the e-mail message.	False	Named	False	False
User	Specifies the name of the OneDrive user. This cmdlet will send OneDrive document of this user.	True	0	True (ByValue)	False

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

.Example 1

This example shows how to send the document.txt OneDrive document that belongs to the userAlpha user.

Run the Get-VEODRestoreSession cmdlet to get the active restore session. Save the result to the $session variable.
Run the Get-VEODUser cmdlet with the $session variable to get the user. Save the result to the $user variable.
Run the Get-VEODDocument cmdlet with the $user variable and the Name parameter to get the specific OneDrive document. Use the Recurse parameter to also get all of its child versions.
Run the Send-VEODDocument cmdlet with the $document variable and the To parameter to specify the e-mail where to send the selected document. Use the Subject and Text parameters to write a subject and a text of the message.

$session = Get-VEODRestoreSession

$user = Get-VEODDriveUser -Session $session -Name “userAlpha”

$document = Get-VEODDocument -User $user -Name “document.txt” -Recurse

Send-VEODDocument -Document $document -To user.Alpha@mail.com -Subject "Subject" -Text "Mail text"

Example 2

This example shows how to send the document.txt OneDrive document that belongs to the userAlpha user.

Run the Get-VEODRestoreSession cmdlet to get an active restore session. Save the result to the $session variable.
Run the Get-VEODUser cmdlet with the $session variable to get the user. Save the result to the $user variable.
Run the Get-VEODDocument cmdlet with the $user variable and the Name parameter to get the specific OneDrive document. Use the Recurse parameter to also get all of its child versions.
Run the Send-VEODDocument cmdlet with the $document variable and the To parameter to specify the e-mail where to send the selected document. Use the Subject and Text parameters to write a subject and a text of the message.

$session = Get-VEODRestoreSession

$user = Get-VEODUser -Session $session -Name “userAlpha”

$document = Get-VEODDocument -User $user -Name “document.txt” -Recurse

Send-VEODDocument -User $user -To user.Alpha@mail.com -Subject "Subject" -Text "Mail text"

Related Commands

Get-VEODDocument