Skip to main content

SendEmailResult

The result of sending an email.

type SendEmailResult {
  emailActivityId: String
  error: String
  message: String!
  messageId: String
  replyToAddress: String
  success: Boolean!
}

Fields​

SendEmailResult.emailActivityId ● String scalar​

The ID of the activity record for the email.

SendEmailResult.error ● String scalar​

Why it failed, if it did.

SendEmailResult.message ● String! non-null scalar​

A message about the outcome.

SendEmailResult.messageId ● String scalar​

The email provider's ID for the message.

SendEmailResult.replyToAddress ● String scalar​

The address replies will go to.

SendEmailResult.success ● Boolean! non-null scalar​

True when the email was sent.

Returned By​

composeEmail mutation ● sendCreditNoteEmail mutation ● sendDebitNoteEmail mutation ● sendPurchaseOrderEmail mutation ● sendSalesOrderEmail mutation ● sendSalesOrderPaymentReminder mutation ● sendSalesOrderReply mutation