Mail - Programmschnittstelle (API)

Mail – eMail-Versand

	mail.add_file( path, filename_for_mail, content_type, enconding )	Fügt einen Anhang hinzu

	mail.add_header_field( field_name, value )	Fügt dem eMail-Kopf ein Feld hinzu

	mail.bcc = String	Unsichtbarer Empfänger einer Kopie der Nachricht, blind carbon copy
String	mail.bcc

	mail.body = String	Inhalt der Nachricht
String	mail.body

	mail.cc = String	Empfänger einer Kopie der Nachricht, carbon copy
String	mail.cc

Integer	mail.dequeue()	Nachrichten aus dem Verzeichnis `queue_dir` erneut versuchen zu versenden

String	mail.dequeue_log	Protokoll von `dequeue()`

	mail.from = String	Absender
String	mail.from

	mail.queue_dir = path	Verzeichnis der nicht versendbaren eMails
String	mail.queue_dir

	mail.smtp = String	Name des SMTP-Servers
String	mail.smtp

	mail.subject = String	Betreff
String	mail.subject

	mail.to = String	Empfänger
String	mail.to

Xslt_stylesheet	mail.xslt_stylesheet	XSLT-Stylesheet für eMail-Aufbereitung

	mail.xslt_stylesheet_path = path	XSLT-Stylesheet für eMail-Aufbereitung

Siehe Log.mail.

add_file

Fügt einen Anhang hinzu

mail.add_file( String path, String filename_for_mail (optional), String content_type (optional), String enconding (optional) )

Beispiel in javascript

spooler_log.mail.add_file( "c:/tmp/1.txt", "1.txt", "text/plain", "quoted-printable" );

Parameter

path	Pfadname der anzuhängenden Datei
filename_for_mail (optional)	Dateiname, der in der Nachricht erscheinen soll
content_type (optional)	`"text/plain"` ist voreingestellt.
enconding (optional)	Z.B. `"quoted-printable"`

add_header_field

Fügt dem eMail-Kopf ein Feld hinzu

mail.add_header_field( String field_name, String value )

Parameter

field_name
value

bcc

Unsichtbarer Empfänger einer Kopie der Nachricht, blind carbon copy

	mail.bcc = String
String	mail.bcc

Beispiel in javascript

spooler_log.mail.bcc = "hans@company.com";

Wenn die Hostware zum eMail-Versand JavaMail verwendet, können Sie mehrere Adressen durch Komma getrennt angeben. Siehe javax.mail.InternetAddress.parse(String).

Das XML-Element	`<log_mail_bcc>`	wird damit überschrieben
Die Einstellung	`factory.ini` (Abschnitt `[job]`, Eintrag `log_mail_bcc=…`)	wird damit überschrieben
Die Einstellung	`factory.ini` (Abschnitt `[spooler]`, Eintrag `log_mail_bcc=…`)	wird damit überschrieben

Beispiel

spooler_log.mail().set_bcc( "hans@company.com" );

Beispiel

spooler_log.mail.bcc = "hans@company.com";

Wenn die Hostware zum eMail-Versand JavaMail verwendet, können Sie mehrere Adressen durch Komma getrennt angeben. Siehe javax.mail.InternetAddress.parse(String).

Parameter

String

body

Inhalt der Nachricht

	mail.body = String
String	mail.body

Beispiel in javascript

spooler_log.mail.body = "Job succeeded";

Codieren Sie Zeilenwechsel mit \n (in VBScript mit chr(10)).

Parameter

String

cc

Empfänger einer Kopie der Nachricht, carbon copy

	mail.cc = String
String	mail.cc

Beispiel in javascript

spooler_log.mail.cc = "hans@company.com";

Wenn die Hostware zum eMail-Versand JavaMail verwendet, können Sie mehrere Adressen durch Komma getrennt angeben. Siehe javax.mail.InternetAddress.parse(String).

Das XML-Element	`<log_mail_cc>`	wird damit überschrieben
Die Einstellung	`factory.ini` (Abschnitt `[job]`, Eintrag `log_mail_cc=…`)	wird damit überschrieben
Die Einstellung	`factory.ini` (Abschnitt `[spooler]`, Eintrag `log_mail_cc=…`)	wird damit überschrieben

Beispiel

spooler_log.mail().set_cc( "hans@company.com" );

Beispiel

spooler_log.mail.cc = "hans@company.com";

Wenn die Hostware zum eMail-Versand JavaMail verwendet, können Sie mehrere Adressen durch Komma getrennt angeben. Siehe javax.mail.InternetAddress.parse(String).

Parameter

String

dequeue

Nachrichten aus dem Verzeichnis queue_dir erneut versuchen zu versenden

Integer

mail.dequeue()

Siehe Mail.dequeue_log, factory.ini (Abschnitt [spooler], Eintrag mail_queue_dir=…).

Rückgabe

Integer

Zahl der versandten Nachrichten

dequeue_log

Protokoll von dequeue()

String

mail.dequeue_log

Beispiel in javascript

var count = spooler_log.mail.dequeue();
spooler_log.info( count + " messages from mail queue sent" );
spooler_log.info( spooler_log.mail.dequeue_log );

Siehe Mail.dequeue().

from

Absender

	mail.from = String
String	mail.from

Beispiel in javascript

