Windows PowerShell command on Get-command Send-MailMessage

NAME

Send-MailMessage

SYNOPSIS

Sends an email message.

SYNTAX

Send-MailMessage [-To] [-Subject] [[-Body] ] [[-SmtpServer] ] [-Attachments

] [-Bcc ] [-BodyAsHtml] [-Cc ] [-Credential ]

[-DeliveryNotificationOption {None | OnSuccess | OnFailure | Delay | Never}] [-Encoding ] -From

[-Port ] [-Priority {Normal | Low | High}] [-UseSsl] []

DESCRIPTION

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

PARAMETERS

-Attachments

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 .

Required? false Position? named Default value None Accept pipeline input? True (ByValue) Accept wildcard characters? false

-Bcc

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 .

Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false

-Body

Specifies the body of the email message. Required? false Position? 2 Default value None Accept pipeline input? False Accept wildcard characters? false

-BodyAsHtml []

Indicates that the value of the Body parameter contains HTML. Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false

-Cc

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 .

Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false

-Credential

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.

Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false

-DeliveryNotificationOption

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.

Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false

-Encoding

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. Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false

-From

Specifies the address from which the mail is sent. Enter a name (optional) and email address, such as Name

. This parameter is required. Required? true Position? named Default value None Accept pipeline input? False Accept wildcard characters? false

-Port

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. Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false

-Priority

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

- Normal

- High

- Low

Normal is the default. Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false

-SmtpServer

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. Required? false Position? 3 Default value None Accept pipeline input? False Accept wildcard characters? false

-Subject

Specifies the subject of the email message. This parameter is required. Required? true Position? 1 Default value None Accept pipeline input? False Accept wildcard characters? false

-To

Specifies the addresses to which the mail is sent. Enter names (optional) and the email address, such as Name

. This parameter is required. Required? true Position? 0 Default value None Accept pipeline input? False Accept wildcard characters? false

-UseSsl []

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. Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).

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.

NOTES

Example 1: Send an email from one user to another

PS C:\>Send-MailMessage -To "User01 " -From "User02 " -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.

Example 2: Send an attachment

PS C:\>Send-MailMessage -From "User01 " -To "User02 ", "User03

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

Example 3: Send email to a mailing list

PS C:\>Send-MailMessage -To "User01 " -From "ITGroup " -Cc "User02

" -bcc "ITMgr " -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.