Skip to main content
Skip table of contents

Notification Samples

PRE_PROCESS

PREVIOUSLY_BOUNCED

Phase:             PRE_PROCESS
Type:               DROPPED
State:               FINISHED
Subtype:          PREVIOUSLY_BOUNCED

JSON 
{
  "meta":{
    "account":"m4a_test_user",
    "customerNo":"99999",
    "tenant":"Test User",
    "receivedTs":"2020-10-16T05:58:43.487Z",
    "jobId":"7e5251d9-8661-43c3-bb00-0c1caf168c3f",
    "version":"1"
  },
  "notifications":[
    {
      "meta":{
        "tag":"e014f03fdab1153427faa64e7103a63dce5dfec3bb74602be2bab31d0db9aa71",
        "mail":{
          "id":"7e5251d9-8661-…-7f3b-472e-8d02-5735ef65cc0c",
          "email":"recipient@sample.com",
          "from":"sender@sample.com",
          "mimeFrom":"sender@sample.com"  //optional
        },
        "event":{
          "type":"DROPPED",
          "phase":"PRE_PROCESS",	// optional
          "state":"FINISHED",	// optional
          "subType":"PREVIOUSLY_BOUNCED",	// optional
          "ts":"2020-10-16T05:58:43.535Z",
          "description":"ts=\"2020-07-28T04:16:06.448Z\", reason=\"[5.2.0] bounced (host mx-in02.eu.retarus.com[94.199.89.39] said: 550 5.2.0 mailbox unavailable. \""
        )
      }
    }
  ]
}

FORBIDDEN_RECIPIENT

Phase:             PRE_PROCESS
Type:               DROPPED
State:               FINISHED
Subtype:          FORBIDDEN_RECIPIENT

JSON 
{
   "meta":{
      "account":"m4a_test_user",
      "customerNo":"99999",
      "tenant":"Test User", //optional
      "receivedTs":"2020-10-16T06:38:24.774Z",
      "jobId":"7e5251d9-8661-43c3-bb00-0c1caf168c3f",
      "version":"1"
   },
   "notifications":[
      {
         "meta":{
            "tag":"fe5f6eba9d910ac646bad72e3b10024556c169774feeb2ee2b6c1e99c8962f0b",
            "mail":{
               "id":"00194e4e-f4ff-…-41d8-ae79-e48c95429c52",
               "email":"recipient@sample.com",
               "from":"sender@sample.com",
               "mimeFrom":"sender@sample.com" //optional
            },
            "event":{
               "type":"DROPPED",
               "phase":"PRE_PROCESS", //optional
               "state":"FINISHED",  //optional
               "subType":"FORBIDDEN_RECIPIENT", //optional
               "ts":"2020-10-16T06:38:24.884Z",
               "description":"Reason: Local part forbidden by config" //optional
            }
         }
      }
   ]
}

INVALID_ADDRESS

Phase:             PRE_PROCESS
Type:               DROPPED
State:               FINISHED
Subtype:          INVALID_ADDRESS

JSON 
{
   "meta":{
      "account":"m4a_test_user",
      "customerNo":"99999",
      "tenant":"Test User", //optional
      "receivedTs":"2020-10-16T06:41:46.604Z",
      "jobId":"7e5251d9-8661-43c3-bb00-0c1caf168c3f",
      "version":"1"
   },
   "notifications":[
      {
         "meta":{
            "tag":"9d6a9d0b33174441459ede813b5f1060103cb3576089424bd926e30f4b1a2272",
            "mail":{
               "id":"470da7c0-acd5-…9d16-b775d8b761e6",
               "email":"recipient@sample.com",
               "from":"sender@sample.com",
               "mimeFrom":"sender@sample.com" //optional
            },
            "event":{
               "type":"DROPPED",
               "phase":"PRE_PROCESS", //optional
               "state":"FINISHED",  //optional
               "subType":"INVALID_ADDRESS", //optional
               "ts":"2020-10-16T06:41:46.725Z"
            }
         }
      }
   ]
}

