Freigeben über

Send-MailMessage

  • Referenz
Modul:
Microsoft.PowerShell.Utility

Sendet eine E-Mail-Nachricht.

Syntax

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

Beschreibung

Das Cmdlet Send-MailMessage sendet eine E-Mail-Nachricht aus PowerShell.

Sie müssen einen SMTP-Server (Simple Mail Transfer Protocol) angeben, oder der Befehl Send-MailMessage schlägt fehl. Verwenden Sie den SmtpServer Parameter, oder legen Sie die $PSEmailServer Variable auf einen gültigen SMTP-Server fest. Der wert, der $PSEmailServer zugewiesen ist, ist die Standard-SMTP-Einstellung für PowerShell. Weitere Informationen finden Sie unter about_Preference_Variables.

Warnung

Das Cmdlet Send-MailMessage ist veraltet. Dieses Cmdlet garantiert keine sicheren Verbindungen mit SMTP-Servern. Es ist zwar kein sofortiger Ersatz in PowerShell verfügbar, es wird jedoch empfohlen, Send-MailMessagenicht zu verwenden. Weitere Informationen finden Sie unter Plattformkompatibilitätshinweis DE0005.

Beispiele

Beispiel 1: Senden einer E-Mail von einer Person an eine andere Person

In diesem Beispiel wird eine E-Mail-Nachricht von einer Person an eine andere Person gesendet.

Die Parameter From, Tound Subject Parameter sind von Send-MailMessageerforderlich. In diesem Beispiel wird die Standardvariable $PSEmailServer für den SMTP-Server verwendet, sodass der parameter SmtpServer nicht benötigt wird.

$sendMailMessageSplat = @{
    From = 'User01 <user01@fabrikam.com>'
    To = 'User02 <user02@fabrikam.com>'
    Subject = 'Test mail'
}
Send-MailMessage @sendMailMessageSplat

Das Cmdlet Send-MailMessage verwendet den Parameter From, um den Absender der Nachricht anzugeben. Der Parameter To gibt den Empfänger der Nachricht an. Der parameter Subject verwendet die Textzeichenfolge Test mail als Nachricht, da der optionale Body Parameter nicht enthalten ist.

Beispiel 2: Senden einer Anlage

In diesem Beispiel wird eine E-Mail-Nachricht mit einer Anlage gesendet.

