Adding new statuses and a property to EmailDeliveryReportReceived Event (#23593)

* Adding new status to EmailDeliveryReportReceived Event

Adding new status value "Suppressed" to EmailDeliveryReportReceived Event in AcsEvents

* Adding new property to Email event

* Adding new status

* Updates from feedback.

* Adding description for the enum

* Fix Prettier check

* Update description

* Updating example

* Updated swagger object def

* Updating property name

* renaming property

Author: anmolbohra97

specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json

@@ -519,19 +519,51 @@
           "type": "string"
         },
         "status": {
-          "description": "The status of the email",
+          "description": "The status of the email. Any value other than Delivered is considered failed.",
           "type": "string",
           "enum": [
-            "Failed",
+            "Bounced",
             "Delivered",
+            "Failed",
             "FilteredSpam",
-            "Quarantined"
+            "Quarantined",
+            "Suppressed"
           ],
           "x-ms-enum": {
             "name": "AcsEmailDeliveryReportStatus",
-            "modelAsString": true
+            "modelAsString": true,
+            "values": [
+              {
+                "value": "Bounced",
+                "description": "Hard bounce detected while sending the email"
+              },
+              {
+                "value": "Delivered",
+                "description": "The email was delivered"
+              },
+              {
+                "value": "Failed",
+                "description": "The email failed to be delivered"
+              },
+              {
+                "value": "FilteredSpam",
+                "description": "The message was identified spam and was rejected or blocked (not quarantined)."
+              },
+              {
+                "value": "Quarantined",
+                "description": "The message was quarantined (as spam, bulk mail, or phishing). For more information, see Quarantined email messages in EOP (EXCHANGE ONLINE PROTECTION)."
+              },
+              {
+                "value": "Suppressed",
+                "description": "The email was suppressed"
+              }
+            ]
           }
         },
+        "deliveryStatusDetails": {
+          "description": "Detailed information about the status if any",
+          "$ref": "#/definitions/AcsEmailDeliveryReportStatusDetails"
+        },
         "deliveryAttemptTimeStamp": {
           "description": "The time at which the email delivery report received timestamp",
           "format": "date-time",
@@ -819,6 +851,16 @@
           "type": "string"
         }
       }
+    },
+    "AcsEmailDeliveryReportStatusDetails": {
+      "description": "Detailed information about the status if any",
+      "type": "object",
+      "properties": {
+        "statusMessage": {
+          "description": "Detailed status message",
+          "type": "string"
+        }
+      }
     }
   }
 }

specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/email_delivery_report_received.json

@@ -7,7 +7,10 @@
     "recipient": "test1@contoso.com",
     "messageId": "950850f5-bcdf-4315-b77a-6447cf56fac9",
     "status": "delivered",
-    "deliveryAttemptTimeStamp": "2023-02-09T19:46:12.2480265+00:00"
+    "deliveryAttemptTimeStamp": "2023-02-09T19:46:12.2480265+00:00",
+    "deliveryStatusDetails": {
+      "statusMessage": "DestinationMailboxFull"
+    }
   },
   "eventType": "Microsoft.Communication.EmailDeliveryReportReceived",
   "dataVersion": "1.0",