VALIDATION_ERROR

Phase:             PRE_PROCESS
Type:               DROPPED
State:               FINISHED
Subtype:          VALIDATION_ERROR

JSON 
{
   "meta":{
      "account":"m4a_test_user",
      "customerNo":"99999",
      "tenant":"Test User",
      "receivedTs":"2020-10-16T06:41:46.604Z",
      "jobId":"rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c",
      "version":"1"
   },
   "notifications":[
      {
         "meta":{
            "tag":"9d6a9d0b33174441459ede813b5f1060103cb3576089424bd926e30f4b1a2272",
            "mail":{
               "id":"rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c",
               "email":"recipient <recipient@sample.com>",
               "from":"sender@sample.com",
               "mimeFrom":"sender@sample.com"
            },
            "event":{
               "type":"DROPPED",
               "phase":"PRE_PROCESS",
               "state":"FINISHED",
               "subType":"VALIDATION_ERROR",
               "ts":"2020-10-16T06:41:46.725Z"
            }
         }
      }
   ]
}

PROCESS

PROCESSING_STARTED

Phase:             PROCESS
Type:               STARTED
State:               INITIAL
Subtype:          PROCESSING_STARTED

JSON 
{
   "meta":{
      "account":"m4a_test_user",
      "customerNo":"99999",
      "tenant":"Test User", //optional
      "receivedTs":"2020-10-16T05:42:08.106Z",
      "jobId":"7e5251d9-8661-43c3-bb00-0c1caf168c3f",
      "version":"1"
   },
   "notifications":[
      {
         "meta":{
            "tag":"4c95541c6739d08a4a8c01c5bfb05bcac82c3111ddcf50ed63c75ac24fbf8483",
            "mail":{
               "id":"48b90838-…-ca200e692a8c",
               "email":"recipient@sample.com",
               "from":"sender@sample.com",
               "mimeFrom":"sender@sample.com" //optional
            },
            "event":{
               "type":"STARTED",
               "phase":"PROCESS", //optional
               "state":"INITIAL", //optional
               "subType":"PROCESSING_STARTED",  //optional
               "ts":"2020-10-16T05:42:08.247Z",
               "description":"Mime message generated."  //optional
            }
         },
         "content":{        //optional
            "mime":{        //optional
               "size":"973" //optional
            }
         }
      }
   ]
}

VIRUS_DETECTED

Phase:             PROCESS
Type:               DROPPED
State:               FINISHED
Subtype:          VIRUS_DETECTED

JSON 
{
   "notifications":[
      [
         {
            "meta":{
               "event":{
                  "description":"Job processing successfully started.",
                  "phase":"PROCESS",
                  "state":"INITIAL",
                  "subType":"PROCESSING_STARTED",
                  "ts":"2020-11-14T13:14:05.423Z",
                  "type":"STARTED"
               },
               "mail":{
                  "email":"recipient@sample.com",
                  "from":"sender@sample.com",
                  "id":"186248a8-b695-49be-ba51-bbc0b8e7931a#85213bcf#85b5fb36",
                  "mimeFrom":" sender@sample.com "
               },
               "tag":"092212c3c19124a3400ba3d742cc77ec36ea4f48b4e4271eb9d2d5f703ae2ba8"
            }
         }
      ],
      [
         {
            "meta":{
               "event":{
                  "description":"INFECTED: attachments <attachment_name> are infected.",
                  "phase":"PROCESS",
                  "state":"FINISHED",
                  "subType":"VIRUS_DETECTED",
                  "ts":"2020-11-14T13:14:05.699Z",
                  "type":"DROPPED"
               },
               "mail":{
                  "email":" recipient@sample.com ",
                  "from":" sender@sample.com ",
                  "id":"186248a8-b695-49be-ba51-bbc0b8e7931a#85213bcf#85b5fb36",
                  "mimeFrom":" sender@sample.com "
               },
               "tag":"1daaa3a665636cf44844b68b33dc0573ca1f0d6ee96d7e079c488490305c1d79"
            }
         }
      ]
   ]
}

