Send-MailMessage

Eine E-Mail sendet.

Syntax

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

Beschreibung

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

Sie müssen einen SMTP-Server (Simple Mail Transfer Protocol) angeben, oder der Send-MailMessage Befehl schlägt fehl. Verwenden Sie den SmtpServer-Parameter , oder legen Sie die $PSEmailServer Variable auf einen gültigen SMTP-Server fest. Der zugewiesene $PSEmailServer Wert 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, die Verwendung nicht zu verwenden Send-MailMessage. 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", "To" und "Subject" sind erforderlich.Send-MailMessage In diesem Beispiel wird die Standardvariable $PSEmailServer für den SMTP-Server verwendet, sodass der SmtpServer-Parameter nicht benötigt wird.

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

Das Send-MailMessage Cmdlet 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-E-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 Send-MailMessage Cmdlet 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 OnSuccess und OnFailure. Der Absender erhält E-Mail-Benachrichtigungen, um den Erfolg oder Fehler der Nachrichtenübermittlung zu bestätigen. Der SmtpServer-Parameter legt den SMTP-Server auf smtp.fabrikam.com.

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 Send-MailMessage Cmdlet 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 Nachricht, da der optionale Body-Parameter nicht enthalten ist.

Der Parameter "Credential " gibt die Anmeldeinformationen eines Domänenadministrators an, die zum Senden der Nachricht verwendet werden. Der Parameter UseSsl gibt an, dass Ssl (Secure Socket Layer) 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-MailMessagedie Datei übergeben.

Typ:String[]
Aliases:PsPath
Position:Named
Standardwert:None
Erforderlich:False
Accept pipeline input:True
Accept wildcard characters: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 Name <someone@fabrikam.com>. B. .

Typ:String[]
Position:Named
Standardwert:None
Erforderlich:False
Accept pipeline input:True
Accept wildcard characters:False

-Body

Gibt den Inhalt der E-Mail-Nachricht an.

Typ:String
Position:2
Standardwert:None
Erforderlich:False
Accept pipeline input:True
Accept wildcard characters:False

-BodyAsHtml

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

Typ:SwitchParameter
Aliases:BAH
Position:Named
Standardwert:None
Erforderlich:False
Accept pipeline input:True
Accept wildcard characters: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 Name <someone@fabrikam.com>. B. .

Typ:String[]
Position:Named
Standardwert:None
Erforderlich:False
Accept pipeline input:True
Accept wildcard characters:False

-Credential

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

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

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

Hinweis

Weitere Informationen zum Schutz von SecureString finden Sie unter "Wie sicher ist SecureString?".

Typ:PSCredential
Position:Named
Standardwert:Current user
Erforderlich:False
Accept pipeline input:True
Accept wildcard characters:False

-DeliveryNotificationOption

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

Die Übermittlungsbenachrichtigungen werden an die Adresse im Parameter "From" gesendet.

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

  • None: Keine Benachrichtigung.
  • OnSuccess: Benachrichtigen, wenn 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 als Array von Werten oder als kommagetrennte Zeichenfolge dieser Werte an den DeliveryNotification-Parameter ü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
Aliases:DNO
Zulässige Werte:None, OnSuccess, OnFailure, Delay, Never
Position:Named
Standardwert:None
Erforderlich:False
Accept pipeline input:True
Accept wildcard characters:False

-Encoding

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

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

  • ascii: Verwendet die Codierung für den ASCII-Zeichensatz (7-Bit).
  • ansi: Verwendet die Codierung für die ANSI-Codeseite der aktuellen Kultur. Diese Option wurde in PowerShell 7.4 hinzugefügt.
  • bigendianunicode: Codiert im UTF-16-Format mit der Big-End-Byte-Reihenfolge.
  • bigendianutf32: Codiert im UTF-32-Format mithilfe der Big-End-Byte-Reihenfolge.
  • oem: Verwendet die Standardcodierung für MS-DOS- und Konsolenprogramme.
  • unicode: Codiert im UTF-16-Format mithilfe der Little-Endian-Bytereihenfolge.
  • utf7: Codiert im UTF-7-Format.
  • utf8: Codiert im UTF-8-Format.
  • utf8BOM: Codiert im UTF-8-Format mit Bytereihenfolgezeichen (BOM)
  • utf8NoBOM: Codiert im UTF-8-Format ohne Byte Order Mark (BOM)
  • utf32: Codiert im UTF-32-Format.

Ab PowerShell 6.2 ermöglicht der Encoding-Parameter auch numerische IDs registrierter Codeseiten (z -Encoding 1251. B. ) oder Zeichenfolgennamen registrierter Codeseiten (z -Encoding "windows-1251". B. ). Weitere Informationen finden Sie in der .NET-Dokumentation für Encoding.CodePage.

Ab PowerShell 7.4 können Sie den Ansi Wert für den Codierungsparameter verwenden, um die numerische ID für die ANSI-Codeseite der aktuellen Kultur zu übergeben, ohne sie manuell angeben zu müssen.

Hinweis

UTF-7* wird nicht mehr empfohlen, zu verwenden. Ab PowerShell 7.1 wird eine Warnung geschrieben, wenn Sie für den Codierungsparameter angebenutf7.

Typ:Encoding
Aliases:BE
Zulässige Werte:ASCII, BigEndianUnicode, BigEndianUTF32, OEM, Unicode, UTF7, UTF8, UTF8BOM, UTF8NoBOM, UTF32
Position:Named
Standardwert:ASCII
Erforderlich:False
Accept pipeline input:True
Accept wildcard characters: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 Name <someone@fabrikam.com>. B. .

Typ:String
Position:Named
Standardwert:None
Erforderlich:True
Accept pipeline input:True
Accept wildcard characters:False

-Port

Gibt einen alternativen Port auf dem SMTP-Server an. Der Standardwert ist 25, wobei es sich um den SMTP-Standardport handelt.

Typ:Int32
Position:Named
Standardwert:25
Erforderlich:False
Accept pipeline input:True
Accept wildcard characters:False

-Priority

Gibt die Priorität der E-Mail-Nachricht an. Der Standardwert ist „Normal“. 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
Accept pipeline input:True
Accept wildcard characters:False

-ReplyTo

Gibt weitere E-Mail-Adressen (außer der Absenderadresse) an, die zum Beantworten dieser Nachricht verwendet werden sollen. Geben Sie Namen (optional) und die E-Mail-Adresse ein, z Name <someone@fabrikam.com>. B. .

Dieser Parameter wurde in PowerShell 6.2 eingeführt.

Typ:String[]
Position:Named
Standardwert:None
Erforderlich:False
Accept pipeline input:True
Accept wildcard characters: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 Send-MailMessage Befehl fehl.

Typ:String
Aliases:ComputerName
Position:3
Standardwert:$PSEmailServer
Erforderlich:False
Accept pipeline input:True
Accept wildcard characters:False

-Subject

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

Typ:String
Aliases:sub
Position:1
Standardwert:None
Erforderlich:False
Accept pipeline input:True
Accept wildcard characters:False

-To

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

Typ:String[]
Position:0
Standardwert:None
Erforderlich:True
Accept pipeline input:True
Accept wildcard characters: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
Accept pipeline input:True
Accept wildcard characters: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 Drittanbieterbibliothek MailKit zu verwenden. Wenn Sie Exchange Online verwenden, können Sie das Send-MgUserMail aus dem Microsoft Graph PowerShell SDK verwenden.