get batch

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

get batch v15.0.1

Reads a batch back from mssgs mail: whether it was released, rejected as spam, or blocked.

In pins 2 + flow
  • flow
    flow
  • connection required
    mssgsmailconnection
  • batch guid required
    value

    The batch_guid the batch block returned.

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.

  • batch
    object

    The batch status document.

GET email/batches/:guid. Returns {status, recipient_count, spam_score, spam_action, error, subject, tag, finished_at} : never the recipients or bodies. status: checking → queued (released) | rejected (SPAM_REJECTED) | blocked (SPAM_CHECK_UNAVAILABLE). Suppressed in a simulation.

mssgsmail
mssgs mail
email
bulk
status

A typical wiring for get batch: a function trigger starts the flow; open connection feeds the connection pin; value feeds the guid pin; the flow out pin feeds debug.

Studio canvas example for the get batch block: typical wiring for get 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