Transaktionsmails wie Bestell- und Versandbestätigungen, Rechnungen, Passworterinnerungen etc. sind besonders relevant für Kunden und werden erwartet. Nutzen Sie die Aufmerksamkeit Ihrer Empfänger zielgenau. Mit Inxmail Commerce steuern, erstellen und versenden Sie die in Ihren Systemen wie Online-Shop oder ERP generierten E-Mails zentral und einfach in einer Lösung.

Die Vorteile:

▪einfaches und einheitliches Design

▪erweiterte Statistiken

▪Auswertung von Öffnungs- und Klickraten

▪einfache Verwaltung

Inhalt

Funktionsweise

Unterstützte E-Mails

Integration

Manuelles Eingreifen im Fehlerfall

 

Funktionsweise

Für jeden E-Mail-Typ kann festgelegt werden, ob der Versand der E-Mail über das WEBSALE eigene E-Mail-System oder über Inxmail Commerce erfolgen soll.

Soll beispielsweise die Bestellbestätigungs-E-Mail von Inxmail Commerce versendet werden, ist der Ablauf folgender:

▪Nach erfolgreicher Bestellung sendet der Shop an Inxmail die benötigten und vorab definierten Informationen und Daten der Bestellung.

▪Inxmail fügt diese Daten in das vorab konfigurierte E-Mail-Template für Bestellbestätigungs-E-Mails ein und versendet die E-Mail an den Käufer.

Sollte der Versand der E-Mail nicht erfolgreich sein, erfolgt ein erneuter Zustellversuch der E-Mail (Zeitspanne konfigurierbar durch WEBSALE).

Im Fehlerfall ist ein manuelles Eingreifen des Händlers erforderlich. Hierzu wird ein eigener FTP-Zugang auf das Fehlerverzeichnis eingerichtet.

 

Unterstützte E-Mails

Folgende E-Mails können via Inxmail versendet werden:

 

Integration

Voraussetzungen

Klären Sie vorab mit Inxmail Commerce, welche der umfangreichen Leistungen von Inxmail genutzt werden. Dieser Leistungsumfang muss dann an WEBSALE übermittelt werden, um abzuklären, ob die Schnittstelle in der Lage ist, alle gewünschten Leistungen abzubilden.

Konfigurieren Sie die gewünschten Einstellungen im Backend von Inxmail.

Schritt 1: Freischaltung/Aktivierung

Die Funktion muss seitens WEBSALE für Ihre ShopID technisch aktiviert und eingerichtet werden. Wir benötigen hierfür folgende Daten/Informationen von Ihnen:

▪Key

▪Secret

▪URL

Ihr WEBSALE-Ansprechpartner steht Ihnen gerne zur Verfügung.

Schritt 2: Anpassung der Shopkonfiguration shop.config

Für jede E-Mail, die per Inxmail verschickt werden soll, muss der entsprechende Abschnitt der Shopkonfiguration shop.config angepasst werden. Eine Übersicht der unterstützten E-Mail-Typen/Abschnitte finden Sie unter Unterstützte E-Mails.

Geben Sie beim Parameter ExternMailTemplate den Namen eines neu zu erstellenden Templates an (siehe Schritt 3).

Ergänzen Sie den Parameter UseExternMailSystem und stellen Sie diesen zunächst auf InxMail_Test, um die Integration vor dem Livegang testen zu können.

Beispiel:

<CustomerMail>
   ...
   Allow = yes
   ExternMailTemplate = customer_mail.inxmail
   UseExternMailSystem = InxMail_test
   ...
</CustomerMail>

Referenz: Abschnitt CustomerMail

Schritt 3: Anlegen der E-Mail-Templates

Für jeden E-Mail-Typ muss ein eigenes Template angelegt werden. Speichern Sie diese in Ihrem Template-Verzeichnis (z. B. benutzer/templates/translation).

Da die Übergabe an Inxmail mittels JSON erfolgt, müssen die gewünschten Informationen als JSON-Objekte integriert werden. Alle Informationen, die Sie für die Übergabe an Inxmail benötigen, entnehmen Sie bitte der Inxmail-Dokumentation.secure, die Sie direkt von Inxmail erhalten.

Beispiel-Code für eine Bestellbestätigungs-E-Mail:

{
  "event": "neworder",  
  "payload":
  {
    "Customer":
    {
      "Id": "~A-Number~",
      "Email": "~A-EMail~"
      {!ST-KnownCustomer},"IsNewCustomer": true{/!ST-KnownCustomer}
    },
    "Order":
    {
      "Id": ~WS-OrderNumber~,
      "Date": "~WS-OrderDate~ ~WS-OrderTime~"
    },
    "Items": 
    [
      {@BASKET-PR-Data}
        {DC-CompareDigitGT($BASKET-PR-Position$,1)},{/DC-CompareDigitGT($BASKET-PR-Position$,1)}
        {
          "Sku": "~BASKET-PR-Number~", 
          ~DC-FP1_set($BASKET-PR-Name$)~
          "Name": "~DC-FP1_jsonencoding~",
          "Price": ~BASKET-PR-Sum~,
          "Currency": "~WS-Currency~"
        }
      {/@BASKET-PR-Data}
    ]
  }
}

