Mailchimp · Schema

ParsedMessage

A parsed MIME message.

CampaignsEmail MarketingMarketing AutomationNewslettersTransactional Email

Properties

Name Type Description
subject string The parsed subject line.
from_email string The parsed sender email address.
from_name string The parsed sender name.
to array Parsed recipient list.
headers object All parsed headers.
text string The plain-text body.
html string The HTML body.
attachments array Parsed file attachments.
images array Parsed inline images.
View JSON Schema on GitHub

JSON Schema

mailchimp-parsedmessage-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ParsedMessage",
  "title": "ParsedMessage",
  "type": "object",
  "description": "A parsed MIME message.",
  "properties": {
    "subject": {
      "type": "string",
      "description": "The parsed subject line.",
      "example": "example_value"
    },
    "from_email": {
      "type": "string",
      "format": "email",
      "description": "The parsed sender email address.",
      "example": "[email protected]"
    },
    "from_name": {
      "type": "string",
      "description": "The parsed sender name.",
      "example": "example_value"
    },
    "to": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "format": "email"
          },
          "name": {
            "type": "string"
          }
        }
      },
      "description": "Parsed recipient list.",
      "example": []
    },
    "headers": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "All parsed headers.",
      "example": "example_value"
    },
    "text": {
      "type": "string",
      "description": "The plain-text body.",
      "example": "example_value"
    },
    "html": {
      "type": "string",
      "description": "The HTML body.",
      "example": "example_value"
    },
    "attachments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "content": {
            "type": "string"
          }
        }
      },
      "description": "Parsed file attachments.",
      "example": []
    },
    "images": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "content": {
            "type": "string"
          }
        }
      },
      "description": "Parsed inline images.",
      "example": []
    }
  }
}