JSON Email Output List

Describes a list of email message output, a content set ID for that output, and any errors that may have occurred specific to a content creation for email operation.

Structure

The structure consists of an object with the following name/value pairs:

• messages – a list of the email messages created, consisting of an array of objects each with the following name/value pairs:

  • subject – the subject of the email message (type of string)

  • to – the email addresses of the recipients in the email message (type of string)

  • body – the name of the HTML email body file in the email message output (type of string)

  • folder – the managed file ID for the output directory in the file store containing the email message output (type of number)

  • attachments – a list of the file attachments to the email message, consisting of an array of objects each with the following name/value pairs:

    • name – the name of the file attachment in the email message output (type of string)

    • disposition – the disposition of the attachment to the email message (type of string)

  
  Specific to inclusion of meta tags in the template's scripts, the following optional name/value pairs can be specified:

  • from – the email address of the sender in the email message (type of string)

  • cc – the email addresses of the carbon copy (CC) recipients in the email message (type of string)

  • bcc – the email addresses of the blind carbon copy (BCC) recipients in the email message (type of string)

  • replyTo – the email addresses to reply to in the email message (type of string)

  • headers – a list any custom email headers in the email message, consisting of an array of objects each with the following name/value pairs:

    • <name> – the name (name) and value of the email header (type of string)

  
  Specific to email message output where an EML (E-Mail Message) file is to be created, the following name/value pair will be specified:

  • eml – the name of the EML (E-Mail Message) file in the email message output (type of string)

  Specific to templates with an email context section configured to append a plain-text copy of the HTML, the following name/value pair will be specified:

  • text – the name of the TXT email file in the email message output (type of string)

• errors – a list of any errors that occurred during content creation, consisting of an array of objects each with the following name/value pairs:

  • record –the data record index associated with the error (type of number)

  • message –the description of the error that occurred (type of string)

• contentSet – the content set entity identifier for the email output (type of number)

Examples

The following is an example of this structure:

{
    "messages": [
        {
            "attachments": [
                {
                    "name": "att97529c81-f882-4c21-8b39-a404f728d43e.png",
                    "disposition": "inline"
                },
                {
                    "name": "att2fa0f059-ec10-4054-b859-36ad1f2fdf59.png",
                    "disposition": "inline"
                },
                {
                    "name": "att86c7b3c2-3483-4926-b893-608a42231d70.jpg",
                    "disposition": "inline"
                },
                {
                    "name": "attf086d7d3-d33f-478a-b1a6-771deeb39b5b.png",
                    "disposition": "inline"
                },
                {
                    "name": "attb0db370d-db4d-4bc3-93be-82438603c253.png",
                    "disposition": "inline"
                },
                {
                    "name": "att4c7f31d9-d512-42b6-b0a9-6e120c07701f.png",
                    "disposition": "inline"
                },
                {
                    "name": "att80b0c7c4-6aaf-45b8-b559-b5f0e3c4e378.png",
                    "disposition": "inline"
                },
                {
                    "name": "att7d18e853-8013-46c3-819a-2efdad883a10.png",
                    "disposition": "inline"
                },
                {
                    "name": "John, gain complete control!.html",
                    "disposition": "attachment"
                }
            ],
            "subject": "John, gain complete control!",
            "to": "k.snell@drupa.ol.com.com",
            "folder": 12345,
            "eml": "63cb15da-42be-4dd8-88e3-367e0f3c9fec.eml",
            "body": "21545016-ef51-4e36-8932-73b0897c4672.html"
        },
        {
            "attachments": [
                {
                    "name": "attb374b927-5b0a-48d6-9fd0-678a0c6b1faf.png",
                    "disposition": "inline"
                },
                {
                    "name": "att264e569e-0f13-4422-a1a5-41c9cda0797e.png",
                    "disposition": "inline"
                },
                {
                    "name": "att35d7d743-886d-405d-b5d4-ce73d43b9de3.jpg",
                    "disposition": "inline"
                },
                {
                    "name": "att9eb5d506-f9ac-4df0-9b72-e164f4dd1237.png",
                    "disposition": "inline"
                },
                {
                    "name": "att357f4a10-047c-45a7-b292-0862bd50979d.png",
                    "disposition": "inline"
                },
                {
                    "name": "att335b33e2-4ca1-4d2f-a7ea-06ca96c1544b.png",
                    "disposition": "inline"
                },
                {
                    "name": "att48c026ef-0bdc-4709-ac71-eea25ec5f137.png",
                    "disposition": "inline"
                },
                {
                    "name": "att063ad47c-dc26-4105-b013-9dacb4e47718.png",
                    "disposition": "inline"
                },
                {
                    "name": "Kristopher, gain complete control!.html",
                    "disposition": "attachment"
                }
            ],
            "subject": "Kristopher, gain complete control!",
            "to": "k.snell@drupa.ol.com.com",
            "folder": 23456,
            "eml": "9999069e-28dd-4182-86a9-81cb0a228261.eml",
            "body": "124ffa76-8794-4b1e-afb7-2f886738c05f.html"
        }
    ],
    "errors": [],
    "contentSet": 34567
}