Toolmaker Produkt-Dokumentation
E-Mail APIs - E-Mails automatisiert erstellen und versenden
rInhaltsübersicht
Um Ihnen die Möglichkeit zu bieten, directmail nahtlos in Ihre Anwendungen zu integrieren, beinhaltet directmail mehrere APIs (Programmschnittstellen) sowie Befehle, die Sie benutzen können um mit einfachen IBM i-Befehlen und übergebenen Parametern E-Mails zu erstellen und zu versenden.
Hier werden die einzelnen Schritte um E-Mails automatisiert erstellen und versenden zu können detailliert beschrieben.
OPNEMLAPI - Open E-Mail (Menüauswahl 9)
Das erste API dient der Eröffnung eines E-Mail-Vorgangs. Sie starten die Erstellung einer E-Mail mit dem Befehl OPNEMLAPI.
0251 - E-Mail öffnen
Die Namen der Parameter werden nachfolgend in Klammern dargestellt. Z.B. Empfänger (RECEIVER).
Mailbox (MAILBOX)
Hier geben Sie an, in welcher Mailbox der E-Mail-Vorgang eröffnet werden soll
Absender (SENDER)
Geben Sie hier Absendernamen und E-Mail Adresse des Absenders der E-Mail mit.
Unter bestimmten Umständen wird diese Angabe vom SMTP-Server geprüft. Die Adresse muss dann auf dem SMTP-Server vorhanden sein. Anderenfalls kann es zu einer Fehlermeldung kommen: "550-Requested action not taken: mailbox unavailable", oder eine andere Fehlermeldung vom SMTP-Server, die auf einen Fehler hindeutet (WRKEML, Auswahl 25 für die nicht versendete E-Mail).
Das Format für den Absender ist:
SENDER(Max Maus 'max.maus@acmegmbh.de')
Gültige Werte sind:
Absendernamen und Absender E-Mail-Adresse
*MAILBOX Die Informationen werden aus der im Parameter MAILBOX hinterlegten Mail box übernommen.
Empfänger (RECEIVER)
Max. 80 Stellen
Geben Sie hier Empfängernamen und E-Mail Adresse der Empfänger der E-Mail mit. Das Format für den Empfänger ist:
RECEIVER((*TO Gustav Giraffe 'gustav.giraffe@acmegmbh.de') (*CC name 'email...'))
*TO spezifiziert den/die Empfänger welche die E-Mail als Original erhalten sollen,
*CC spezifiziert den/die Empfänger welche die E-Mail in Kopie erhalten sollen,
*BCC spezifiziert den/die Empfänger welche die E-Mail in "Blind-Kopie" erhalten sollen, d.h. dass alle anderen Empfänger von dieser Kopie nichts wissen.
0252 - E-Mail öffnen 2. Seite
Betreff (SUBJECT)
Hier steht der Betreff der E-Mail.
Max. Länge: 256 Zeichen.
Nachrichtentext (TEXT) - Inhalt des Body-Textes der E-Mail
Liste mit zu 300 Felder á 78 Stellen
jedes Feld erscheint im E-Mail auf einer eigenen Zeile
wenn jedoch eine Zeile mit dem Pluszeichen ("+") endet, dann wird die folgende Zeile angehängt
Beispiele
TEXT('xxx'' 'yyy+' 'zzz') ergibt: xxx yyyzzz
Priorität (PTY)
Spezifiziert die Priorität mit der die E-Mail versandt werden soll
Gültige Werte sind:
*HIGH Die E-Mail wird mit hoher Priorität versandt
*NORMAL Die E-Mail wird mit normaler Priorität versandt
*LOW Die E-Mail wird mit geringer Priorität versandt
Sendepriorität (SNDPTY)
Spezifiziert die Sendepriorität mit der die E-Mail versandt werden soll. Abhängig davon, wie die E-Mail erstellt wurde, wird aurtomatisch eine Sendepriorität vergeben und werden somit per Default schneller verschickt..
Gültige Werte sind:
1-9 - Zugelassene Sendeprioritäten
4 Interaktiv erstellte E-Mails erhalten diese Priotität (Default)
5 API E-Mails erhalten diese Priorität (Default)
7 AutoMail E-Mails erhalten diese Priorität (Default)
Lesebestätigung (CONFIRM)
Wenn das E-Mail-Programm des Empfängers diese Funktion unterstützt, können Sie eine Information beim Öffnen der E-Mail durch dem Empfänger bekommen.
Gültige Werte sind:
*YES Der Empfänger wird aufgefordert eine Empfangsbestätigung abzugeben
*NO Es wird keine Empfangsbestätigung angefordert
Anhänge komprimieren (COMPRESS)
Mit diesem Parameter wird gesteuert, ob kurz vor dem Versand alle Anhänge zu einer echten ZIP-Datei zusammengefasst werden. Der eine (1) Anhang erscheint in der Mail als "Attach.zip". Dieser Parameter kann auch im Bereich des Befehls CLSEMLAPI *EDIT noch beeinflusst werden.
Gültige Werte für diesen Parameter:
*NO E-Mail Anhänge nicht zusammenfassen
*YES E-Mail Anhänge zusammenfassen, komprimieren und als eine ZIP-Datei anhängen.
Achtung: Der Parameter COMPRESS in Befehl WRTEMLAPI hat eine andere Wirkung als hier in OPNEMLAPI.
E-Mail verschlüsseln (ENCRYPT)
Mit dieser Einstellung legen Sie fest, ob die E-Mail verschlüsselt werden soll. Die Verschlüsselung kann nur dann auf *YES gesetzt werden, wenn eine Lizenz DM400CRY vorhanden ist.
Gültige Werte für diesen Parameter:
*NO E-Mails werden nicht verschlüsselt
*YES E-Mails werden verschlüsselt
*POSSIBLE Die Verschlüsselung ist möglich und wird beim einzelnen Mail-Vorgang indi viduell eingestellt
*MAILBOX Die Verschlüsselungseinstellung der Mailbox wird benutzt
*SYSVAL Die Verschlüsselungseinstellung in der directmail-Konfigiration wird benutzt
E-Mail signieren (SIGN)
directmail unterstützt auch die digitale Signatur von E-Mails um deren Authentität sicherzustellen. Die Signierung kann nur dann auf *YES gesetzt werden, wenn eine Lizenz DM400CRY vorhanden ist.
Gültige Werte für diesen Parameter:
*NO E-Mails werden nicht signiert
*YES E-Mails werden digital signiert.
*MAILBOX Die Signatureinstellung der Mailbox wird benutzt
*SYSVAL Die Signatureinstellung in der directmail-Konfigiration wird benutzt
IFS Kopie Name (IFSBACKUP)
Mit welchem Namen die E-Mail nach Versand im IFS abgelegt werden soll.
0313 - E-Mail öffnen 3. Seite
IFS Kopie Pfad (IFSPATH)
In welchem Verzeichnis eine Kopie der E-Mail nach Versand im IFS abgelegt werden soll.
CCSID der Parameter (PARMCCSID)
Mit diesem Wert wird angegeben, in welcher CCSID die Parameter an den Befehl übergeben werden.
Gültige Werte für diesen Parameter:
Zahl CCSID-Tabelle
*CURRENT CCSID des aktuellen Jobs (Standardwert)
*Job CCSID des aktuellen Jobs (Standardwert)
Die Parameter für E-Mail Adressen, Namen, Betreff und Text werden dann automatisch in die CCSID der Server Jobs übersetzt.
CCSID der Email (MAILCCSID)
Mit diesem Wert wird angegeben, in welcher CCSID die Parameter an die Email übergeben werden.
Gültige Werte für diesen Parameter:
Zahl zu verwendende CCSID-Tabelle
*SERVER CCSID des Servers verwenden
*Job CCSID des aktuellen Jobs (Standardwert)
Die Parameter für E-Mail Adressen, Namen, Betreff und Text werden dann automatisch in die CCSID der Server Jobs übersetzt.
WRTEMLAPI - Objekte an E-Mail anhängen (Menüauswahl 10)
In eine einmal geöffnete E-Mail können mit dem Befehl WRTEMLAPI beliebig viele Anhänge aufgenommen werden. Diese Anhänge können PC-Dokumente aus dem integrierten Dateisystem der IBM i, Spooldateien, oder IBM i Objekte wie Programme, Dateien und Bibliotheken sein.
Hier eine Aufstellung sämtlicher Parameter für den Befehl WRTEMLAPI und deren mögliche Verwendung abhängig von der ausgewählten Objektart:
Alle Parameter |
| *SPLF | *SAVF | *IFS | *FILE |
Objektart . . . . . . . . . . . | TYPE | X | X | X | X |
Alias Dateiname . . . . . . . . | ALIAS | X | X | X | X |
Daten komprimieren . . . . . . . | COMPRESS | X | X | X | X |
Smart Card Signatur . | SIGN | X | X | X | X |
Objekt löschen . . . . . . . . . | DLT | X | X | X | X |
An E-Mail Text anhängen . . . . . | ADDTOTXT | X |
| X | X |
Spool-Datei . . . . . . . . . . | FILE | X |
|
|
|
Jobname . . . . . . . . . . . . | JOB | X |
|
|
|
Benutzer . . . . . . . . . . . |
| X |
|
|
|
Nummer . . . . . . . . . . . . |
| X |
|
|
|
Spool-Dateinummer . . . . . . . | SPLNBR | X |
|
|
|
Ausgabeformat . . . . . . . . . | FORMAT | X |
|
|
|
Spool-A-Matic Format . . . . . . | GUMBOFMT | X |
|
|
|
Hersteller, Typ, Modell . | MFRTYPMDL | X |
|
|
|
Datenstationsanpassungsobjekt . | WSCST | X |
|
|
|
Bibliothek . . . . . . . . . . |
| X |
|
|
|
Seitenbereich: | PAGERANGE | X |
|
|
|
Seite von . . . . . . . . . . |
| X |
|
|
|
Seite bis . . . . . . . . . . |
| X |
|
|
|
Nur Text verwenden . . . . . . . | TEXTONLY | X |
|
|
|
Grüne Balken . . . . . . . . . . | GREENBAR | X |
|
|
|
Seitentabelle . . . . . . . . . | PAGETABLE | X |
|
|
|
Papiergröße . . . . . . . . . . | PAPERSIZE | X |
|
|
|
Querformat . . . . . . . . . . . | ROTATION | X |
|
|
|
CPI . . . . . . . . . . . . . . | CPI | X |
|
|
|
LPI . . . . . . . . . . . . . . | LPI | X |
|
|
|
PDF Font . . . . . . . . . . . . | FONT | X |
|
|
|
Codepage CCSID . . . . . . . . . | CCSID | X |
|
|
|
PDF/A erstellen . . . . . . . . . . | PDFA | X |
|
|
|
Text Ursprungskoordinaten: | PDFAREA | X |
|
|
|
X-Achse mm . . . . . . . . . . |
| X |
|
|
|
X skalieren . . . . . . . . . |
| X |
|
|
|
Y-Achse mm . . . . . . . . . . |
| X |
|
|
|
Y skalieren . . . . . . . . . |
| X |
|
|
|
Formular erste Seite . . . . . . | OVERLAY | X |
|
|
|
Formular Position: | MARGINS | X |
|
|
|
Oberer Rand mm . . . . . . . . |
| X |
|
|
|
Unterer Rand mm . . . . . . . |
| X |
|
|
|
Linker Rand mm . . . . . . . . |
| X |
|
|
|
Formular Folgeseiten . . . . . . | OVERLAY2 | X |
|
|
|
Formular Position: | MARGINS2 | X |
|
|
|
Oberer Rand mm . . . . . . . . |
| X |
|
|
|
Unterer Rand mm . . . . . . . |
| X |
|
|
|
Linker Rand mm . . . . . . . . |
| X |