PDQ.com mobilePDQ.com desktop
Support

Send-MailMessage

Sends an email message.
Send-MailMessage [-To*] <String[]> [-Subject*] <String> [[-Body] <String>] [[-SmtpServer] <String>] [-Attachments<String[]>] [-Bcc <String[]>] [-BodyAsHtml] [-Cc <String[]>] [-Credential <PSCredential>][-DeliveryNotificationOption {None | OnSuccess | OnFailure | Delay | Never}] [-Encoding <Encoding>] -From* <String>[-Port <Int32>] [-Priority {Normal | Low | High}] [-UseSsl] [<CommonParameters>]

The Send-MailMessage cmdlet sends an email message from within Windows PowerShell.

Parameters

-Attachments <String[]>

  • Default value is None
  • Accepts pipeline input ByValue

Specifies the path and file names of files to be attached to the email message. You can use this parameter or pipe the paths and file names to Send-MailMessage .

-Bcc <String[]>

  • Default value is None
  • Accepts pipeline input False

Specifies the email addresses that receive a copy of the mail but are not listed as recipients of the message. Enter names (optional) and the email address, such as Name <[email protected]>.

-Body <String>

  • Default value is None
  • Accepts pipeline input False

Specifies the body of the email message.

-BodyAsHtml [<SwitchParameter>]

  • Default value is False
  • Accepts pipeline input False

Indicates that the value of the Body parameter contains HTML.

-Cc <String[]>

  • Default value is None
  • Accepts pipeline input False

Specifies the email addresses to which a carbon copy (CC) of the email message is sent. Enter names (optional) and the email address, such as Name <[email protected]>.

-Credential <PSCredential>

  • Default value is None
  • Accepts pipeline input False

Specifies a user account that has permission to perform this action. The default is the current user.

Type a user name, such as User01 or Domain01\User01. Or, enter a PSCredential object, such as one from the Get-Credential cmdlet.

-DeliveryNotificationOption <DeliveryNotificationOptions>

  • Default value is None
  • Accepts pipeline input False

Specifies the delivery notification options for the email message. You can specify multiple values. None is the default value. The alias for this parameter is dno .

The delivery notifications are sent in an email message to the address specified in the value of the To parameter. The acceptable values for this parameter are:

- None. No notification. - OnSuccess. Notify if the delivery is successful. - OnFailure. Notify if the delivery is unsuccessful. - Delay. Notify if the delivery is delayed. - Never. Never notify.

-Encoding <Encoding>

  • Default value is None
  • Accepts pipeline input False

Specifies the encoding used for the body and subject. The acceptable values for this parameter are:

- ASCII

- UTF8

- UTF7

- UTF32

- Unicode

- BigEndianUnicode

- Default

- OEM

ASCII is the default.

-From <String>

  • This value is required
  • Default value is None
  • Accepts pipeline input False

Specifies the address from which the mail is sent. Enter a name (optional) and email address, such as Name <[email protected]>. This parameter is required.

-Port <Int32>

  • Default value is None
  • Accepts pipeline input False

Specifies an alternate port on the SMTP server. The default value is 25, which is the default SMTP port. This parameter is available in Windows PowerShell 3.0 and newer releases.

-Priority <MailPriority>

  • Default value is None
  • Accepts pipeline input False

Specifies the priority of the email message. The acceptable values for this parameter are:

- Normal

- High

- Low

Normal is the default.

-SmtpServer <String>

  • Default value is None
  • Accepts pipeline input False

Specifies the name of the SMTP server that sends the email message.

The default value is the value of the $PSEmailServer preference variable. If the preference variable is not set and this parameter is omitted, the command fails.

-Subject <String>

  • This value is required
  • Default value is None
  • Accepts pipeline input False

Specifies the subject of the email message. This parameter is required.

-To <String[]>

  • This value is required
  • Default value is None
  • Accepts pipeline input False

Specifies the addresses to which the mail is sent. Enter names (optional) and the email address, such as Name <[email protected]>. This parameter is required.

-UseSsl [<SwitchParameter>]

  • Default value is False
  • Accepts pipeline input False

Indicates that the cmdlet uses the Secure Sockets Layer (SSL) protocol to establish a connection to the remote computer to send mail. By default, SSL is not used.

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer, PipelineVariable, and OutVariable.

Inputs
System.String
You can pipe the path and file names of attachments to Send-MailMessage .
Outputs
None
This cmdlet does not generate any output.
Examples
  1. Send an email from one user to another:
    PS C:\> Send-MailMessage -To "User01 <[email protected]>" -From "User02 <[email protected]>" -Subject "Test mail"
    

    This command sends an email message from User01 to User02.

    The mail message has a subject, which is required, but it does not have a body, which is optional. Also, because the SmtpServer parameter is not specified, Send-MailMessage uses the value of the $PSEmailServer preference variable for the SMTP server.

  2. Send an attachment:
    PS C:\> Send-MailMessage -From "User01 <[email protected]>" -To "User02 <[email protected]>", "User03 <[email protected]>" -Subject "Sending the Attachment" -Body "Forgot to send the attachment. Sending now." -Attachments "data.csv" -Priority High -dno onSuccess, onFailure -SmtpServer "smtp.fabrikam.com"
    

    This command sends an email message with an attachment from User01 to two other users.

    It specifies a priority value of High and requests a delivery notification by email when the email messages are delivered or when they fail.

  3. Send email to a mailing list:
    PS C:\> Send-MailMessage -To "User01 <[email protected]>" -From "ITGroup <[email protected]>" -Cc "User02 <[email protected]>" -bcc "ITMgr <[email protected]>" -Subject "Don't forget today's meeting!" -Credential domain01\admin01 -UseSsl
    

    This command sends an email message from User01 to the ITGroup mailing list with a copy (Cc) to User02 and a blind carbon copy (Bcc) to the IT manager (ITMgr).

    The command uses the credentials of a domain administrator and the UseSsl parameter.

Additional Notes
 
Back to PowerShell Command list