EmailLogDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Read-only DTO mirroring the `SendGridEvent` aggregate root with the noisy marketing-campaign and newsletter fields elided from the default surface.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
| Field | Type | Description |
|---|---|---|
id
required |
string (uuid) |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
eventType
required |
string |
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
email
required |
string |
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
recipients
required |
string | Every visible recipient of an outbound message, semicolon-separated: the To addresses, then the
CC addresses. Present on the gateway's send row only, and absent on rows written before it was
recorded. BCC recipients are never listed.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
fromEmail
required |
string |
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
replyToEmail
required |
string |
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
subject
required |
string |
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
timestamp
required |
string (date-time) |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
internalEventId
required |
string |
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
internalMessageId
required |
string |
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
messageId
required |
string |
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
correlationId
required |
string (uuid) |
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
kind
required |
string | What kind of message the row belongs to, for example `Receipt`, `Invoice` or
`SecurityAlert`. Absent when the message declared no kind, and on rows recorded before
kinds were recorded.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
bypassedSuppression
required |
boolean | `true` when the message was sent past the bounce, spam-report and global unsubscribe
suppression lists, which applies only to account-critical kinds such as `PasswordReset`
and `SecurityAlert`. Present only on the gateway's send row for a message the mail
provider accepted; absent on every other row, on a failed send, and on rows recorded before
the bypass existed.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
isSenderDomainAuthenticated
required |
boolean |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
scope
required |
EmailLogScopeDto EmailLogScopeDto | Read-only projection of the gateway scope under which an email row was recorded. Mirrors
the domain `Scope` value object; `Empty` / `null`
sentinels carry the same meaning (system-scoped or host-scoped).
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
Fields of EmailLogScopeDto: This body has no documented fields. | ||
uniqueArguments
required |
object |
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This model has no documented fields.