Remove-RDMMessage

    2024-10-28

    Remove-RDMMessage

    SYNOPSIS

    Remove a secure message.

    SYNTAX

    ID

    Remove-RDMMessage [-ID] <guid> [-Force] [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

    Message

    Remove-RDMMessage [-Message] <DataSourceMessage> [-Force] [-ForcePromptAnswer <DialogResult[]>]
 [-WhatIf] [-Confirm] [<CommonParameters>]

    ALIASES

    This cmdlet has the following aliases,

    DESCRIPTION

    Remove a secure message. The data source must be a Devolutions Server or a Devolutions Hub Server.

    EXAMPLES

    EXAMPLE 1

    PS C:> Receive-RDMMessage -SentOn -Custom -Before 2021/12/31 | Remove-RDMMessage -Force

    Delete all messages sent before 2022/01/01 (Before value is inclusive). No confirmation prompt will occur.

    EXAMPLE 2

    PS C:> $messages = Receive-RDMMessage -SentOn Today; $messages | Where-Object -Property FromName -ne 'First Last' | Remove-RDMMessage -Force

    The user fetch all message received today. He read all of them. He decides to only keep those sent by 'First Last' and delete the rest wiithout any confirmation prompt.

    EXAMPLE 3

    PS C:> Receive-RDMMessage | Remove-RDMMessage -Confirm

    The user will be prompted to delete each message one by one.

    PARAMETERS

    -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: ''

    -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: ''

    -ID

    Id of the message to delete.

    Type: System.Nullable`1[System.Guid]
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: ID
  Position: 1
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -Message

    Messages to delete.

    Type: Devolutions.RemoteDesktopManager.Business.Messages.DataSourceMessage
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: Message
  Position: 1
  IsRequired: true
  ValueFromPipeline: true
  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

    Devolutions.RemoteDesktopManager.Business.Messages.DataSourceMessage

    The message obtained from the Receive-RDMMessage can be piped to the parameter Message.

    OUTPUTS

    NOTES

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