Поделиться через

Send-MailMessage

  • Ссылка
Модуль:
Microsoft.PowerShell.Utility

Отправляет сообщение электронной почты.

Синтаксис

Send-MailMessage
    [-To] <string[]>
    [-Subject] <string>
    [[-Body] <string>]
    [[-SmtpServer] <string>]
    -From <string>
    [-Attachments <string[]>]
    [-Bcc <string[]>]
    [-BodyAsHtml]
    [-Encoding <Encoding>]
    [-Cc <string[]>]
    [-DeliveryNotificationOption <DeliveryNotificationOptions>]
    [-Priority <MailPriority>]
    [-Credential <pscredential>]
    [-UseSsl]
    [-Port <int>]
    [<CommonParameters>]

Описание

Командлет Send-MailMessage отправляет сообщение электронной почты из PowerShell.

Необходимо указать сервер протокола SMTP или сбой команды Send-MailMessage. Используйте параметр smtpServer или задайте для переменной допустимый SMTP-сервер. Значение, назначенное $PSEmailServer, является параметром SMTP по умолчанию для PowerShell. Дополнительные сведения см. в about_Preference_Variables.

Примеры

Пример 1. Отправка сообщения электронной почты от одного человека другому пользователю

В этом примере отправляется сообщение электронной почты от одного человека другому пользователю.

Параметры from, Toи Subject требуются Send-MailMessage. В этом примере используется переменная по умолчанию для SMTP-сервера, поэтому параметр smtpServer не нужен.

Send-MailMessage -From 'User01 <user01@fabrikam.com>' -To 'User02 <user02@fabrikam.com>' -Subject 'Test mail'

Командлет Send-MailMessage использует параметр From для указания отправителя сообщения. Параметр To указывает получателя сообщения. Параметр subject использует текстовую строку тестовой почты в качестве сообщения, так как необязательный параметр текста не включен.

Пример 2. Отправка вложения

В этом примере отправляется сообщение электронной почты с вложением.

Send-MailMessage -From 'User01 <user01@fabrikam.com>' -To 'User02 <user02@fabrikam.com>', 'User03 <user03@fabrikam.com>' -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 использует параметр From для указания отправителя сообщения. Параметр To указывает получателей сообщения. Параметр Subject описывает содержимое сообщения. Параметр body — это содержимое сообщения.

Параметр вложения указывает файл в текущем каталоге, присоединенном к сообщению электронной почты. Параметр приоритета задает для сообщения значение высокий приоритет. Параметр -DeliveryNotificationOption указывает два значения, OnSuccess и OnFailure. Отправитель получит уведомления по электронной почте, чтобы подтвердить успешность или сбой доставки сообщения. Параметр smtpServer задает SMTP-сервер smtp.fabrikam.com.

Пример 3. Отправка электронной почты в список рассылки

В этом примере отправляется сообщение электронной почты в список рассылки.

Send-MailMessage -From 'User01 <user01@fabrikam.com>' -To 'ITGroup <itdept@fabrikam.com>' -Cc 'User02 <user02@fabrikam.com>' -Bcc 'ITMgr <itmgr@fabrikam.com>' -Subject "Don't forget today's meeting!" -Credential domain01\admin01 -UseSsl

Командлет Send-MailMessage использует параметр From для указания отправителя сообщения. Параметр To указывает получателей сообщения. Параметр Cc отправляет копию сообщения указанному получателю. Параметр Bcc отправляет слепую копию сообщения. Слепая копия — это адрес электронной почты, скрытый от других получателей. Параметр субъекта является сообщением, так как необязательный параметр body не включен.

Параметр учетных данных указывает учетные данные администратора домена для отправки сообщения. Параметр UseSsl указывает, что протокол SSL создает безопасное подключение.

Параметры

-Attachments

Указывает путь и имена файлов, которые должны быть присоединены к сообщению электронной почты. Этот параметр можно использовать или передать пути и имена файлов для Send-MailMessage.

Тип:String[]
Aliases:PsPath
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-Bcc

Указывает адреса электронной почты, которые получают копию сообщения, но не указаны в качестве получателей сообщения. Введите имена (необязательно) и адрес электронной почты, например Name <someone@fabrikam.com>.

Тип:String[]
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Body

