AfSendNotificationHtmlMail

Aus ArcFlow Wiki
Zur Navigation springen Zur Suche springen
Diese Seite enthält Bearbeitungen, die nicht zum Übersetzen freigegeben sind.
 AfSendNotificationHtmlMail(alpha1, alpha2, handle3, handle4, alpha5, int6, int7, alpha8, alpha9) : int

Nicht ausführbar von der APINicht ausführbar von der Programmierschnittstelle (DLL)Nicht ausführbar mit der Application Remote ControlAusführbar von der Script-API

E-Mail im HTML-Format senden
alpha1 Betreff
alpha2 Beschreibung
handle3 Deskriptor einer Liste mit Verknüpfungen
handle4 Liste mit Empfängern
alpha5 Name oder IP-Adresse des E-Mail-Servers
int6 Nummer des Ports
int7 Timeout für die Kommunikation mit dem Mail-Server (Sekunden)
alpha8 Benutzer
alpha9 Kennwort
Resultat int Fehlerwert
Siehe

Verwandte Befehle, AfMailSend()

Mit dieser Funktion wird eine Benachrichtigungs-E-Mail an einen oder mehrere Empfänger versendet. Der Betreff und der Text der E-Mail wird in (alpha1) und (alpha2) übergeben. Der Betreff darf maximal 512 und der Text 4096 Zeichen lang sein.

In der E-Mail können Links zu Arbeitsmappen, Archiven und Anhangdateien angegeben werden. Die notwendigen Informationen werden in einer Cte-Liste übergeben, die zuvor mit AfCteOpen() angelegt und mit (siehe CONZEPT 16 Hilfe) gefüllt wurde. Die Informationen müssen in der Eigenschaft Name in folgendem Format stehen:

<ID Arbeitsmappe>:<Archivnummer>:<Anhangdateinummer>:<Seite>:0

Zusätzliche Informationen befinden sich auf der Seite Archivlinks. Soll nur auf eine Arbeitsmappe positioniert werden, müssen in allen weiteren Informationen 0 übergeben werden.

Beispiele:

tCteList # AfCteOpen(_CteList); // Erzeugen der Liste
tCteList->CteInsertItem('10:0:0:0:0',0,''); // Link auf die Arbeitsmappe 10
tCteList->CteInsertItem('10:2011.0000100:0:0:0',0,''); // Link auf das Archiv 2011.0000100 in der Arbeitsmappe 10
tCteList->CteInsertItem('0:2011.0000100:0:0:0',0,''); // Link auf das Archiv 2011.0000100 ohne Arbeitsmappe
tCteList->CteInsertItem('10:2011.0000100:1:0:0',0,''); // Anzeige der ersten Anhangdatei in dem Archiv 2011.0000100
tCteList->CteInsertItem('10:2011.0000100:1:3:0',0,''); // Anzeige der dritten Seiten der ersten Anhangdatei des Archivs 2011.0000100

Wird diese Liste der Anweisung AfSendNotificationHtmlMail() übergeben, werden fünf Links erzeugt. In der E-Mail wird immer der Name der Arbeitsmappe, des Archivs oder der Anhangdatei angezeigt.

Im Parameter (handle4) wird eine Liste mit Empfängern übergeben. Die Liste muss zuvor mit AfCteOpen() angelegt und mit (siehe CONZEPT 16 Hilfe) gefüllt werden. In den Elementen der Liste wird der Name bzw. die E-Mail-Adresse (Eigenschaft "Name"), der Typ des Empfängers (Eigenschaft "Id") und der Anzeigename (Eigenschaft "Custom") angegeben. Für jeden Empfänger muss ein Listenelement angegeben werden.

Als Typ des Empfängers können folgende Werte angegeben werden:

1 Kürzel des Benutzers
2 Benutzergruppe
3 Sachbearbeiter
4 Sachbearbeitergruppe
5 E-Mail-Adresse

Bei der Angabe einer Benutzergruppe oder einer Sachbearbeitergruppe bekommen alle Mitglieder der Gruppe eine Nachricht.

Beispiele:

tCteReceiver # AfCteOpen(_CteList);
tCteReceiver->CteInsertItem('DST',1,''); // Benutzerkürzel angegeben
tCteReceiver->CteInsertItem('support@arcflow.net',5,'Support'); // E-Mail-Adresse angegeben

Anschließend folgen die Angaben zur Kommunikation mit dem E-Mail-Server. In (alpha5) wird der Name des Servers oder seine IP-Adresse angegeben. Erfolgt die Kommunikation über den Standardport 25, kann in (int6) 0 angegeben werden, sonst muss hier der Kommunikationsport übergeben werden.

In (int7) wird der Timeout der Kommunikation in Sekunden angegeben. Reagiert der E-Mail-Server nicht in der angegebenen Zeit, wird ein Fehler zurückgegeben. Benötigt der E-Mail-Server eine Authentifizierung müssen eine Benutzer und sein Kennwort in den Parametern (alpha8) und (alpha9) übergeben werden.

Beispiel:

// Liste der Links
tCteLinks # AfCteOpen(_CteList); // Erzeugen der Liste
tCteLinks->CteInsertItem('10:0:0:0:0',0,''); // Link auf die Arbeitsmappe
tCteLinks->CteInsertItem('10:2011.0000100:0:0:0',0,''); // Link auf das Archiv in der Arbeitsmappe
tCteLinks->CteInsertItem('10:2011.0000100:1:0:0',0,''); // Anzeige der ersten Anhangdatei in dem Archiv 2011.0000100
tCteLinks->CteInsertItem('10:2011.0000100:1:3:0',0,''); // Anzeige der dritten Seiten der ersten Anhangdatei

// Liste der Empfänger
tCteReceiver # AfCteOpen(_CteList);
tCteReceiver->CteInsertItem('DST',1,''); // Benutzerkürzel angegeben
tCteReceiver->CteInsertItem('support@arcflow.net',5,'Support'); // E-Mail-Adresse angegeben

// E-Mail versenden
tErr # AfSendNotificationHtmlMail('Betreff (alpha1)','Text (alpha2)',tCteLinks,tCteReceiver,'MailServer',25,60,'','');

// Listen löschen
tCteLinks->AfCteCloseAll();
tCteReceiver->AfCteCloseAll();

// Fehler auswerten
if (tErr != _ErrOk)
{
  ...
}

Das obige Skript erzeugt folgende E-Mail:

Als Fehlercodes werden die Rückgabewerte der CONZEPT 16 Befehle MailData() und MailClose() zurückgegeben.