Skip to main content

Delivery identifier, label and category

You can use the following MIME headers to define the delivery type identifier, label and category:

  • X-Clab-SmartRelay-DeliveryId The integer-based delivery type identifier. Mandatory if you do not want the default to be applied.
  • X-Clab-SmartRelay-DeliveryLabel The delivery type label (optional).
  • X-Clab-SmartRelay-NewDeliveryType The delivery category (optional).

X-Clab-SmartRelay-DeliveryId​

  • A positive integer in the range of 2 to 4294967295 (the maximum value for a 32-bit unsigned integer)
    • 1 is reserved for the default TRANSACTIONAL delivery type identifier

If X-Clab-SmartRelay-DeliveryId is not used to assign a message a delivery type identifier, SmartRelay uses the default (1).

X-Clab-SmartRelay-DeliveryLabel​

  • An alphanumeric string of up to 150 characters
    • Only applied to the delivery if no label has previously been assigned to the delivery type identifier
    • A label cannot be changed once it has been assigned
  • The X-Clab-SmartRelay-DeliveryId header must also be specified for the message

X-Clab-SmartRelay-NewDeliveryType​

  • There are two values available:
    • TRANSACTIONAL SmartRelay does not check message recipients against any suppression list (blacklist).
    • NEWSLETTER (a bulk or marketing delivery)SmartRelay checks message recipients against the suppression list (blacklist).
      Note:
      SmartRelay does not currently carry out any suppression list (blacklist) checks for SMS messages.

Set to NEWSLETTER for new deliveries, if you do not want SmartRelay to use the default TRANSACTIONAL setting.

Once a delivery has been created, you can use the SmartRelay Web UI to change the delivery type to TRANSACTIONAL or NEWSLETTER.

Use​

Example:

Session session = Session.getInstance( System.getProperties(), null );
Message msg = new MimeMessage( session );
msg.setHeader( “X-Clab-SmartRelay-DeliveryId”, “2” );
msg.setHeader( “X-Clab-SmartRelay-DeliveryLabel”, “Welcome emails” );

or:

Session session = Session.getInstance( System.getProperties(), null );
Message msg = new MimeMessage( session );
msg.setHeader( “X-Clab-SmartRelay-DeliveryId”, “8” );
msg.setHeader( “X-Clab-SmartRelay-DeliveryLabel”, “Autumn mailing” );
msg.setHeader( “X-Clab-SmartRelay-NewDeliveryType”, “NEWSLETTER” );

If the value of X-Clab-SmartRelay-DeliveryId does not match an existing delivery type, SmartRelay automatically creates a new one.