Models

Email

Email delivery options. When a Peppol recipient is provided, email is optional and you can choose to always send the email, or only when Peppol delivery fails, whether that is refused at send time or reported later by the access point. When the Peppol recipient is null, email becomes the primary delivery method and email.to is required. Every email carries the document's attachments, and the document as XML whenever one was written or given: always for a Peppol recipient, and for a null recipient when doctypeId is set or the document is raw XML. Each email counts towards your document quota at the moment it is sent.

Properties

NameTypeRequiredDescription
whenalways | on_peppol_failureNoWhen to send the email. always sends it with the Peppol transmission. on_peppol_failure sends it when the Peppol transmission is refused at send time, or when the access point reports afterwards that it failed; in that second case the email goes out at that moment and appears as email deliveries on the document, announced by a document.delivery_status_changed event. If the Peppol recipient is null, email is the only channel and is always sent. Default: on_peppol_failure. Values: always, on_peppol_failure
tostring[]YesThe email addresses to send the document to. In a playground, only the verified addresses of the team's members receive the email; it is simulated for any other address. Example: ["support@recommand.eu"]
subjectstringNoThe subject of the email. If not provided, the subject will be autogenerated based on the document type. Example: "Invoice SI-001"
htmlBodystringNoThe HTML body of the email. If not provided, the body will be autogenerated based on the document type. Example: "Dear customer, you can find your invoice attached."
replyTostring (email)NoThe address a reply to the email goes to. If not provided, replies go to the email address of the document's issuer as the document states it (the seller, or the buyer for self-billing documents). Without either, replies go to Recommand's sending address, which is not monitored. Example: "billing@example.com". Format: email

Used by

On this page