New-RDMMessageAttachment

Synopsis

Create an attachment for a message.

Syntax

Credentials

New-RDMMessageAttachment -Credentials -Password <securestring> -Title <string> -Username <string>
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

File

New-RDMMessageAttachment -File -Path <string> [-ForcePromptAnswer <DialogResult[]>]
 [<CommonParameters>]

Description

Create an attachment for the command Send-RDMMessage. To attach a private entry, simply use the Get-RDMPrivateSession cmdlet instead of this one.

Examples

Example 1

PS C:\> $cred = New-RDMMessageAttachment -Credentials -Title 'ForSomething' -Username 'ABC' -Password (ConvertTo-SecureString -AsPlainText passw0rd); Send-RDMMessage -To 'First Last' -Subject 'Required credentials' -Attachment $cred

Create a simple Username/Password attachment. That attachment is sent in a message to 'First Last'.

Example 2

PS C:\> $file = New-RDMMessageAttachment -File -Path C:\mypath\filename.extension; $file.Name = 'renamedFile.extension'; Send-RDMMessage -To 'First Last' -Subject 'A File' -Attachment $file

Create an attachment from a file. The user rename the file from filename.extension to renamedFile.extension. That attachment is sent in a message to 'First Last'.

Parameters

-Credentials

The credentials Username/Password are attached to the message with a title to identify them.

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

-File

The attachment is a file.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: File
  Position: Named
  IsRequired: true
  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
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Password

The password of the credentials.

Type: System.Security.SecureString
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Credentials
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Path

The path to the file to attach to the message.

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

-Title

The title of the credentials.

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

-Username

The username of the credentials.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Credentials
  Position: Named
  IsRequired: true
  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.

Notes

For more information, type "Get-Help New-RDMMessageAttachment -detailed". For technical information, type "Get-Help New-RDMMessageAttachment -full".

Devolutions Forum logo Donnez-nous vos commentaires