ProductKennisDevelopers
Platform Control
Mailfrom hooks: documenten verwerken via e-mail

Documenten verwerken via e-mail met mailfrom hooks: uniek tokenadres, transformatie en eigen domein.

Niet elk systeem kan documenten aanleveren via een API-koppeling. Met een mailfrom hook maak je het mogelijk om documenten als e-mailbijlage aan te leveren bij de PSB. De PSB genereert een uniek e-mailadres met een token (bijvoorbeeld [email protected]). Elk document dat als bijlage naar dit adres wordt gestuurd, wordt automatisch verwerkt als factuur, order of ander documenttype.

Hoe werkt een mailfrom hook?

Bij het aanmaken van een mailfrom hook genereert de PSB een uniek tokenadres. Je configureert via een publishTopic wat er met de binnenkomende documenten moet gebeuren, bijvoorbeeld verzenden via Peppol (SendInvoice) of verwerken als inkomend document (ReceiveInvoice).

De flow is als volgt:

  1. Je registreert een mailfrom hook met een publishTopic
  2. De PSB genereert een uniek e-mailadres met een token
  3. Een gebruiker of systeem stuurt een e-mail met documentbijlage(n) naar dit adres
  4. De PSB verwerkt de bijlagen als documenten en publiceert ze op het opgegeven topic
  5. Eventuele vervolgacties (verzending, transformatie) worden automatisch uitgevoerd
Een mailfrom hook aanmaken

Registreer een hook via de API met een mailfrom://-action. Gebruik $token$ als placeholder; de PSB vervangt dit door het gegenereerde token in de response.

{
  "id": "1",
  "name": "mail from trigger",
  "action": "mailfrom://*&[email protected]",
  "publishTopics": [
    "SendInvoice"
  ],
  "isActive": true
}

Na registratie bevat de response het werkelijke tokenadres:

mailfrom://*&[email protected]

Vanaf dat moment worden alle bijlagen die naar [email protected] worden gestuurd, verwerkt als facturen en op het topic SendInvoice gepubliceerd.

Action-formaat

De action is opgebouwd uit een from- en to-deel:

mailfrom://{from}&to={to}

Het tokenadres kan in het from- of het to-deel worden geplaatst. Minimaal een van beide moet het token bevatten, zodat de PSB de e-mail kan koppelen aan de juiste hook.

Varianten
ConfiguratieBeschrijvingmailfrom://*&[email protected]Accepteer e-mails van elk afzenderadres, token in het ontvangstadresmailfrom://[email protected]&[email protected]Token in het afzenderadres, vast ontvangstadres. Bruikbaar bij een eigen domein

De wildcard * bij het from-deel betekent dat e-mails van elk afzenderadres worden geaccepteerd. Wil je beperken welke afzenders documenten mogen aanleveren, vul dan een specifiek e-mailadres in.

Omgevingen
OmgevingE-maildomeinAcceptatie@accp.econnect.emailProductie@econnect.email

Let op: Gebruik altijd het juiste domein per omgeving. E-mails naar het productiedomein worden als echte documenten verwerkt en kunnen niet ongedaan worden gemaakt.

Documenttransformatie

Optioneel kun je een sourceDocumentTypeId en targetDocumentTypeId opgeven als queryparameter. De PSB transformeert de bijlage dan automatisch naar het opgegeven doelformaat, mits een geschikte transformatie beschikbaar is. Speciale tekens in de documentTypeId moeten URL-encoded worden.

{
  "id": "1",
  "name": "mail from met transformatie",
  "action": "mailfrom://*&[email protected]?sourceDocumentTypeId=urn%3Aoasis%3Anames%3Aspecification%3Aubl%3Aschema%3Axsd%3AInvoice-2%3A%3AInvoice%23%23urn%3Acen.eu%3Aen16931%3A2017%23compliant%23urn%3Afdc%3Anen.nl%3Anlcius%3Av1.0%3A%3A2.1&targetDocumentTypeId=urn%3Aoasis%3Anames%3Aspecification%3Aubl%3Aschema%3Axsd%3AInvoice-2%3A%3AInvoice%23%23urn%3Acen.eu%3Aen16931%3A2017%23compliant%23urn%3Afdc%3Anen.nl%3Anlcius%3Av1.0%3A%3A2.1",
  "publishTopics": [
    "SendInvoice"
  ],
  "isActive": true
}
Publish topics

Een mailfrom hook ondersteunt precies één publishTopic. Dit topic bepaalt hoe de PSB de binnenkomende documenten verwerkt.

Publish topicToepassingSendInvoiceFactuur verzenden via het geconfigureerde kanaal (bijv. Peppol)ReceiveInvoiceDocument registreren als ontvangen factuurRecognizeSalesInvoiceDocument aanbieden aan IDR voor PDF-herkenning

Tip: Door RecognizeSalesInvoice als publish topic te gebruiken, kun je PDF-facturen per e-mail aanleveren en automatisch laten herkennen door de IDR. Zo combineer je mailfrom met intelligente documentherkenning.

Eigen domein

Standaard gebruikt de PSB het domein econnect.email (of accp.econnect.email voor acceptatie). Het is ook mogelijk om een eigen domein te gebruiken, zodat het e-mailadres past bij je eigen organisatie. Neem hiervoor contact op met eConnect.

Aandachtspunten
  • Mailfrom hooks verwerken alleen bijlagen. De tekst van de e-mail zelf wordt niet als document verwerkt.
  • Per hook wordt maximaal één publishTopic ondersteund. Voor verschillende verwerkingen (verzenden, ontvangen, herkennen) maak je aparte hooks aan.
  • Zorg ervoor dat de bijlagen in een ondersteund formaat zijn (XML, PDF). Andere bestandstypen worden niet verwerkt.
Veelgestelde vragen
Waarom gebruik ik de placeholder $token$ in de mailfrom-action?

Bij registratie vervangt de PSB $token$ door het gegenereerde unieke token in het e-mailadres; de response bevat het definitieve mailfrom://-pad. Alleen adressen met dat token worden aan jouw hook gekoppeld, zodat binnenkomende mail gericht wordt verwerkt.

Welk e-maildomein hoort bij acceptatie versus productie?

Voor acceptatie gebruik je adressen op @accp.econnect.email, voor productie op @econnect.email. E-mails naar het productiedomein worden als echte documentstromen verwerkt en zijn niet eenvoudig terug te draaien; kies dus bewust de omgeving.

Kan ik meerdere verwerkingen (verzenden, ontvangen, herkennen) in één mailfrom hook?

Nee: een mailfrom hook ondersteunt precies één publishTopic. Voor verschillende verwerkingen, zoals SendInvoice, ReceiveInvoice of RecognizeSalesInvoice, maak je aparte hooks met elk een eigen tokenadres en publish-topic.

Bekijk de volledige API-specificatie op psb.econnect.eu voor alle configuratiemogelijkheden en voorbeelden.

Bekijk de API-documentatie

Gerelateerd
PreviousJoin hooks
NextKSeF hook