PROCESSING_FINISHED

Phase:             PROCESS
Type:               FINISHED
State:               INTERMEDIATE
Subtype:          PROCESSING_FINISHED

JSON 
{
   "meta":{
      "account":"m4a_test_user",
      "customerNo":"99999",
      "tenant":"Test User", //optional
      "receivedTs":"2020-10-16T05:42:08.106Z",
      "jobId":"7e5251d9-8661-43c3-bb00-0c1caf168c3f",
      "version":"1"
   },
   "notifications":[
      {
         "meta":{
            "tag":"252db60267fe7b3d6160bcfd4876687e46f53182ec6a36f22f9a99a419292628",
            "mail":{
               "id":"48b90838-…87f3-ca200e692a8c",
               "email":"recipient@sample.com",
               "from":"sender@sample.com",
               "mimeFrom":"sender@sample.com" //optional
            },
            "event":{
               "type":"PROCESSED",
               "phase":"PROCESS", //optional
               "state":"INTERMEDIATE",  //optional
               "subType":"PROCESSING_FINISHED", //optional
               "ts":"2020-10-16T05:42:08.000Z",
               "description":"mail enqueued"  //optional
            }
         },
         "content":{
            "mime":{  //optional
               "messageId":"<20201016-…0e692a8c@retarus.com>",  //optional
               "size":"973" //optional
            }
         }
      }
   ]
}

DELIVER

OK

Phase:             DELIVER
Type:               DELIVERED
State:               FINISHED
Subtype:          OK

JSON 
{
   "meta":{
      "account":"m4a_test_user",
      "customerNo":"99999",
      "tenant":"Test User", //optional
      "receivedTs":"2020-10-16T05:54:11.043Z",
      "jobId":"7e5251d9-8661-43c3-bb00-0c1caf168c3f",
      "version":"1"
   },
   "notifications":[
      {
         "meta":{
            "tag":"a813f47bca9ded6b0305885e235c073e886168b8b63eb5e99d02d00bcc7a6371",
            "mail":{
               "id":"6393ae2f-7c…-862b-880754463a38",
               "email":"recipient@sample.com",
               "from":"sender@sample.com",
               "mimeFrom":"sender@sample.com" //optional
            },
            "event":{
               "type":"DELIVERED",
               "phase":"DELIVER",   //optional
               "state":"FINISHED",  //optional
               "subType":"OK",      //optional
               "ts":"2020-10-16T05:54:18.000Z",
               "description":"mail delivered" //optional
            }
         },
         "content":{  //optional
            "mime":{  //optional
               "messageId":"<20201016-…54463a38@retarus.com>",  //optional
               "size":"884" //optional
            },
            "smtp":{  //optional
               "responseCode":"250",
               "reason":"sent (250 2.0.0 Ok: queued as 3yFnZW2mNlzPk9y)", //optional
               "relay":"mailin4.rmx.de[82.135.18.227]:25",  //optional
               "dsn":"2.0.0",
               "transportEncryption":{  //optional
                  "requested":true,     //optional
                  "established":true,   //optional
                  "properties":{        //optional
                     "protocol":"TLS1.2", //optional
                     "cipherSuite":"“example-cipher-suite" //optional
                  }
               }
            }
         }
      }
   ]
}

SOFT_BOUNCE (intermediate)

Phase:             DELIVER
Type:               DELIVERED
State:               INTERMEDIATE
Subtype:          SOFT_BOUNCE

