Send-RDMMessageByEmail

Synopsis

Send a link to a message via email

Syntax

__AllParameterSets

Send-RDMMessageByEmail [-To] <string[]> [-Body] <string> [[-Passphrase] <string>]
 [[-Duration] <PSSendLinkDurationWrapper>] [[-ViewLimit] <int>] [-AllowRecipientToDeleteMessage]
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

Description

Use Devolutions Send to send a link to a message via email. Only Devolutions Cloud and Devolutions Server workspaces supports this cmdlet.

Examples

Example 1

PS C:\> Send-RDMMessageByEmail -To [e-mail] -Body 'A special message' -Passphrase 654321 -Duration 5 -AllowRecipientToDeleteMessage -ViewLimit 10

Send an email to [e-mail] containing the link to the message. The recepient will have to use the passphrase to decrypt the message. He can view it ten times within the next 5 days. If they do not need it anymore, they can delete it himself.

Example 2

PS C:\> Send-RDMMessageByEmail -To [e-mail], [e-mail], [e-mail] -Body 'A special message' -Duration OneHour

Send an email to [e-mail], [e-mail], [e-mail] containing the link to the message. The link is valid only for an hour.

Parameters

-AllowRecipientToDeleteMessage

Allow a recipient to delete the message

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Body

Message to be sent.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 1
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Duration

Time before the expiration of the link. Either a number of days (max 30) or a value from the enum [Devolutions.Server.ApiWrapper.Models.SendLinkDuration]. The default duration is a single hour.

Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSWrapper.PSSendLinkDurationWrapper
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 3
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-ForcePromptAnswer

Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values:

• Yes: Accept the prompt. Cover the OK and Automatic value.
• No: Refuse the yes/no/cancel prompt. "Cancel" is the fallback option if there is no "No" option.
• Cancel: Cancel the yes/no/cancel prompt. "No" is the fallback option if there is no "Cancel" option.

Type: System.Windows.Forms.DialogResult[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Passphrase

Passphrase to protect message. The recipient will have to use it to decrypt the message.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 2
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-To

Emails of the recepients of the message. For Devolutions Cloud workspaces, the number of recipients is limited to 10.

Type: System.String[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-ViewLimit

How many times the link can be seen before being deleted. By default, there is no limit.

Type: System.Nullable`1[System.Int32]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 4
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Notes

For more information, type "Get-Help Send-RDMMessageByEmail -detailed". For technical information, type "Get-Help Send-RDMMessageByEmail -full".