Указывает содержимое сообщения электронной почты.

Тип:String
Position:2
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-BodyAsHtml

Указывает, что значение параметра body содержит HTML.

Тип:SwitchParameter
Aliases:BAH
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Cc

Указывает адреса электронной почты, на которые отправляется копия углерода (CC) сообщения электронной почты. Введите имена (необязательно) и адрес электронной почты, например Name <someone@fabrikam.com>.

Тип:String[]
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Credential

Указывает учетную запись пользователя, которая имеет разрешение на выполнение этого действия. По умолчанию используется текущий пользователь.

Введите имя пользователя, например User01 или Domain01\User01. Или введите объект PSCredential, например один из командлета Get-Credential.

Тип:PSCredential
Position:Named
Default value:Current user
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-DeliveryNotificationOption

Задает параметры уведомления о доставке сообщения электронной почты. Можно указать несколько значений. Значение по умолчанию отсутствует. Псевдоним этого параметра — DNO.

Уведомления о доставке отправляются по адресу в параметре From.

Допустимые значения для этого параметра приведены следующим образом:

  • Нет: нет уведомлений.
  • OnSuccess: сообщите об успешной доставке.
  • OnFailure: уведомлять о неудачной доставке.
  • задержка: уведомлять о задержке доставки.
  • никогда не: никогда не уведомлять.
Тип:DeliveryNotificationOptions
Aliases:DNO
Допустимые значения:None, OnSuccess, OnFailure, Delay, Never
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Encoding

Указывает тип кодирования для целевого файла. Значение по умолчанию — по умолчанию.

Допустимые значения для этого параметра приведены следующим образом:

  • ASCII использует набор символов ASCII (7-разрядный).
  • BigEndianUnicode использует UTF-16 с порядком байтов больших байтов.
  • по умолчанию использует кодировку, соответствующую активной кодовой странице системы (обычно ANSI).
  • OEM использует кодировку, соответствующую текущей кодовой странице OEM системы.
  • Юникод использует UTF-16 с маленьким порядком байтов.
  • UTF7 использует UTF-7.
  • UTF8 использует UTF-8.
  • UTF32 использует UTF-32 с маленьким порядком байтов.
Тип:Encoding
Aliases:BE
Допустимые значения:ASCII, BigEndianUnicode, Default, OEM, Unicode, UTF7, UTF8, UTF32
Position:Named
Default value:Default
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-From

Требуется параметр From. Этот параметр задает адрес электронной почты отправителя. Введите имя (необязательно) и адрес электронной почты, например Name <someone@fabrikam.com>.

Тип:String
Position:Named
Default value:None
Обязательно:True
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Port

Указывает альтернативный порт на SMTP-сервере. Значение по умолчанию — 25, которое является портом SMTP по умолчанию.

Тип:Int32
Position:Named
Default value:25
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Priority

Указывает приоритет сообщения электронной почты. Обычный — это значение по умолчанию. Допустимые значения этого параметра: "Обычный", "Высокий" и "Низкий".

Тип:MailPriority
Допустимые значения:Normal, High, Low
Position:Named
Default value:Normal
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-SmtpServer

Указывает имя SMTP-сервера, отправляющего сообщение электронной почты.

Значение по умолчанию — это значение переменной предпочтения $PSEmailServer. Если переменная предпочтения не задана и этот параметр не используется, команда Send-MailMessage завершается ошибкой.

Тип:String
Aliases:ComputerName
Position:3
Default value:$PSEmailServer
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Subject

Требуется параметр субъекта . Этот параметр задает тему сообщения электронной почты.

Тип:String
Aliases:sub
Position:1
Default value:None
Обязательно:True
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-To

Требуется параметр To. Этот параметр задает адрес электронной почты получателя. Если несколько получателей, разделите их адреса запятой (,). Введите имена (необязательно) и адрес электронной почты, например Name <someone@fabrikam.com>.

Тип:String[]
Position:0
Default value:None
Обязательно:True
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-UseSsl

Протокол SSL используется для установления безопасного подключения к удаленному компьютеру для отправки почты. По умолчанию SSL не используется.

Тип:SwitchParameter
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

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

String

Путь и имена файлов можно передать в Send-MailMessage.

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

None

Этот командлет не создает выходные данные.