JSON 
{
   "meta":{
      "account":"m4a_test_user",
      "customerNo":"99999",
      "tenant":"Test User",
      "receivedTs":"2020-10-16T05:42:08.106Z",
      "jobId":"rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c",
      "version":"1"
   },
   "notifications":[
      {
         "meta":{
            "tag":"f7ad03bb2e2cece0194d2d9798dc6574d7e47f92e6cbc60c98529237f16b4924",
            "mail":{
               "id":"rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c",
               "email":"recipient <recipient@sample.com>",
               "from":"sender@sample.com",
               "mimeFrom":"sender@sample.com"
            },
            "event":{
               "type":"DEFERRED",
               "phase":"DELIVER",
               "state":"INTERMEDIATE",
               "subType":"SOFT_BOUNCE",
               "ts":"2020-10-16T05:42:09.000Z",
               "description":"delivery attempt failed"
            }
         },
         "content":{
            "mime":{
               "messageId":"<20201016-…-aa1e- -87f3-cac@retarus.com>",
               "size":"973"
            },
            "smtp":{
               "responseCode":"400",
               "reason":"deferred (host mx.sample.com[94.231.123.123] said: 450 4.1.8 <recipient@sample.com>: Sender address rejected: Domain not found (in reply to RCPT TO command))",
               "relay":"mx.sample.com[94.231.123.123]:25",
               "dsn":"4.1.8"
            }
         }
      }
   ]
}

SOFT_BOUNCE (finished)

Phase:             DELIVER
Type:               BOUNCED
State:               FINISHED
Subtype:          SOFT_BOUNCE

JSON 
{  
   "meta":{  
      "account":"m4a_test_user",
      "customerNo":"99999",
      "tenant":"Test User",
      "receivedTs":"2020-10-16T06:02:50.678Z",
      "jobId":"rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c",
      "version":"1"
   },
   "notifications":[  
      {  
         "meta":{  
            "tag":"acafe0bab35289f8d4c09a8be3855dcf56618f27f257e83ebea5d07a062fdf4e",
            "mail":{  
               "id":"rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c",
               "email":"recipient <recipient@sample.com>",
               "from":"sender@sample.com",
               "mimeFrom":"sender@sample.com"
            },
            "event":{  
               "type":"BOUNCED",
               "phase":"DELIVER",
               "state":"FINISHED",
               "subType":"SOFT_BOUNCE",
               "ts":"2020-10-16T06:02:50.000Z",
               "description":"retries exceeded”
            }
         },
         "content":{  
            "mime":{  
               "messageId":"<rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c@retarus.com>",
               "size":"886"
            },
            "smtp":{  
               "responseCode":"400",
               "reason":"deferred (host mx.sample.com[94.231.123.123] said: 450 4.1.8 <recipient@sample.com>: Sender address rejected: Domain not found (in reply to RCPT TO command))",
               "relay":"mx.sample.com[94.231.123.123]:25",
               "dsn":"4.1.8"
            }
         }
      }
   ]
}

HARD_BOUNCE

Phase:             DELIVER
Type:               BOUNCED
State:               FINISHED
Subtype:          HARD_BOUNCE

JSON 
{
   "meta":{
      "account":"m4a_test_user",
      "customerNo":"99999",
      "tenant":"Test User", //optional
      "receivedTs":"2020-10-16T06:02:50.678Z",
      "jobId":"7e5251d9-8661-43c3-bb00-0c1caf168c3f",
      "version":"1"
   },
   "notifications":[
      {
         "meta":{
            "tag":"acafe0bab35289f8d4c09a8be3855dcf56618f27f257e83ebea5d07a062fdf4e",
            "mail":{
               "id":"…2-ac35-942840c4a989",
               "email":"recipient@sample.com",
               "from":"sender@sample.com",
               "mimeFrom":"sender@sample.com" //optional
            },
            "event":{
               "type":"BOUNCED",
               "phase":"DELIVER",   //optional
               "state":"FINISHED",  //optional
               "subType":"HARD_BOUNCE", //optional
               "ts":"2020-10-16T06:02:50.000Z",
               "description":"delivery attempt failed"  //optional
            }
         },
         "content":{  //optional
            "mime":{  //optional
               "messageId":"<20201016-…c4a989@retarus.com>",  //optional
               "size":"886" //optional
            },
            "smtp":{  //optional
               "responseCode":"500",
               "reason":"bounced (Host or domain name not found. Name service error for name=sample.com type=A: Host not found)", //optional
               "relay":"none",  //optional
               "dsn":"5.4.4"    //optional
            }
         }
      }
   ]
}

