GXCustomerEmail resource

Methods

  • get - Get Emails
  • put - Queue Email
  • post - Send Email

Properties

{
    "attachments": [
        "string"
    ],
    "bcc": [
        "string"
    ],
    "cc": [
        "string"
    ],
    "contentHtml": "string",
    "creationDate": "string",
    "id": "int64",
    "isPending": "boolean",
    "recipient": {
        "contactName": "string",
        "emailAddress": "string"
    },
    "sender": {
        "contactName": "string",
        "emailAddress": "string"
    },
    "sentDate": "string",
    "subject": "string"
}
{
    "attachments": [
        {
            "name": "nice_name_for_my_file.txt",
            "path": "/var/www/html/shop/uploads/attachments/1434614398/myfile.txt"
        }
    ],
    "bcc": [
        {
            "contactName": "Chris Doe",
            "emailAddress": "bcc@email.de"
        }
    ],
    "cc": [
        {
            "contactName": "Chloe Doe",
            "emailAddress": "cc@email.de"
        }
    ],
    "contentHtml": "<strong>html content</strong>",
    "contentPlain": "plain content",
    "creationDate": "2015-06-04 14:36:00",
    "isPending": false,
    "recipient": {
        "contactName": "Jane Doe",
        "emailAddress": "recipient@email.de"
    },
    "replyTo": {
        "contactName": "John Doe (Reply To)",
        "emailAddress": "reply_to@email.de"
    },
    "sendDate": "2015-06-04 14:36:00",
    "sender": {
        "contactName": "John Doe",
        "emailAddress": "sender@email.de"
    },
    "subject": "Test Subject"
}
Name Type Description Additional
attachments[] array of string Required
bcc[] array of string Required
cc[] array of string Required
contentHtml string Required
creationDate string Required
id int64 Optional , read only.
isPending boolean Required
recipient object GXCustomerEmailAddress Required
recipient.contactName string Required
recipient.emailAddress string Required
sender object GXCustomerEmailAddress Required
sender.contactName string Required
sender.emailAddress string Required
sentDate string Required
subject string Required