Recipient definition

📌 Partial retries

When you send a JobRequest with multiple recipients into the same payload, asynchronous processing includes a mechanism to reprocess only the failed deliveries separately. That approach prevents the delivery of the same email multiple times to recipients who were part of a previous successful attempt.


100 vs 1000 limit

Into the REST email API, 2 important parameters define the final behavior of emails sent out: the recipients block and email address set into that recipient block.

For a REST JobRequest,

  • a maximum of 100 recipient blocks subelements can be defined. That results in sending 100 separate emails with 1 single REST JobRequest (see case n°2 below);

  • A recipient block can contain a maximum of 1000 email addresses;

  • a maximum of 1000 email addresses across all recipient blocks can be defined. That limit applies no matter which recipient field is set (To:, Cc: or Bcc:) (see case n°3 below);

  • Duplicate email addresses are counted as part of the 1000 limit.


Concrete examples:

    • A JobRequest containing 101 recipients blocks for a total of 999 “To:” email addresses set is over the limit;

    • A JobRequest containing 100 recipients blocks for a total of 1001 “To:” email address set is over the limit;

    • A JobRequest containing 100 recipients blocks for a total of 500 “To:”, “ 500 “Cc:” and +1 “Bcc:”  email addresses is over the limit.


Scenarios

The following explains how to define recipients correctly.

Case 1

Recipients will receive the same email and can see each other (like you would enter both addresses in your email client into the “To:” field).

JSON
"recipients": [{
                "mail": {
                   "to": [{"email":"recipient01@dn.com"},{"email":"recipient02@ dn.com"}],
              },
    },
    {...<next recipient-block>...}
  ],

Case 2

Recipients will receive the same email but cannot see each other.

JSON
"recipients":[{
             "mail":{
                "to":[{"email":"recipient01@dn.com"}],
             },
    },
    {
            "mail":{
                "to":[{"email":"recipient02@dn.com"}],
            },
    },
    {...<next recipient-block>...}
  ],

Case 3

Combined. All named email addresses together can have up to 1.000 recipients, no matter the way they’ve been defined.

JSON
"recipients":[{
                "mail":{
                  "to":[{"email":"recipient01@dn.com"},{"email":"recipient02@dn.com"}],
              },
      },
    {
                "mail":{
                  "cc":[{"email":"recipient03@dn.com"}],
                },
    },
    {...<next recipient-block>...}
  ],