SMART_DELIVERY

OK

Phase:             SMART_DELIVERY
Type:               DELIVERED
State:               FINISHED
Subtype:          OK

JSON 
{
   "meta":{
      "account":"m4a_test_user",
      "customerNo":"99999",
      "tenant":"Test User",
      "receivedTs":"2020-10-16T05:54:11.043Z",
      "jobId":"rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c",
      "version":"1"
   },
   "notifications":[
      {
         "meta":{
            "tag":"a813f47bca9ded6b0305885e235c073e886168b8b63eb5e99d02d00bcc7a6371",
            "mail":{
               "id":"rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c",
               "email":"recipient <recipient@sample.com>",
               "from":"sender@sample.com",
               "mimeFrom":"sender@sample.com"
            },
            "event":{
               "type":"DELIVERED",
               "phase":"SMART_DELIVERY",
               "state":"FINISHED",
               "subType":"OK",
               "ts":"2020-10-16T05:54:18.000Z",
               "description":"mail delivered"
            }
         },
         "content":{
            "mime":{
               "messageId":"<20201016-…54463a38@retarus.com>",
               "size":"884"
            },
            "smtp":{
               "responseCode":"250",
               "reason":"sent (250 2.0.0 Ok: queued as 3yFnZW2mNlzPk9y)",
               "relay":"mailin4.rmx.de[82.135.18.227]:25",
               "dsn":"2.0.0",
               "transportEncryption":{
                  "requested":true,
                  "established":true,
                  "properties":{
                     "protocol":"TLS1.2",
                     "cipherSuite":"example-cipher-suite"
                  }
               }
            }
         }
      }
   ]
}

PROCESSING_FINISHED

Phase:             SMART_DELIVERY
Type:               FINISHED
State:               INTERMEDIATE
Subtype:          PROCESSING_FINISHED

JSON 
{
   "meta":{
      "account":"m4a_test_user",
      "customerNo":"99999",
      "tenant":"Test User",
      "receivedTs":"2020-10-16T05:42:08.106Z",
      "jobId":"rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c",
      "version":"1"
   },
   "notifications":[
      {
         "meta":{
            "tag":"252db60267fe7b3d6160bcfd4876687e46f53182ec6a36f22f9a99a419292628",
            "mail":{
               "id":"rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c",
               "email":"recipient <recipient@sample.com>",
               "from":"sender@sample.com",
               "mimeFrom":"sender@sample.com"
            },
            "event":{
               "type":"PROCESSED",
               "phase":"SMART_DELIVERY",
               "state":"INTERMEDIATE",
               "subType":"PROCESSING_FINISHED",
               "ts":"2020-10-16T05:42:08.000Z",
               "description":"mail enqueued"
            }
         },
         "content":{
            "mime":{
               "messageId":"<20201016-…0e692a8c@retarus.com>",
               "size":"973"
            }
         }
      }
   ]
}

POST_PROCESS

INFORMATION

Phase:             POST_PROCESS
Type:               SPAM_SCORE_CHECK
State:               POST_DELIVERY
Subtype:          INFORMATION

JSON 
{
   "meta":{
      "account":"m4a_test_user",
      "customerNo":"99999",
      "tenant":"Test User",
      "receivedTs":"2020-10-16T05:42:08.106Z",
      "referenceJob":"rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c",
      "version":"1"
   },
   "notifications":[
      {
         "meta":{
            "tag":"252db60267fe7b3d6160bcfd4876687e46f53182ec6a36f22f9a99a419292628",
            "mail":{
               "id":"rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c",
               "from":"sender@sample.com"
            },
            "event":{
               "type":"SPAM_SCORE_CHECK",
               "phase":"POST_PROCESS",
               "state":"POST_DELIVERY",
               "subType":"INFORMATION",
               "ts":"2020-10-16T05:42:08.000Z"
            }
         },
         "content":{
            "mime":{
               "messageId":"<20201016-…0e692a8c@retarus.com>"
            },
            "spamscore":{
               "reslut":"45"
            }
         }
      }
   ]
}

