send email batch

This block is part of the mssgs mail group and was last modified in core v15.0.1.

send email batch v15.0.1

Sends ONE message to up to 1000 recipients, each receiving their own copy. mssgs mail spam-checks the message before releasing it; read the outcome with get batch.

In pins 9 + flow
  • flow
    flow
  • connection required
    mssgsmailconnection
  • subject required
    value

    The subject of the e-mail.

  • from
    value

    The sender, on the API key's own domain : anything else is refused with INVALID_FROM. A name can be set with Name <email@example.com>. Empty uses the service provider's default from address.

  • recipients required
    array

    1–1000 recipients: addresses, Name <email> strings or {email, name} objects.

  • html required
    value

    HTML body.

  • text version
    value

    Plain-text body. Empty strips the HTML version of its tags.

  • tag
    value

    Optional tag for grouping messages in the mssgs mail activity view.

  • metadata
    object

    Optional key/values stored with the message and returned by get message and the bounce webhook.

  • headers
    object

    Optional extra mail headers.

Out pins 4 + flow
  • flow
    flow
  • connection
    mssgsmailconnection
  • success
    condition
  • error
    value

    The refusal as CODE: message, e.g. RECIPIENT_SUPPRESSED, DOMAIN_CEILING, INVALID_FROM, INVALID_API_KEY. Empty on success.

  • response
    object

    {batch_guid, status, recipient_count} on success; the refusal body otherwise.

POST email/batch. This is bulk mail : one subject and body, many recipients : NOT an array of different emails; for per-recipient content loop the send block. success=true means the batch was accepted for checking (response.batch_guid, response.status=checking, response.recipient_count). The platform then spam-checks one representative copy: get_batch later reports status queued (released, one message per recipient), rejected (SPAM_REJECTED with spam_score) or blocked (SPAM_CHECK_UNAVAILABLE : it fails closed). The whole recipient count is charged against the domain's daily ceiling at once (DOMAIN_CEILING), and any previously bounced recipient refuses the batch (RECIPIENT_SUPPRESSED). Suppressed in a simulation.

mssgsmail
mssgs mail
email
bulk
newsletter

A typical wiring for send email batch: a function trigger starts the flow; open connection feeds the connection pin; value feeds the subject pin; with values feeds the recipients pin; value feeds the html pin; the flow out pin feeds debug.

Studio canvas example for the send email batch block: typical wiring for send email batch.

Version history

Introduced in v15.0.1.


Back to mssgs mail Return to the main group to view all sub-groups Back to mssgs mail Return to the group to view all blocks within this group