Skip to content

Commit 7c08d01

Browse files
authored
Update email-logs.md with info about DeliveryStatus possible values
Add more information about message-level and recipient-level logs and their possible values for 'DeliveryStatus' property.
1 parent d3325e1 commit 7c08d01

File tree

1 file changed

+7
-4
lines changed
  • articles/communication-services/concepts/analytics/logs

1 file changed

+7
-4
lines changed

articles/communication-services/concepts/analytics/logs/email-logs.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,10 @@ Communication Services offers the following types of logs that you can enable:
9494

9595
## Email Status Update operational logs
9696

97-
*Email status update operational logs* provide in-depth insights into message and recipient level delivery status updates on your sendmail API requests. These logs offer message-specific details, such as the time of delivery, as well as recipient-level details, such as email addresses and delivery status updates. By tracking these logs, you can ensure full visibility into your email delivery process, quickly identifying any issues that may arise and taking corrective action as necessary.
97+
*Email status update operational logs* provide in-depth insights into message-level and recipient-level delivery status updates on your sendmail API requests.
98+
- Message-level status updates provide the status of the long running email send operation (similar to the status updates you receive through calling our GET APIs) through the `DeliveryStatus` property. These are marked by the absence of `RecipientId` property since these update are for the entire message and not applicable to a specific recipient in that message request. Possible values for `DeliveryStatus` are: `Dropped`, `OutForDelivery`, `Queued`.
99+
- Recipient-level status updates provide the status of email delivery for each individual recipient to whom the email was sent in a single message through the `DeliveryStatus` property. These contain a `RecipientId` property with the recipient's email address. Possible valuse for `DeliveryStatus` are: `Delivered`, `Expanded`, `Failed`, `Quarantined`, `FilteredSpam`, `Suppressed`, `Bounced`
100+
By tracking these logs, you can ensure full visibility into your email delivery process, quickly identifying any issues that may arise and taking corrective action as necessary.
98101

99102
| Property | Description |
100103
| -------- | ---------------|
@@ -104,8 +107,8 @@ Communication Services offers the following types of logs that you can enable:
104107
| `OperationVersion` | The `api-version` associated with the operation, if the `operationName` was performed using an API. If there's no API that corresponds to this operation, the version represents the version of that operation in case the properties associated with the operation change in the future. |
105108
| `Category` | The log category of the event. The category is the granularity at which you can enable or disable logs on a particular resource. The properties that appear within the properties blob of an event are the same within a particular log category and resource type. |
106109
| `CorrelationID` | The ID for correlated events. Can be used to identify correlated events between multiple tables. For all Email operational logs, the CorrelationId is mapped to the MessageId, which is returned from a successful SendMail request. |
107-
| `RecipientId` | The email address for the targeted recipient. If this is a message-level event, the property will be empty. |
108-
| `DeliveryStatus` | The terminal status of the message. |
110+
| `RecipientId` | The email address for the targeted recipient. It's only present for recipient-level events. If this is a message-level event, the property will be empty. |
111+
| `DeliveryStatus` | The terminal status of the message. Possible valuse for message-level event are: `Dropped`, `OutForDelivery`, `Queued`. Possible valuse for a recipient-level event are: `Delivered`, `Expanded`, `Failed`, `Quarantined`, `FilteredSpam`, `Suppressed`, `Bounced` |
109112
| `SmtpStatusCode` | SMTP status code returned from the recipient email server in response to a send mail request.
110113
| `EnhancedSmtpStatusCode` | Enhanced SMTP status code returned from the recipient email server.
111114
| `SenderDomain` | The domain portion of the SenderAddress used in sending emails.
@@ -160,4 +163,4 @@ Communication Services offers the following types of logs that you can enable:
160163
"EngagementContext":"https://www.contoso.com/support?id=12345",
161164
"UserAgent":"Mozilla/5.0"
162165
}
163-
```
166+
```

0 commit comments

Comments
 (0)