spooler_log.mail.from = "scheduler@company.com";

Die Einstellung	`factory.ini` (Abschnitt `[job]`, Eintrag `log_mail_from=…`)	wird damit überschrieben
Die Einstellung	`factory.ini` (Abschnitt `[spooler]`, Eintrag `log_mail_from=…`)	wird damit überschrieben

Beispiel

spooler_log.mail().set_from( "scheduler@company.com" );

Beispiel

spooler_log.mail.from = "scheduler@company.com";

Parameter

String

queue_dir

Verzeichnis der nicht versendbaren eMails

	mail.queue_dir = String path
String	mail.queue_dir

eMails, die der Job Scheduler nicht verschicken kann (weil z.B. der SMTP-Server nicht erreichbar ist), werden hier abgelegt.

Um diese eMails später zu verschicken, muss ein Job geschrieben werden, der die Methode Mail.dequeue() aufruft.

Der allgemeine Platz für diese Einstellung ist sos.ini (Abschnitt [mail], Eintrag queue_dir=…).

Umgebungsvariablen (z.B. $HOME) werden ersetzt (siehe hier).

Die Einstellung	`factory.ini` (Abschnitt `[job]`, Eintrag `mail_queue_dir=…`)	wird damit überschrieben
Die Einstellung	`factory.ini` (Abschnitt `[spooler]`, Eintrag `mail_queue_dir=…`)	wird damit überschrieben
Die Einstellung	`sos.ini` (Abschnitt `[mail]`, Eintrag `queue_dir=…`)	wird damit überschrieben

Parameter

path

smtp

Name des SMTP-Servers

	mail.smtp = String
String	mail.smtp

Beispiel in javascript

spooler_log.mail.smtp = "mail.company.com";

Der allgemeine Platz für diese Einstellung ist sos.ini (Abschnitt [mail], Eintrag smtp=…).

Die Einstellung	`factory.ini` (Abschnitt `[job]`, Eintrag `smtp=…`)	wird damit überschrieben
Die Einstellung	`factory.ini` (Abschnitt `[spooler]`, Eintrag `smtp=…`)	wird damit überschrieben
Die Einstellung	`sos.ini` (Abschnitt `[mail]`, Eintrag `smtp=…`)	wird damit überschrieben

Beispiel

spooler_log.mail().set_smtp( "mail.company.com" );

Beispiel

spooler_log.mail.smtp = "mail.company.com";

Parameter

String

subject

Betreff

	mail.subject = String
String	mail.subject

Beispiel in javascript

spooler_log.mail.subject = "Job succeeded";

Die Einstellung	`factory.ini` (Abschnitt `[job]`, Eintrag `log_mail_subject=…`)	wird damit überschrieben
Die Einstellung	`factory.ini` (Abschnitt `[spooler]`, Eintrag `log_mail_subject=…`)	wird damit überschrieben

Beispiel

spooler_log.mail().set_subject( "Job succeeded" );

Beispiel

spooler_log.mail.subject = "Job succeeded";

Parameter

String

to

Empfänger

	mail.to = String
String	mail.to

Beispiel in javascript

spooler_log.mail.to = "admin@company.com";

Wenn die Hostware zum eMail-Versand JavaMail verwendet, können Sie mehrere Adressen durch Komma getrennt angeben. Siehe javax.mail.InternetAddress.parse(String).

Das XML-Element	`<log_mail_to>`	wird damit überschrieben
Die Einstellung	`factory.ini` (Abschnitt `[job]`, Eintrag `log_mail_to=…`)	wird damit überschrieben
Die Einstellung	`factory.ini` (Abschnitt `[spooler]`, Eintrag `log_mail_to=…`)	wird damit überschrieben

Beispiel

spooler_log.mail().set_to( "admin@company.com" );

Beispiel

spooler_log.mail.to = "admin@company.com";

Wenn die Hostware zum eMail-Versand JavaMail verwendet, können Sie mehrere Adressen durch Komma getrennt angeben. Siehe javax.mail.InternetAddress.parse(String).

Parameter

String

xslt_stylesheet

XSLT-Stylesheet für eMail-Aufbereitung

Xslt_stylesheet mail.xslt_stylesheet

Rückgabe

Xslt_stylesheet

Das XSLT-Stylesheet als String

xslt_stylesheet_path

XSLT-Stylesheet für eMail-Aufbereitung

mail.xslt_stylesheet_path = String path

Beispiel in javascript

spooler_log.mail.xslt_stylesheet_path = "c:/stylesheets/mail.xslt";

Der Pfad eines XSLT-Stylesheets. Der Job Scheduler verwendet das XSLT-Stylesheet zum Aufbereiten der eMails. (Die Dokumentation hierzu ist noch nicht geschrieben.)

Das XML-Attribut <config mail_xslt_stylesheet="…"> wird damit überschrieben

Beispiel

spooler_log.mail().set_xslt_stylesheet_path( "c:/stylesheets/mail.xslt" );

Beispiel

spooler_log.mail.xslt_stylesheet_path = "c:/stylesheets/mail.xslt";

Parameter

path	Der Pfad der Datei, die das XSLT-Stylesheet enthält

Software- und Organisations-Service GmbH

Zuletzt geändert von Joacim Zschimmer, 2006-01-31