Referenz: DC-FPX_jsonencoding

Auf den Templates dürfen alle WEBSALE-Tags verwendet werden, die auch auf den "normalen" E-Mail-Templates von WEBSALE genutzt werden können.

Wegweiser: E-Mail-Benachrichtigungen

Außerdem stehen folgende Tags speziell für externe Mailsysteme zur Verfügung:

Referenz: MAIL-Tags

 
Wenn Sie PDF-Dateien an Inxmail übergeben wollen, können Sie

▪statische PDF-Dateien (base64-codiert) direkt als "festen Text" übergeben.

▪fertig generierten, base64-codierten Code verwenden, z. B. für Dateien, die als statischer Anhang bei der E-Mail konfiguriert sind. (Die Ausgabe erfolgt z. B. durch ~MAIL-FileAttachment_ContentB64~).

▪beliebigen base64-codierten HTML-Code direkt zwischen WEBSALE-EXTMAIL-HTML2PDFB64:: und ::WEBSALE-EXTMAIL-HTML2PDFB64 setzen. In diesem Fall generiert die Schnittstelle aus dem HTML-Code ein base64-codiertes PDF. (Ausgabe durch ~MAIL-HTMLAttachment_ContentB64~ oder auch anhand von DC-Tags.)

Beispiel:

"attachments": 
[
  {@MAIL-FileAttachment}
    { 
      "filename": "~MAIL-FileAttachment_Name~",
      "content-type": "application/pdf", 
      "content": "~MAIL-FileAttachment_ContentB64~" 
    },
  {/@MAIL-FileAttachment}
  {@MAIL-HTMLAttachment}
    { 
      "filename": "~MAIL-HTMLAttachment_Name~", 
      "content-type": "application/pdf",
      "content": "WEBSALE-EXTMAIL-HTML2PDFB64::~MAIL-HTMLAttachment_ContentB64~::WEBSALE-EXTMAIL-HTML2PDFB64" 
    }
  {/@MAIL-HTMLAttachment}
]

Referenz: MAIL-FileAttachment_ContentB64

Referenz: MAIL-HTMLAttachment_ContentB64

Schritt 4: Testen des Mail-Versands

Rufen Sie den Shop im allgemeinen Testmodus auf:

http://www.xyz.de/?test=on

Führen Sie die entsprechende Aktion durch, die den Versand der gewünschten E-Mail auslöst.

Prüfen Sie, ob die E-Mail korrekt versendet wird und inhaltlich Ihren Vorstellungen bzw. Vorgaben entspricht.

Deaktivieren Sie nach Beendigung der Tests den allgemeinen Testmodus:

http://www.xyz.de/?test=off

Wegweiser: Testmodi des Shops ein-/ausschalten

Schritt 5: Liveschalten des Features

Um den Versand der E-Mail über Inxmail für den Produktivbetrieb zu aktivieren, stellen Sie in der Shopkonfiguration shop.config beim entsprechenden Abschnitt den Parameter UseExternMailSystem auf den Wert InxMail.

Beispiel:

<CustomerMail>
   ...
   UseExternMailSystem = InxMail
   ...
</CustomerMail>

Referenz: Abschnitt CustomerMail

 

Haben Sie alle Schritte durchgeführt, ist Inxmail erfolgreich in Ihrem Shop integriert und aktiv.

 

Manuelles Eingreifen im Fehlerfall

Im Fehlerfall ist ein manuelles Eingreifen des Händlers erforderlich. Hierzu wird bei Bereitstellung des Features ein eigener FTP-Zugang auf das Fehlerverzeichnis eingerichtet.

Das Verzeichnis hat folgenden Aufbau:
 

/
/errors
/spool
/log

Fehlerdateien werden innerhalb des Verzeichnisses /errors abgelegt. Pro fehlgeschlagenem API-Event-Call bei Inxmail wird eine eigene Datei mit der JSON-Payload angelegt.

Mittels REST-API kann die kumulierte Fehleranzahl der letzten X Minuten abgefragt werden.

Alle verfügbaren Informationen sowie etwaige Meldungen des Inxmail-Systems sind in der zugehörigen Logdatei unterhalb von /log zu finden.

Jeden Tag wird eine Logdatei in der Form YYYYMMDD.log angelegt. Die Logeinträge werden als JSON-Objekte gespeichert. Die Logs werden maximal 6 Monate vorgehalten und automatisch bereinigt.

Nach Korrektur der JSON-Payload muss die Datei nach /spool verschoben werden. Alle Dateien in diesem Verzeichnis werden erneut an Inxmail übergeben. Tritt erneut ein Fehler auf, wird die Datei zurück nach /errors verschoben.