Skip to main content

QueueHtmlEmailCommunicationInput

Defines the input to queue an email communication that uses an HTML document for content.

input QueueHtmlEmailCommunicationInput {
  bccAddresses: [EmailAddress!]
  brandId: ID
  ccAddresses: [EmailAddress!]
  communicationTagCode: String
  contactIds: [ID!]!
  delayedDeliveryDate: DateTime
  emailSenderAddress: EmailAddress!
  emailSenderName: String!
  emailSubject: String!
  eventId: ID!
  htmlBody: String!
  isMarketing: Boolean
}

Fields​

QueueHtmlEmailCommunicationInput.bccAddresses ● [EmailAddress!] list scalar​

The email addresses of the recipients who will receive the email as a blind carbon copy. Optional.

QueueHtmlEmailCommunicationInput.brandId ● ID scalar​

The identifier of the brand associated with the event to be used to style the HTML message. Optional.

If a brand is specified, the HTML content will be styled using the brand's colors and fonts and the brand's email header and footer images will be inserted into the html content before the communication is processed for delivery.

QueueHtmlEmailCommunicationInput.ccAddresses ● [EmailAddress!] list scalar​

The email addresses of the recipients who will receive the email as a carbon copy. Optional.

QueueHtmlEmailCommunicationInput.communicationTagCode ● String scalar​

The code of the communication tag to associate with the email communication. Optional.

QueueHtmlEmailCommunicationInput.contactIds ● [ID!]! non-null scalar​

The list of identifiers of the contacts to send the email communication to.

Rules:

  • The list must not be empty, i.e. it must contain at least one element.
  • All identifiers must be linked to the event specified in eventId.

QueueHtmlEmailCommunicationInput.delayedDeliveryDate ● DateTime scalar​

The date at which the email communication will be queued to be sent to recipients. Optional.

Rules:

  • When specified, the value must be in the future.
  • When not specified, the email communication will be queued to be sent immediately.

QueueHtmlEmailCommunicationInput.emailSenderAddress ● EmailAddress! non-null scalar​

The email address of the sender for the email message.

If the event in EventsAir (specified by eventId) is using the default email domain, this value will be ignored and emails will be sent from mail@eventsairmail.com.

QueueHtmlEmailCommunicationInput.emailSenderName ● String! non-null scalar​

The name of the sender for the email message.

QueueHtmlEmailCommunicationInput.emailSubject ● String! non-null scalar​

The subject line for the email message.

QueueHtmlEmailCommunicationInput.eventId ● ID! non-null scalar​

The identifier of the event for this communication. The contacts and Merged Document must be linked to this event.

QueueHtmlEmailCommunicationInput.htmlBody ● String! non-null scalar​

The HTML content of the email communication. This string should include only the contents of the <body> tag - EventsAir will insert this content within an HTML document as a child of the <body> element.

Notes:

  • It is the responsibility of the caller to ensure that the HTML content is valid and will display correctly for recipients.
  • This operation does not personalize content or substitute tokenized values in the HTML content. The HTML content is sent as-is.

QueueHtmlEmailCommunicationInput.isMarketing ● Boolean scalar​

A flag indicating whether the email communication is marketing material. Optional.

When not specified, the default value is false.

Member Of​

queueHtmlEmailCommunication mutation