Email delivery notifications

To get email delivery notifications, create a configuration and link it to your address.

Notification typesNotification types

Notification of email acceptance by the serviceNotification of email acceptance by the service

Comes when Yandex Cloud Postbox has accepted the email for processing.

Notification example:

{
    "eventType": "Send",
    "mail": {
        "timestamp": "2024-04-25T18:05:04.84108+03:00",
        "messageId": "vgAyRUls8591ybPKeH-Ov",
        "identityId": "nWh0ZpVEgnKO1bghxydXn",
        "commonHeaders": {
            "from":[ "User <user@example.com>" ],
            "date":"Thu, 27 Jun 2024 14:05:45 +0000",
            "to":[ "Recipient Name <recipient@example.com>" ],
            "messageId":"vgAyRUls8591ybPKeH-Ov",
            "subject":"Message sent using Yandex Cloud Postbox"
        }
    },
    "send": {  },
    "eventId": "vgAyRUls8591ybPKeH-Ov:0"
}

Email delivered notificationEmail delivered notification

Comes when the email was sent and the recipient's email client has confirmed acceptance.

Notification example:

{
    "eventType": "Delivery",
    "mail": {
        "timestamp": "2024-04-25T18:05:04.84108+03:00",
        "messageId": "vgAyRUls8591ybPKeH-Ov",
        "identityId": "nWh0ZpVEgnKO1bghxydXn",
        "commonHeaders": {
            "from":[ "User <user@example.com>" ],
            "date":"Thu, 27 Jun 2024 14:05:45 +0000",
            "to":[ "Recipient Name <recipient@example.com>" ],
            "messageId":"vgAyRUls8591ybPKeH-Ov",
            "subject":"Message sent using Yandex Cloud Postbox"
        }
    },
    "bounce": null,
    "delivery": {
        "timestamp": "2024-04-25T18:05:14.84107+03:00",
        "processingTimeMillis": 9999,
        "recipients": [
            "abc@example.com"
        ]
    },
    "eventId": "ce3uqnS9pzQBMsnaAbrT_:0"
}

Email not delivered notificationEmail not delivered notification

Comes when the recipient's email client responds to a delivery attempt with an error that Yandex Cloud Postbox regards as not requiring another delivery attempt, or the recipient's address is on the stop list.

Notification example:

{
    "eventType": "Bounce",
    "mail": {
        "timestamp": "2024-04-25T18:08:04.933666+03:00",
        "messageId": "QA_JPkU2fkpIWdkxAOASH",
        "identityId": "ZtYk0rrjN87m-Ovxjte1G",
        "commonHeaders": {
            "from":[ "User <user@example.com>" ],
            "date":"Thu, 27 Jun 2024 14:05:45 +0000",
            "to":[ "Recipient Name <recipient@example.com>" ],
            "messageId":"QA_JPkU2fkpIWdkxAOASH",
            "subject":"Message sent using Yandex Cloud Postbox"
        }
    },
    "bounce": {
        "bounceType": "Permanent",
        "bounceSubType": "Undetermined",
        "bouncedRecipients": [
            {
                "emailAddress": "abc@example.com",
                "action": "failed",
                "status": "5.7.1",
                "diagnosticCode": "Other"
            }
        ],
        "timestamp": "2024-04-25T18:08:04.973666+03:00",
    },
    "delivery": null,
    "eventId": "jdMtnVniDeHqlQX8ygwEX:0"
}

Notification formatNotification format

The notification is written to the Yandex Data Streams data stream in JSON format. The list and sequence of fields may differ from those described below.

Main objectMain object

Mail objectMail object

CommonHeaders objectCommonHeaders object

Send objectSend object

Empty object.

Bounce objectBounce object

BounceRecipient objectBounceRecipient object

Delivery objectDelivery object

Quality of service (QoS) levelQuality of service (QoS) level

When delivering notifications, the service supports the QoS 1: At least once quality of service level, so it is possible to resend notifications. Identical notifications have the same eventId.

If an address is linked to a configuration that has multiple subscriptions added to it, a separate notification will come for each assignment.

ExampleExample

You sent an email to two recipients: user1@example.com and user2@other.example.com. Yandex Cloud Postbox sent it to both recipients separately.

The email client of the recipient user1@example.com accepted the email. The email client of the recipient user2@other.example.com returned an error after the first attempt to send the email and declined to accept the email after the second attempt, replying that the user was not found.

In which case you will get these three notifications:

• Notification that Yandex Cloud Postbox accepted the email for processing.
• Notification that the email was delivered to user1@example.com.
• Notification that the email was not delivered to user2@other.example.com with the error info. The notification will come after the second attempt to send the email.

Since the mail client responded that the recipient user2@other.example.com was not found, the address will be temporarily put on the stop list. You should wait for some time before trying to reach the address again, otherwise you will get notified that your message was not delivered because the recipient was on the stop list.