$sendMailMessageSplat = @{
    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 @sendMailMessageSplat

Das Cmdlet Send-MailMessage verwendet den Parameter From, um den Absender der Nachricht anzugeben. Der Parameter To gibt die Empfänger der Nachricht an. Der Parameter Subject beschreibt den Inhalt der Nachricht. Der parameter Body ist der Inhalt der Nachricht.

Der parameter Attachments gibt die Datei im aktuellen Verzeichnis an, das an die E-Mail-Nachricht angefügt ist. Der Parameter Priority legt die Nachricht auf High Priorität fest. Der parameter DeliveryNotificationOption gibt zwei Werte an, OnSuccess und OnFailure. Der Absender erhält E-Mail-Benachrichtigungen, um den Erfolg oder Fehler der Nachrichtenübermittlung zu bestätigen. Der parameter SmtpServer legt den SMTP-Server auf smtp.fabrikam.comfest.

Beispiel 3: Senden von E-Mails an eine Adressenliste

In diesem Beispiel wird eine E-Mail-Nachricht an eine Adressenliste gesendet.

$sendMailMessageSplat = @{
    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 = $true
}
Send-MailMessage @sendMailMessageSplat

Das Cmdlet Send-MailMessage verwendet den Parameter From, um den Absender der Nachricht anzugeben. Der Parameter To gibt die Empfänger der Nachricht an. Der parameter Cc sendet eine Kopie der Nachricht an den angegebenen Empfänger. Der Bcc Parameter sendet eine Blindkopie der Nachricht. Eine Blindkopie ist eine E-Mail-Adresse, die von den anderen Empfängern ausgeblendet ist. Der parameter Subject ist die Meldung, da der optionale Body Parameter nicht enthalten ist.

Der Parameter Anmeldeinformationen gibt an, dass die Anmeldeinformationen eines Domänenadministrators zum Senden der Nachricht verwendet werden. Der parameter UseSsl gibt an, dass Secure Socket Layer (SSL) eine sichere Verbindung erstellt.

Parameter

-Attachments

Gibt den Pfad und Dateinamen von Dateien an, die an die E-Mail-Nachricht angefügt werden sollen. Sie können diesen Parameter verwenden oder die Pfade und Dateinamen an Send-MailMessageübergeben.

Typ:String[]
Aliase:PsPath
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-Bcc

Gibt die E-Mail-Adressen an, die eine Kopie der E-Mail erhalten, aber nicht als Empfänger der Nachricht aufgeführt sind. Geben Sie Namen (optional) und die E-Mail-Adresse ein, z. B. Name <someone@fabrikam.com>.

Typ:String[]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Body

Gibt den Inhalt der E-Mail-Nachricht an.

Typ:String
Position:2
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-BodyAsHtml

Gibt an, dass der Wert des Body--Parameters HTML enthält.

Typ:SwitchParameter
Aliase:BAH
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Cc

Gibt die E-Mail-Adressen an, an die eine Kopie (CC) der E-Mail-Nachricht gesendet wird. Geben Sie Namen (optional) und die E-Mail-Adresse ein, z. B. Name <someone@fabrikam.com>.

Typ:String[]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Credential

Gibt ein Benutzerkonto an, das über die Berechtigung zum Ausführen dieser Aktion verfügt. Die Standardeinstellung ist der aktuelle Benutzer.

Geben Sie einen Benutzernamen ein, z. B. User01 oder Domäne01\User01. Oder geben Sie ein PSCredential--Objekt ein, z. B. ein Objekt aus dem Cmdlet Get-Credential.

Anmeldeinformationen werden in einem PSCredential-Objekt gespeichert, und das Kennwort wird als SecureString-gespeichert.

Anmerkung

Weitere Informationen zu SecureString Datenschutz finden Sie unter Wie sicher ist SecureString?.

Typ:PSCredential
Position:Named
Standardwert:Current user
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-DeliveryNotificationOption

Gibt die Zustellungsbenachrichtigungsoptionen für die E-Mail-Nachricht an. Sie können mehrere Werte angeben. Keine ist der Standardwert. Der Alias für diesen Parameter ist DNO-.

Die Zustellungsbenachrichtigungen werden an die Adresse im Parameter From gesendet.

Die zulässigen Werte für diesen Parameter sind wie folgt:

  • None: Keine Benachrichtigung.
  • OnSuccess: Benachrichtigen Sie, ob die Übermittlung erfolgreich ist.
  • OnFailure: Benachrichtigen, wenn die Übermittlung nicht erfolgreich ist.
  • Delay: Benachrichtigen, wenn die Zustellung verzögert wird.
  • Never: Nie benachrichtigen.

Diese Werte werden als flagbasierte Enumeration definiert. Sie können mehrere Werte kombinieren, um mehrere Flags mithilfe dieses Parameters festzulegen. Die Werte können an den DeliveryNotification Parameter als Array von Werten oder als kommagetrennte Zeichenfolge dieser Werte übergeben werden. Das Cmdlet kombiniert die Werte mithilfe eines Binary-OR-Vorgangs. Das Übergeben von Werten als Array ist die einfachste Option und ermöglicht ihnen auch die Verwendung des Tabstopps für die Werte.

Typ:DeliveryNotificationOptions
Aliase:DNO
Zulässige Werte:None, OnSuccess, OnFailure, Delay, Never
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Encoding

Gibt den Typ der Codierung für die Zieldatei an. Der Standardwert ist Default.

Die zulässigen Werte für diesen Parameter sind wie folgt:

  • ASCII Verwendet ASCII-Zeichensatz (7-Bit).
  • BigEndianUnicode verwendet UTF-16 mit der Big-End-Byte-Reihenfolge.
  • Default Verwendet die Codierung, die der aktiven Codepage des Systems entspricht (in der Regel ANSI).
  • OEM Verwendet die Codierung, die der aktuellen OEM-Codeseite des Systems entspricht.
  • Unicode verwendet UTF-16 mit der Little-Endian Byte-Reihenfolge.
  • UTF7 verwendet UTF-7.
  • UTF8 verwendet UTF-8.
  • UTF32 verwendet UTF-32 mit der Little-End-Byte-Reihenfolge.
Typ:Encoding
Aliase:BE
Zulässige Werte:ASCII, BigEndianUnicode, Default, OEM, Unicode, UTF7, UTF8, UTF32
Position:Named
Standardwert:Default
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-From

Der parameter From ist erforderlich. Dieser Parameter gibt die E-Mail-Adresse des Absenders an. Geben Sie einen Namen (optional) und eine E-Mail-Adresse ein, z. B. Name <someone@fabrikam.com>.

Typ:String
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Port

Gibt einen alternativen Port auf dem SMTP-Server an. Der Standardwert ist 25, bei dem es sich um den standardmäßigen SMTP-Port handelt.

Typ:Int32
Position:Named
Standardwert:25
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Priority

Gibt die Priorität der E-Mail-Nachricht an. Normal ist die Standardeinstellung. Die zulässigen Werte für diesen Parameter sind "Normal", "Hoch" und "Niedrig".

Typ:MailPriority
Zulässige Werte:Normal, High, Low
Position:Named
Standardwert:Normal
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-SmtpServer

Gibt den Namen des SMTP-Servers an, der die E-Mail-Nachricht sendet.

Der Standardwert ist der Wert der $PSEmailServer Einstellungsvariable. Wenn die Einstellungsvariable nicht festgelegt ist und dieser Parameter nicht verwendet wird, schlägt der Befehl Send-MailMessage fehl.

Typ:String
Aliase:ComputerName
Position:3
Standardwert:$PSEmailServer
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Subject

Der parameter Subject ist nicht erforderlich. Dieser Parameter gibt den Betreff der E-Mail-Nachricht an.

Typ:String
Aliase:sub
Position:1
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-To

Der parameter To ist erforderlich. Dieser Parameter gibt die E-Mail-Adresse des Empfängers an. Geben Sie Namen (optional) und die E-Mail-Adresse ein, z. B. Name <someone@fabrikam.com>.

Typ:String[]
Position:0
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-UseSsl

Das SSL-Protokoll (Secure Sockets Layer) wird verwendet, um eine sichere Verbindung mit dem Remotecomputer herzustellen, um E-Mails zu senden. Standardmäßig wird SSL nicht verwendet.

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

Eingaben

String

Sie können den Pfad und dateinamen von Anlagen an dieses Cmdlet weiterleiten.

Ausgaben

None

Dieses Cmdlet gibt keine Ausgabe zurück.

Hinweise

Das Cmdlet Send-MailMessage ist veraltet. Weitere Informationen finden Sie unter Plattformkompatibilitätshinweis DE0005. Dieses Cmdlet garantiert keine sicheren Verbindungen mit SMTP-Servern.

DE0005 schlägt vor, die Verwendung der Drittanbieterbibliothek MailKit-. Wenn Sie Exchange Online verwenden, können Sie die Send-MgUserMail- aus dem Microsoft Graph PowerShell SDK verwenden.