SendMailMessage Class

Definition

Namespace:: Microsoft.PowerShell.Commands

Assembly:: Microsoft.PowerShell.Commands.Utility.dll

Package:: Microsoft.PowerShell.5.1.ReferenceAssemblies v1.0.0

Package:: Microsoft.PowerShell.Commands.Utility v7.0.0

Package:: Microsoft.PowerShell.Commands.Utility v6.2.0

Caution

This cmdlet does not guarantee secure connections to SMTP servers. While there is no immediate replacement available in PowerShell, we recommend you do not use Send-MailMessage at this time. See https://aka.ms/SendMailMessage for more information.

implementation for the Send-MailMessage command

public ref class SendMailMessage sealed : System::Management::Automation::PSCmdlet

public sealed class SendMailMessage : System.Management.Automation.PSCmdlet

[System.Obsolete("This cmdlet does not guarantee secure connections to SMTP servers. While there is no immediate replacement available in PowerShell, we recommend you do not use Send-MailMessage at this time. See https://aka.ms/SendMailMessage for more information.")]
[System.Management.Automation.Cmdlet("Send", "MailMessage", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2097115")]
public sealed class SendMailMessage : System.Management.Automation.PSCmdlet

[System.Management.Automation.Cmdlet("Send", "MailMessage", HelpUri="https://go.microsoft.com/fwlink/?LinkID=135256")]
[System.Obsolete("This cmdlet does not guarantee secure connections to SMTP servers. While there is no immediate replacement available in PowerShell, we recommend you do not use Send-MailMessage at this time. See https://aka.ms/SendMailMessage for more information.")]
public sealed class SendMailMessage : System.Management.Automation.PSCmdlet

type SendMailMessage = class
    inherit PSCmdlet

Public NotInheritable Class SendMailMessage
Inherits PSCmdlet

Inheritance: Object

InternalCommand

Cmdlet

PSCmdlet
SendMailMessage

Attributes: CmdletAttribute ObsoleteAttribute

Constructors

SendMailMessage()

Properties

Attachments	Specifies the files names to be attached to the email. If the filename specified can not be found, then the relevant error message should be thrown.
Bcc	Specifies the address collection that contains the blind carbon copy (BCC) recipients for the e-mail message.
Body	Specifies the body (content) of the message
BodyAsHtml	Specifies a value indicating whether the mail message body is in Html.
Cc	Specifies the address collection that contains the carbon copy (CC) recipients for the e-mail message.
CommandOrigin	This property tells you if you were being invoked inside the runspace or if it was an external request. (Inherited from InternalCommand)
CommandRuntime	Holds the command runtime object for this command. This object controls what actually happens when a write is called. (Inherited from Cmdlet)
Credential	Specifies the credential for this e-mail message.
CurrentPSTransaction	Gets an object that surfaces the current PowerShell transaction. When this object is disposed, PowerShell resets the active transaction (Inherited from Cmdlet)
DeliveryNotificationOption	Specifies the delivery notifications options for the e-mail message. The various option available for this parameter are None, OnSuccess, OnFailure, Delay and Never
Encoding	Specifies the encoding used for the content of the body and also the subject.
Events	Gets the event manager for the current runspace. (Inherited from PSCmdlet)
From	Specifies the from address for this e-mail message. The default value for this parameter is the email address of the currently logged on user
Host	Gets the host interaction APIs. (Inherited from PSCmdlet)
InvokeCommand	Provides access to utility routines for executing scripts and creating script blocks. (Inherited from PSCmdlet)
InvokeProvider	Gets the instance of the provider interface APIs for the current runspace. (Inherited from PSCmdlet)
JobManager	Manager for JobSourceAdapters registered. (Inherited from PSCmdlet)
JobRepository	Repostiory for jobs (Inherited from PSCmdlet)
MyInvocation	Contains information about the identity of this cmdlet and how it was invoked. (Inherited from PSCmdlet)
PagingParameters	If the cmdlet declares paging support (via SupportsPaging), then PagingParameters property contains arguments of the paging parameters. Otherwise PagingParameters property is `null`. (Inherited from PSCmdlet)
ParameterSetName	The name of the parameter set in effect. (Inherited from PSCmdlet)
Port	Specifies the Port to be used on `SmtpServer`
Priority	Specifies the priority of the email message. The valid values for this are Normal, High and Low
ReplyTo
SessionState	Gets the instance of session state for the current runspace. (Inherited from PSCmdlet)
SmtpServer	Specifies the name of the Host used to send the email. This host name will be assigned to the Powershell variable PSEmailServer,if this host can not reached an appropriate error message will be displayed.
Stopping	Is this command stopping? (Inherited from Cmdlet)
Subject	Specifies the subject of the email message.
To	Specifies the To address for this e-mail message.
UseSsl	Specifies if Secured layer is required or not

Methods

BeginProcessing()	When overridden in the derived class, performs initialization of command execution. Default implementation in the base class just returns. (Inherited from Cmdlet)
CurrentProviderLocation(String)	(Inherited from PSCmdlet)
EndProcessing()	When overridden in the derived class, performs clean-up after the command execution. Default implementation in the base class just returns. (Inherited from Cmdlet)
GetResolvedProviderPathFromPSPath(String, ProviderInfo)	(Inherited from PSCmdlet)
GetResourceString(String, String)	Gets the resource string corresponding to baseName and resourceId from the current assembly. You should override this if you require a different behavior. (Inherited from Cmdlet)
GetUnresolvedProviderPathFromPSPath(String)	(Inherited from PSCmdlet)
GetVariableValue(String)	(Inherited from PSCmdlet)
GetVariableValue(String, Object)	(Inherited from PSCmdlet)
Invoke()	Invoke this cmdlet object returning a collection of results. (Inherited from Cmdlet)
Invoke<T>()	Returns a strongly-typed enumerator for the results of this cmdlet. (Inherited from Cmdlet)
ProcessRecord()	When overridden in the derived class, performs execution of the command. (Inherited from Cmdlet)
ShouldContinue(String, String)	Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant only offers Yes/No, not YesToAll/NoToAll. (Inherited from Cmdlet)
ShouldContinue(String, String, Boolean, Boolean)	Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll. (Inherited from Cmdlet)
ShouldContinue(String, String, Boolean, Boolean, Boolean)	Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll. (Inherited from Cmdlet)
ShouldProcess(String)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. (Inherited from Cmdlet)
ShouldProcess(String, String)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify text for both the target resource and the action. (Inherited from Cmdlet)
ShouldProcess(String, String, String)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify the complete text describing the operation, rather than just the name and action. (Inherited from Cmdlet)
ShouldProcess(String, String, String, ShouldProcessReason)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify the complete text describing the operation, rather than just the name and action. (Inherited from Cmdlet)
StopProcessing()	When overridden in the derived class, interrupts currently running code within the command. It should interrupt BeginProcessing, ProcessRecord, and EndProcessing. Default implementation in the base class just returns. (Inherited from Cmdlet)
ThrowTerminatingError(ErrorRecord)	Terminate the command and report an error (Inherited from Cmdlet)
TransactionAvailable()	Returns true if a transaction is available and active. (Inherited from Cmdlet)
WriteCommandDetail(String)	Write text into pipeline execution log. (Inherited from Cmdlet)
WriteDebug(String)	Display debug information (Inherited from Cmdlet)
WriteError(ErrorRecord)	Internal variant: Writes the specified error to the error pipe. (Inherited from Cmdlet)
WriteInformation(InformationRecord)	Route information to the user or host. (Inherited from Cmdlet)
WriteInformation(Object, String[])	Route information to the user or host. (Inherited from Cmdlet)
WriteObject(Object)	Writes the object to the output pipe. (Inherited from Cmdlet)
WriteObject(Object, Boolean)	Writes one or more objects to the output pipe. If the object is a collection and the enumerateCollection flag is true, the objects in the collection will be written individually. (Inherited from Cmdlet)
WriteProgress(ProgressRecord)	Display progress information (Inherited from Cmdlet)
WriteVerbose(String)	Display verbose information (Inherited from Cmdlet)
WriteWarning(String)	Display warning information (Inherited from Cmdlet)

Applies to