Receive-RDMMessage
Synopsis
Get messages associated with the current workspace for the actual user.
Syntax
__AllParameterSets
Receive-RDMMessage [-After <datetime>] [-Before <datetime>] [-CaseSensitive] [-Download]
[-ExcludeRead] [-ExpiresOn <DateFilter>] [-Force] [-Folder <string>] [-From <string[]>]
[-Group <string>] [-MarkAsRead] [-SentOn <DateFilter>] [-Subject <string[]>] [-Vault <Object>]
[-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm] [<CommonParameters>]Description
Get messages associated with the current workspace for the actual user. By default, the fetched messages won't be marked as read. The workspace must be Devolutions Server or Devolutions Cloud. Devolutions Cloud allows to download only entries in the desired repository. Devolutions Server supports credentials, file and private entries. However, all entries will be saved in the user vault.
Examples
Example 1
PS C:\> $messages = Receive-RDMMessage -ExcludeRead; Receive-RDMMessage -From 'First Last' -ExcludeRead -MarkAsReadObtain all the unread messages. All of them will still be marked as unread upon reception. After reading them, the user mark as read the messages from First Last.
Example 2
Obtain all the messages received today from every user whose name start with Joe (Joey LastName, Joelle LastName, Joe Blow, etc.). All of them will be marked as read upon reception.
Example 3
Obtain the message(s) sent today by 'FirstName LastName' whose subject is 'Requiered Connections'. The message(s) will be marked as read upon reception and all connections/attachments will be downloaded without a confirmation prompt in the user vault. The files will be stored in 'MyDocuments' and the entries will be in the root.
Example 4
Obtain the messages that were sent and expired in 2000.
Example 5
Obtain all the messages from people whose name end with LastName and the subject is Subject followed by an another character (SubjectA, Subject1).
Parameters
-After
Set the inclusive custom lower limit date for the ExpiresOn or SentOn parameter that is set to Custom. It will be set at the beginning of the day. If both ExpiresOn and SentOn are set to Custom, it will apply for both of them.
-Before
Set the inclusive custom upper limit date for the ExpiresOn or SentOn parameter that is set to Custom. It will be set at the end of the day. If both ExpiresOn and SentOn are set to Custom, it will apply for both of them.
-CaseSensitive
Parameters used will be case sensitive.
-Confirm
Prompts you for confirmation before running the cmdlet.
-Download
Download the connections and attachments in the message.
-ExcludeRead
Keep only the unread messages.
-ExpiresOn
Keep the messages that expire after the specified date. If set to Custom, After and Before parameters allows to define a specific interval.
-Folder
For Devolutions Server only. Specify the directory where the files will be downloaded. If not specied, it will be in 'MyDocuments'. In the event a file attachment shares a name with an existing file in the folder, the existing one will be overwritten.
-Force
Bypass the confirmation to proceed. If the DownloadAttachment switch is present, the attachments of all returned message will be downloaded.
-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.
-From
Filter the messages based on the senders.
-Group
For Devolutions Server only. Specify the group where the connections will be downloaded. If not specified, it will be in the root.
-MarkAsRead
All fetched messages will be marked as read.
-SentOn
Keep the messages that expire after the specified date. If set to Custom, After and Before parameters allows to define a specific interval.
-Subject
Filter the messages based on the subjects.
-Vault
For Devolutions Cloud only. Specify the vault where the entry will be saved.
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
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 Receive-RDMMessage -detailed". For technical information, type "Get-Help Receive-RDMMessage -full".
Last updated
Was this helpful?