Send-MailMessage

Синтаксис

All

Send-MailMessage
    [[-Body] <String>]
    [[-SmtpServer] <String>]
    [[-Subject] <String>]
    [-To] <String[]>
    -From <String>
    [-Attachments <String[]>]
    [-Bcc <String[]>]
    [-BodyAsHtml]
    [-Encoding <Encoding>]
    [-Cc <String[]>]
    [-DeliveryNotificationOption <DeliveryNotificationOptions>]
    [-Priority <MailPriority>]
    [-ReplyTo <String[]>]
    [-Credential <PSCredential>]
    [-UseSsl]
    [-Port <Int32>]
    [<CommonParameters>]

Описание

Примеры

Example 1: Send an email from one person to another person

$sendMailMessageSplat = @{
    From = 'User01 <[email protected]>'
    To = 'User02 <[email protected]>'
    Subject = 'Test mail'
}
Send-MailMessage @sendMailMessageSplat

Example 2: Send an attachment

$sendMailMessageSplat = @{
    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'
    DeliveryNotificationOption = 'OnSuccess', 'OnFailure'
    SmtpServer = 'smtp.fabrikam.com'
}
Send-MailMessage @sendMailMessageSplat

Example 3: Send email to a mailing list

$sendMailMessageSplat = @{
    From = 'User01 <[email protected]>'
    To = 'ITGroup <[email protected]>'
    Cc = 'User02 <[email protected]>'
    Bcc = 'ITMgr <[email protected]>'
    Subject = "Don't forget today's meeting!"
    Credential = 'domain01\admin01'
    UseSsl = $true
}
Send-MailMessage @sendMailMessageSplat

Параметры

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

Свойства параметра

Наборы параметров

-Bcc

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

Свойства параметра

Наборы параметров

-Body

Specifies the content of the email message.

Свойства параметра

Наборы параметров

-BodyAsHtml

Specifies that the value of the Body parameter contains HTML.

Свойства параметра

Наборы параметров

-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 <[email protected]>.

Свойства параметра

Наборы параметров

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

Credentials are stored in a PSCredential object and the password is stored as a SecureString.

Свойства параметра

Наборы параметров

-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 to the address in the From parameter.

The acceptable values for this parameter are as follows:

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

These values are defined as a flag-based enumeration. You can combine multiple values together to set multiple flags using this parameter. The values can be passed to the DeliveryNotification parameter as an array of values or as a comma-separated string of those values. The cmdlet will combine the values using a binary-OR operation. Passing values as an array is the simplest option and also allows you to use tab-completion on the values.

Свойства параметра

Наборы параметров

-Encoding

Specifies the type of encoding for the target file. The default value is utf8NoBOM.

The acceptable values for this parameter are as follows:

• ascii: Uses the encoding for the ASCII (7-bit) character set.
• ansi: Uses the encoding for the for the current culture's ANSI code page. This option was added in PowerShell 7.4.
• bigendianunicode: Encodes in UTF-16 format using the big-endian byte order.
• bigendianutf32: Encodes in UTF-32 format using the big-endian byte order.
• oem: Uses the default encoding for MS-DOS and console programs.
• unicode: Encodes in UTF-16 format using the little-endian byte order.
• utf7: Encodes in UTF-7 format.
• utf8: Encodes in UTF-8 format.
• utf8BOM: Encodes in UTF-8 format with Byte Order Mark (BOM)
• utf8NoBOM: Encodes in UTF-8 format without Byte Order Mark (BOM)
• utf32: Encodes in UTF-32 format.

Beginning with PowerShell 6.2, the Encoding parameter also allows numeric IDs of registered code pages (like -Encoding 1251) or string names of registered code pages (like -Encoding "windows-1251"). For more information, see the .NET documentation for Encoding.CodePage.

Starting with PowerShell 7.4, you can use the Ansi value for the Encoding parameter to pass the numeric ID for the current culture's ANSI code page without having to specify it manually.

Свойства параметра

Наборы параметров

-From

The From parameter is required. This parameter specifies the sender's email address. Enter a name (optional) and email address, such as Name <[email protected]>.

Свойства параметра

Наборы параметров

-Port

Specifies an alternate port on the SMTP server. The default value is 25, which is the default SMTP port.

Свойства параметра

Наборы параметров

-Priority

Specifies the priority of the email message. Normal is the default. The acceptable values for this parameter are Normal, High, and Low.

Свойства параметра

Наборы параметров

-ReplyTo

Specifies additional email addresses (other than the From address) to use to reply to this message. Enter names (optional) and the email address, such as Name <[email protected]>.

This parameter was introduced in PowerShell 6.2.

Свойства параметра

Наборы параметров

-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 isn't set and this parameter isn't used, the Send-MailMessage command fails.

Свойства параметра

Наборы параметров

-Subject

The Subject parameter isn't required. This parameter specifies the subject of the email message.

Свойства параметра

Наборы параметров

-To

The To parameter is required. This parameter specifies the recipient's email address. Enter names (optional) and the email address, such as Name <[email protected]>.

Свойства параметра

Наборы параметров

-UseSsl

The Secure Sockets Layer (SSL) protocol is used to establish a secure connection to the remote computer to send mail. By default, SSL isn't used.

Свойства параметра

Наборы параметров

CommonParameters

Входные данные

String

Выходные данные

None

Примечания

Связанные ссылки

• about_Preference_Variables
• Get-Credential