Übersicht
IncaMail Enterprise Application Integration (EAI) ermöglicht es Organisationen, sichere IncaMail-Nachrichten direkt in ihre Business-Software wie ERP-Systeme, HR-Plattformen oder Dokumentenmanagement-Lösungen zu integrieren. Dies erlaubt das automatisierte und konforme Versenden von vertraulichen, persönlichen oder eingeschriebenen Nachrichten (z. B. Gehaltsabrechnungen, Rechnungen oder rechtliche Mitteilungen) ohne manuelle Schritte durch den Endbenutzer.
Es gibt vier Hauptschritte zum Einstieg: Anmeldung für ein Abonnement, Registrierung Ihres Administratorkontos und der Absenderkonten, die Ihre Business-Software zum Versenden von Nachrichten verwenden wird, und schließlich die technische Einrichtung durch Auswahl und Konfiguration der Integrationsmethode, die am besten zu Ihrer Infrastruktur passt.
Dieser Artikel führt Sie durch jeden Schritt und erklärt die verfügbaren Integrationsmethoden, damit Sie den richtigen Ansatz für Ihren Anwendungsfall auswählen können.
Voraussetzungen
Bevor Sie beginnen, stellen Sie bitte sicher, dass Folgendes vorhanden ist:
- IncaMail Firmenvertrag: Ihre Organisation muss ein registrierter IncaMail Firmenkunde mit einem gültigen Vertrag sein, der die EAI-Option beinhaltet.
- Entwicklerressourcen: Für SOAP- und REST-API-Integrationen werden Entwickler benötigt, die mit SOAP oder REST in ihrer Programmierumgebung vertraut sind.
- Firewall-Zugriff: Je nach Integrationsmethode darf der Port 587 (SMTP/TLS Auth) oder Port 25 (Domain-Integration) nicht durch Ihre Firewall blockiert sein.
- Bei Verwendung der Domain-Integration: Domain-Eigentum - Sie müssen in der Lage sein, den Besitz der Domain(s) zu verifizieren, von der/dem Nachrichten versendet werden.
Schritt 1 – Konto registrieren
Falls Sie noch kein IncaMail-Konto haben, registrieren Sie zunächst eines. Die während der Registrierung verwendete E-Mail-Adresse dient als Administratorkonto.
👉 Hier registrieren: https://app.incamail.com/en/register
Hinweis: Jede E-Mail-Adresse, die zum Versenden von Nachrichten aus Ihrer Business-Software verwendet wird, muss ebenfalls einzeln auf der IncaMail-Plattform registriert sein, bevor sie für eine beliebige EAI-Integrationsmethode autorisiert werden kann.
Schritt 2 – Business-Abonnement abschließen
Die EAI-Funktionalität erfordert ein aktives IncaMail Business-Abonnement mit aktivierter EAI-Option. Eine 30-tägige kostenlose Testphase ohne Verpflichtung ist verfügbar.
👉 Hier anmelden: https://web.incamail.com/en/e-mail-encryption/incamail-for-the-e-mail-client
Hinweis: Die Anmeldung für eine Testphase stellt keine verbindliche Bestellung dar. Sie können die Integration während der Testphase evaluieren, bevor Sie sich für eine Fortführung entscheiden.
Schritt 3 – Wählen Sie Ihre Integrationsmethode
EAI bietet vier Integrationsmethoden. Die richtige Wahl hängt von den Fähigkeiten Ihrer Business-Software und Ihrer Infrastruktur ab:
| Methode | Beschreibung | Am besten geeignet für |
|---|---|---|
| SMTP/TLS Auth | IncaMail fungiert als ein standardmäßiger authentifizierter SMTP-Server. Einfach in jeder Programmiersprache oder Software konfigurierbar, die SMTP unterstützt. | Business-Software mit eingebauter SMTP-Sendefunktion |
| Domain-Integration (EAI über MGI) | Versand über Ihren bestehenden Firmen-Mailserver mittels SMTP über TLS/SSL. | Umgebungen, in denen MGI bereits implementiert ist oder in denen versendete Nachrichten in Postfächern archiviert werden müssen |
| SOAP API | Drei leistungsstarke APIs (Send, Read, Admin) für volle Flexibilität, Nachrichtenverfolgung, Entschlüsselung empfangener Nachrichten und Kontoverwaltung. | Individuelle Integrationen in SAP und anderen Unternehmenssystemen, die Tracking oder Entschlüsselung benötigen |
| REST API | Moderne, REST-basierte Versandmethode mit Unterstützung für große Dateianhänge (bis zu 1 GB) und Zustellverfolgung. | Webanwendungen und moderne Entwicklungsumgebungen |
Schritt 4 – Technische Einrichtung abschließen
Die vollständige technische Anleitung zur Einrichtung der Enterprise Application Integration finden Sie hier: https://support.incamail.com/hc/article_attachments/23166869784466
SMTP/TLS Auth
IncaMail verhält sich wie ein standardmäßiger SMTP-Mail-Transfer-Agent (MTA). Nachrichten werden mittels Standard-SMTP mit TLS-Authentifizierung versendet, wobei der Zustelltyp über Tags in der Betreffzeile spezifiziert wird.
Serverdaten:
| Produktiv | Integration / Test | |
|---|---|---|
| SMTP-Server |
incamail.com (MX-Lookup) oder gw1.incamail.com (statisch) |
sta.incamail.com (MX-Lookup) oder gw1.sta.incamail.com (statisch) |
| Port | 25 oder 587 | 25 oder 587 |
| Authentifizierung | Basic Auth (Benutzername = Absender-E-Mail-Adresse, Passwort = bei Registrierung selbst definiert) | Gleich |
| Verschlüsselung | STARTTLS (vor Passwortübertragung obligatorisch) | Gleich |
Wichtig: STARTTLS muss aktiviert sein, bevor das Passwort übertragen wird. Ohne TLS ist die Verbindung zu IncaMail nicht geschützt. Die für die Authentifizierung verwendete E-Mail-Adresse muss mit der Absenderadresse im
FROM:-Header übereinstimmen.
Betreffzeilen-Tags für Zustelltyp:
-
<im> <c>— Vertraulich -
<im> <p>— Persönlich -
<im> <r>— Einschreiben
Beispiel Betreff: <im> <c> Gehaltsabrechnung 12/2024
Domain-Integration (EAI über MGI)
Diese Methode wird verwendet, wenn:
- Ihre Organisation bereits IncaMail MGI nutzt und eine Business-Software zusätzlich über dieselbe Infrastruktur senden muss.
- Gesendete Nachrichten in Postfächern zur Archivierung gespeichert werden müssen.
- Ihre Business-Software bereits einen Firmen-Mailserver für ausgehende E-Mails verwendet.
⚠️ Wichtig — Einrichtungshilfe erforderlich: Im Gegensatz zu den anderen EAI-Integrationsmethoden kann die Domain-Integration (EAI über MGI) nicht vollständig im Self-Service konfiguriert werden. Da der Versand über Ihren Firmen-Mailserver und nicht direkt via SOAP, TLS Auth oder REST erfolgt, ist eine zusätzliche Konfiguration auf IncaMail-Seite erforderlich. Bitte kontaktieren Sie den IncaMail Support, um die Einrichtung zu starten: 👉 https://support.incamail.com/hc/en-us/requests/new
Für die MGI-Domain-Einrichtung selbst siehe die MGI Setup-Anleitung.
Betreffzeilen-Tags und Empfängeradressformat:
| Feld | Format | Beispiel |
|---|---|---|
| Betreff | Vorangestelltes Zustelltyp-Tag | <im> <c> Gehaltsabrechnung 12/2024 |
| An / CC / BCC | Jeder Empfängeradresse wird .incamail.ch angehängt |
john.doe@gmail.com.incamail.ch |
SOAP API
Die SOAP API stellt drei separate APIs für maximale Flexibilität bereit:
| API | Zweck |
|---|---|
| SOAP Send | Nachrichten senden und Zustellstatus verfolgen |
| SOAP Read | Entschlüsselung empfangener verschlüsselter IncaMail (SAFE) Nachrichten |
| SOAP Admin | Änderung von Kundendaten (Firmenname, Banner, Logo) |
Produktiv-Endpunkte:
| URL | |
|---|---|
| SOAP Send | https://ws.incamail.com/3.0/ |
| SOAP Read | https://wsread.incamail.com/3.0/IncaMailReadService |
| SOAP Admin | https://wsmgmt.incamail.com/IncaMailAdminService/IncaMailAdminPort |
Test- / Integrations-Endpunkte:
| URL | |
|---|---|
| SOAP Send | https://ws.sta.incamail.com/3.0/ |
| SOAP Read | https://wsread.sta.incamail.com/3.0/IncaMailReadService |
| SOAP Admin | https://wsmgmt.sta.incamail.com/IncaMailAdminService/IncaMailAdminPort |
Wichtig: Schließen Sie die Endpunkt-URLs immer mit einem
/ab, wo angegeben. Verwenden Sie während der Entwicklung und des Testens stets die Integrationsplattform – wechseln Sie erst für den Live-Betrieb zur Produktivplattform.
Authentifizierung: Basic Authentication (Preemptive) über HTTPS. Benutzername = registrierte IncaMail E-Mail-Adresse, Passwort = bei Registrierung selbst definiert.
SSL-Zertifikat: Einige Systeme (z. B. SAP) erfordern, dass das IncaMail-Server-Root-SSL-Zertifikat registriert wird. Laden Sie das SwissSign Gold CA – G2 Zertifikat hier herunter:
- PEM:
https://swisssign.net/cgi-bin/authority/download/5B257B96A465517EB839F3C078665EE83AE7F0EE.pem
Für detaillierte SOAP-Anfragebeispiele, WSDL-Definitionen und SAP-spezifische Einrichtungshinweise siehe die vollständige EAI Integrationsanleitung: 👉 https://support.incamail.com/hc/article_attachments/23166869784466
REST API
Die REST Send API bietet eine moderne, schlanke Alternative zum Versenden von Nachrichten und der Zustellverfolgung mit integrierter Unterstützung für große Dateianhänge bis zu 1 GB.
Basis-URLs:
| URL | |
|---|---|
| Produktiv | https://incamail.com/xapi/send/v1/ |
| Integration / Test | https://sta.incamail.com/xapi/send/v1/ |
Wichtige Endpunkte:
| Endpunkt | Methode | Zweck |
|---|---|---|
/ping |
GET | Verbindungsprüfung |
/message/send |
POST | Versenden einer IncaMail-Nachricht |
/message/prepareFile |
POST | Vorab-Upload eines großen Dateianhangs (bis zu 1 GB) |
/sentMessages/getDeliveryState |
POST | Zustellstatus anhand der Nachrichten-ID verfolgen |
Authentifizierung: Basic Auth (E-Mail-Adresse + Passwort).
Autorisierung: Jede Absender-E-Mail-Adresse muss vor der Nutzung explizit vom IncaMail Support autorisiert werden. Kontakt: business@incamail.ch und geben Sie die Absender-E-Mail-Adressen sowie die zu nutzende Plattform (Integration oder Produktion) an.
OpenAPI-Dokumentation: https://incamail.com/apidef/restsend/index.html
Für detaillierte REST-Anfragebeispiele und Postman-Einrichtungsanleitungen siehe die vollständige EAI Integrationsanleitung: 👉 https://support.incamail.com/hc/article_attachments/23166869784466
Zustelltypen
Über alle Integrationsmethoden hinweg stehen folgende Zustelltypen zur Verfügung:
| Zustelltyp | SOAP/REST Wert | Betreff-Tag | Beschreibung |
|---|---|---|---|
| Vertraulich | enc |
<im> <c> |
Verschlüsselt, wenn Empfänger nicht auf einer TLS-Domain ist; signiert und unverschlüsselt für MGI-Empfänger |
| Persönlich | encPersonal |
<im> <p> |
Immer verschlüsselt, auch für MGI-Empfänger |
| Eingeschrieben | reco |
<im> <r> |
Rechtlich nachweisbar mit Zustell- und Annahmebestätigung |
| Nur signiert | plain_signed |
— | Signiert, aber nicht verschlüsselt (nur REST API) |
Verständnis der Nachrichtenverschlüsselung (SAFE-Format)
IncaMail verwendet das patentierte SAFE (Secure Attached File Encryption) Format zum Transport verschlüsselter Nachrichten. Je nach Einrichtung des Empfängers wird eine der folgenden Zustellmethoden verwendet:
- TLS-Zustellung: Für Empfänger mit MGI-Domain-Integration werden Nachrichten verschlüsselt über TLS direkt an deren Mail-Gateway zugestellt.
-
SAFE-Anhang: Für alle anderen Empfänger wird die gesamte Nachricht in einen SAFE-Anhang (
IncaMail.html) verschlüsselt. Der Empfänger entschlüsselt die Nachricht über die IncaMail-Weboberfläche, mobile App oder eine SOAP Read-Integration. - Hybrid: Wie SAFE, jedoch mit einem zusätzlichen „Lesen“-Button für schnelleren Zugriff.
Die sendende Anwendung muss die Verschlüsselung nicht selbst handhaben – IncaMail übernimmt dies automatisch basierend auf der Einrichtung des Empfängers.
Häufig gestellte Fragen
Müssen alle Absenderkonten einzeln registriert werden? Ja. Jede E-Mail-Adresse, die zum Versenden von Nachrichten über eine beliebige EAI-Methode verwendet wird, muss einzeln auf der IncaMail-Plattform registriert und für die jeweilige Integrationsmethode autorisiert sein.
Kann ich die SOAP API ohne separaten EAI-Vertrag nutzen? Nein. Es muss ein gültiger IncaMail Firmenvertrag mit der EAI-Option bestehen und von IncaMail konfiguriert sein, bevor die API genutzt werden kann.
Kann ich mehrere Integrationsmethoden parallel verwenden? Ja. Beispielsweise könnte eine Organisation SOAP Send für die automatisierte Gehaltsabrechnung und Domain-Integration für manuell über Outlook versendete Nachrichten nutzen – beides parallel unter demselben Vertrag.
Wie viele parallele SOAP-Threads kann ich nutzen? Wir empfehlen maximal vier parallele Threads für das Senden von SOAP-Anfragen an den IncaMail-Server, um Performance-Probleme zu vermeiden.
Wo kann ich testen, ohne die Produktion zu beeinflussen? Verwenden Sie während der Entwicklung die Integrations-/Testplattform (sta.incamail.com / ws.sta.incamail.com). Wechseln Sie erst vor dem Live-Betrieb zu den Produktiv-Endpunkten.