READ

MAIL_OPENED (REST only)

Phase:             READ
Type:               OPEN
State:               POST_DELIVERY
Subtype:          MAIL_OPENED

CODE 
"meta": {
        "version": "1",
        "jobId": "rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c",
        "receivedTs": "2020-09-27T16:22:27.605Z",
        "account": "m4a_test_user",
        "customerNo": "99999",
        "tenant": "Test User",                                   // optional
        "campaignId": "Newsletter004.2020",                      // optional
        "referenceJob": "rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c",                            // optional
        "trackEndTs": "2020-10-27T16:22:27.605Z"                 // optional 
    },
    "notifications": [
        {
            "meta": {
                "tag": "a813f4b0305885…8b63eb5e99d02d00bcc7a6371",
                "mail": {
                    "id": "rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c",
                    "email": "recipient <recipient@example.com>",
                    "from": "sender@example.com",
                    "mimeFrom": "sender@example.com"             // optional
                },
                "event": {
                    "type": "OPEN", 
                    "phase": "READ",                             // optional
                    "state": "POST_DELIVERY",                    // optional
                    "subType":"MAIL_OPENED",                     // optional
                    "ts": "2020-10-16T05:54:18.000Z",
                    "description": "mail opened"                 // optional
                }
            },
            "content": {
                "open": {
                    "ip": "123.456.789",
                    "userAgent": "Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/64.0.3282.167 Safari/537.36",
                    "device": {
                        "type": "Computer",                      // optional
                        "brand": "Other",                        // optional
                        "model”: "Other",                        // optional
                        "hasTouch”: false
                    }
                    "os": {
                        "name":"Windows 7",                      // optional
                        "version": "Unknown"                     // optional
                     },
                     "client": {
                        "name":"Chrome",                         // optional
                        "version": "64.0.3282",                  // optional
                        "isMail": false                          // optional
                     }
                }
            }
        }
    ]
}

Phase:             READ
Type:               CLICK
State:               POST_DELIVERY
Subtype:          LINK_CLICKED

CODE 
{
    "meta": {
        "version": "1",
        "jobId": "rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c",
        "receivedTs": "2020-09-27T16:22:27.605Z",
        "account": "m4a_test_user",
        "customerNo": "99999",
        "tenant": "Test User",                                  // optional
        "campaignId": "Newsletter004.2020",                     // optional
        "referenceJob": "rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c",                           // optional
        "trackEndTs": "2020-10-27T16:22:27.605Z"                // optional
    },
    "notifications": [
        {
            "meta": {
                "tag": "a813f47bc..b63eb5e99d02d00bcc7a6371",
                "mail": {
                    "id": "rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c",
                    "email": "recipient <recipient@example.com>",
                    "from": "sender@example.com",
                    "mimeFrom": "sender@example.com"            // optional
                },
                "event": {
                    "type": "CLICK",                            
                    "phase": "READ",                            // optional
                    "state": "POST_DELIVERY",                   // optional
                    "subType":"MAIL_CLICKED",		     // optional
                    "ts": "2020-10-16T05:54:18.000Z",
                    "description": "mail opened"                // optional
                }
            },
            "content": {
                "click": {
                    "url": "http://www.retarus.com",
                    "ip": "123.456.789",
                    "userAgent": "Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/64.0.3282.167 Safari/537.36",
                    "device": {
                        "type": "Computer",                      // optional
                        "brand": "Other",                        // optional
                        "model”: "Other",                        // optional
                        "hasTouch”: false
                    }
                    "os": {
                        "name":"Windows 7",                      // optional
                        "version": "Unknown"                     // optional
                     },
                     "client": {
                        "name":"Chrome",                         // optional
                        "version": "64.0.3282",                  // optional
                        "isMail": false                          // optional
                     }
                }
            }
        }
    ]
}

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close