tibi-starter/docs/md/server-javascript-kontext/packages/smtp.md

1.4 KiB

smtp

Das Smtp-Paket ermöglicht das Senden von E-Mails. Es stellt eine sendMail Methode zur Verfügung, die eine E-Mail an einen oder mehrere Empfänger sendet. Die Methode nimmt eine Reihe von Parametern, einschließlich des SMTP-Hosts, des Benutzernamens und Passworts für die Authentifizierung, der Empfängeradressen, des Betreffs, des Absenders und der Nachricht, sowie optionaler Anhänge, entgegen. Das SmtpPackage-Interface bietet Funktionen zum Senden von E-Mails. Es enthält die folgende Methode:

  • sendMail(options: {}): void: Diese Methode nimmt eine Reihe von Optionen für das Senden einer E-Mail entgegen und sendet die E-Mail entsprechend diesen Optionen. Die Optionen können den SMTP-Host, den Benutzernamen und das Passwort für die Authentifizierung, die Empfänger, den Betreff, den Absender und den Inhalt der E-Mail sowie optionale Anhänge steuern.
interface SmtpPackage {
    /**
     * send an email
     *
     * @param options email options map
     */
    sendMail(options: {
        host?: string
        username?: string
        password?: string
        to: string | string[]
        cc?: string | string[]
        bcc?: string | string[]
        subject?: string
        from: string
        fromName?: string
        replyTo?: string
        plain?: string
        html?: string
        attach?: string | string[]
    }): void
}