Receive-RDMMessage

2024-11-18

Receive-RDMMessage

SYNOPSIS

Get messages associated with the current data source 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>]

ALIASES

This cmdlet has the following aliases,

DESCRIPTION

Get messages associated with the current data sourcefor the actual user. By default, the fetched messages won't be marked as read. The data source must be a Devolutions Server or a Devolutions Hub Server. Devolutions Hub Server 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 -MarkAsRead

Obtain 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

PS C:> $messages = Receive-RDMMessage -SentOn Today -From Joe* -MarkAsRead

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

PS C:> $messages = Receive-RDMMessage -SentOn Today -Subject 'Required connections' -From 'FirstName LastName' -Download -Force -MarkAsRead

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

PS C:> $messages = Receive-RDMMessage -SentOn Custom -ExpiresOn Custom -After 2000/01/01 -Before 2001/12/31

Obtain the messages that were sent and expired in 2000.

EXAMPLE 5

PS C:> $messages = Receive-RDMMessage -From *LastName -Subject Subject? -CaseSensitive

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.

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

-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.

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

-CaseSensitive

Parameters used will be case sensitive.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-Download

Download the connections and attachments in the message.

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

-ExcludeRead

Keep only the unread messages.

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

-ExpiresOn

Keep the messages that expire after the specified date. If set to Custom, After and Before parameters allows to define a specific interval.

Type: System.Nullable`1[Devolutions.RemoteDesktopManager.DateFilter]
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-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.

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

-Force

Bypass the confirmation to proceed. If the DownloadAttachment switch is present, the attachments of all returned message will be downloaded.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  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 not an option No.
• Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.

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

-From

Filter the messages based on the senders.

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

-Group

For Devolutions Server only. Specify the group where the connections will be downloaded. If not specified, it will be in the root.

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

-MarkAsRead

All fetched messages will be marked as read.

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

-SentOn

Keep the messages that expire after the specified date. If set to Custom, After and Before parameters allows to define a specific interval.

Type: System.Nullable`1[Devolutions.RemoteDesktopManager.DateFilter]
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Subject

Filter the messages based on the subjects.

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

-Vault

For Devolution Hub Server only. Specify the vault where the entry will be saved.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
ParameterValue: []
Aliases:
- wi
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  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.

INPUTS

OUTPUTS

NOTES

For more information, type "Get-Help Receive-RDMMessage -detailed". For technical information, type "Get-Help Receive-RDMMessage -full".

RELATED LINKS

• Remove-RDMMessage
• Send-RDMMessage