Send-MailMessage: E-Mails versenden mit PowerShell

Der Aufruf von Send-MailMessage erfolgt mit all jenen Parametern, die man von einem Mail-Client erwartet:

Send-MailMessage [-To] <string[]> [-Subject] <string> -From <string> [[-Body] <string>] [[-SmtpServer] <string>] [-Attachments <string[]>] [-Bcc <string[]>] [-BodyAsHtml] [-Cc <string[]>] [-Credential <PSCredential>] [-DeliveryNotificationOption {None | OnSuccess | OnFailure | Delay | Never}] [-Encoding <Encoding>] [-Priority {Normal | Low | High}] [-UseSsl] <CommonParameters>]

Meistens wird man jedoch zum einen nicht alle Angaben benötigen, zum anderen sie nicht samt und sonders als Parameter eingeben. Je nach Anwendungsfall kann der Inhalt der Mail beispielsweise aus einer Log-Datei stammen, die man mit Hilfe anderer PowerShell-Cmdlets analysiert, oder man bestimmt die Anhänge, indem man den Inhalt eines Verzeichnisses ausliest.

Minimal-Aufruf von Send-MailMessage

Ein einfacher Aufruf, der alle nötigen Angaben als Parameter übermittelt, könnte so aussehen:

Send-MailMessage -to "billg@contoso.com" -from "PowerShell <ps@fabrikam.de>" -Subject "Test" -body "Test für Send-MailMessage"

Damit dieser Befehl erfolgreich sein kann, muss man zuvor den SMTP-Server als Vorgabewert in der Variable $PSEmailServer gespeichert haben, also nach dem Muster

$PSEmailServer = "smtp.fabrikam.de"

Andernfalls ist es notwendig, dass man den Ausgangs-Server über den Parameter -SmtpServer bestimmt. Wenn man öfter Mails auf diesem Weg versendet, dann empfiehlt es sich, $PSEmailServer schon im PowerShell-Profil mit dem Standard-SMTP-Server vorzubelegen, so dass man sich die manuelle Eingabe sparen kann.

Interaktive Anmeldung am SMTP-Server

Das Cmdlet würde im obigen Beispiel versuchen, sich gegenüber dem SMTP-Server mit den Windows-Anmeldedaten des aktuellen Benutzers zu authentifizieren. Wenn das jedoch nicht möglich ist, dann muss man zusätzlich ein PSCredential-Objekt für die Anmeldung mitliefern (es sei denn, der SMTP-Server verlangt keine Authentifizierung).

Die einfachste Variante dafür ist, den Benutzernamen zusammen mit dem Parameter -Credential zu übergeben. PowerShell öffnet dann einen Anmeldedialog, in den man sein Passwort eintippen kann:

Send-MailMessage -to "billg@contoso.com" -from "PowerShell <ps@fabrikam.de>" -Subject "Test" -body "Test für Send-MailMessage" -Credential "MailUser"

Nach erfolgreicher Authentifizierung geht die Nachricht hinaus und die Aufgabe ist erledigt.

SMTP-Authentifizierung ohne Benutzereingriff

Diese interaktive Authentifizierung ist indes nicht ideal, wenn ein Script unter bestimmten Bedingungen selbständig Mails verschicken soll. Für diesen Fall muss man einen Weg finden, um die Anmeldung zu automatisieren.

Die in anderen Umgebungen praktizierte unsichere Methode, Passwörter an Send-MailMessage im Klartext zu übergeben, lässt PowerShell nicht zu. Andererseits ist es aber auch nicht möglich, PSCredential-Objekte komplett in einer Datei zu speichern, um sie von dort bei Bedarf einzulesen.

Aus diesem Grund muss man das erforderliche PSCredential-Objekt vor dem Versand einer Mail erzeugen, indem man dafür einen Benutzernamen angibt und das Passwort aus einer Datei einliest, in der man es zuvor verschlüsselt gespeichert hat. Letzteres lässt sich auf folgende Weise bewerkstelligen:

(Get-Credential).password | ConvertFrom-SecureString > MailPW.txt

Das Cmdlet Get-Credential fordert den Benutzer dazu auf, seinen Namen und sein Passwort einzugeben. Es erzeugt daraus ein PSCredential-Objekt, aus dem der obige Befehl dann wieder das Kennwort als SecureString extrahiert und dieses verschlüsselt in der Datei MailPW.txt abspeichert.

PSCredential-Objekt vor dem Mail-Versand erzeugen

Vor dem Aufruf von Send-MailMessage erzeugt man das erforderliche PSCredential-Objekt, indem man für den betreffenden User das Passwort aus dieser Datei ausliest und wieder zurück in einen SecureString verwandelt:

$pw = Get-Content .\MailPW.txt | ConvertTo-SecureString

$cred = New-Object System.Management.Automation.PSCredential "MailUser", $pw

Die Variable $cred kann man anschließend Send-MailMessage über den Parameter -Credential mitgeben, um den Benutzer zu authentifizieren:

Send-MailMessage -Credential $cred -to "billg@contoso.com" -from "PowerShell <ps@fabrikam.de>" -Subject "Test" -body "Test für Send-MailMessage"

Auch für diese Prozedur könnte man überlegen, ob man das PSCredential-Objekt bereits beim Start von PowerShell über das Profil anlegt.

Umlaute und Sonderzeichen bewahren

Eine dritte Hürde schließlich stellt der verwendete Zeichensatz dar. Lässt man den Parameter -Encoding weg, dann lautet die Voreinstellung auf ASCII. Enthält der Betreff oder die Nachricht Umlaute oder andere Sonderzeichen, dann kommen diese verstümmelt beim Empfänger an.

Daher wird man in der Regel UTF8 verwenden, um den Inhalt unbeschadet zu übertragen. Dies teilt man dem Cmdlet mit, indem man den Parameter

-encoding ([System.Text.Encoding]::UTF8)

hinzufügt.

Anhänge über eine Pipe einfügen

Möchte man Anhänge nicht als seine Liste von Dateinamen für den Parameter -Attachments eintippen, sondern beispielsweise aus dem Inhalt eines Verzeichnisses auslesen, dann kann man sie über eine Pipe an Send-MailMessage schicken:

Get-ChildItem f*.jpg | Send-MailMessage -Credential $cred -to "billg@contoso.com" -from "PowerShell <ps@fabrikam.de>" -Subject "Test" -body "Test für Send-MailMessage" -encoding ([System.Text.Encoding]::UTF8)

Send-MailMessage bietet noch einige weitere Optionen, wobei die hier gezeigten Beispiele die meisten Fälle abdecken sollten. Zu erwähnen wären vor allem noch -BodyAsHtml und -UseSSL, wenn die man eine HTML-Mail verschickt bzw. den SMTP-Server über eine SSL-Verbindung ansteuert.