---
title: "get batch · RUAL Documentation"
description: "Reads a batch back from mssgs mail: whether it was released, rejected as spam, or blocked. A RUAL mssgs mail block. Block type: mssgsmailconnection_get_batch."
canonical: https://docs.rual.nl/block-types/mssgs%20mail/mssgsmailconnection_get_batch
language: en
---

[Cluster](https://docs.rual.nl/cluster)

[Blocks](https://docs.rual.nl/block-types)

[Interfaces](https://docs.rual.nl/interfaces)

[Blueprints](https://docs.rual.nl/blueprints)

[Blueprint Language](https://docs.rual.nl/engine)

[Tutorials](https://docs.rual.nl/tutorials)

[Home automation](https://docs.rual.nl/home-automation)

[Examples](https://docs.rual.nl/examples)

[Reference](https://docs.rual.nl/reference)

[Architecture](https://docs.rual.nl/architecture)

[Troubleshooting](https://docs.rual.nl/troubleshooting)

Other

# get batch

This block is part of the [`mssgs mail`](https://docs.rual.nl/block-types/mssgs%20mail) group and was last modified in core [`v15.0.1`](https://docs.rual.nl/core-versions/150001).

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

- flow `flow`

- connection required `mssgsmailconnection`

- batch guid required `value` The `batch_guid` the batch block returned.

- 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](https://docs.rual.nl/block-types/mssgs%2520mail/mssgsmailconnection_get_batch): a [function trigger](https://docs.rual.nl/block-types/globals/trigger_custom_function) starts the flow; [open connection](https://docs.rual.nl/block-types/mssgs%2520mail/mssgsmailconnection_open) feeds the `connection` pin; [value](https://docs.rual.nl/block-types/value/value_default) feeds the `guid` pin; the `flow` out pin feeds [debug](https://docs.rual.nl/block-types/state%2520ui/state_debug).

[![Studio canvas example for the get batch block: typical wiring for get batch.](https://docs.rual.nl/canvas-examples/mssgsmailconnection_get_batch.png)](https://docs.rual.nl/canvas-examples/mssgsmailconnection_get_batch.png?v=3)

## Version history

Introduced in [`v15.0.1`](https://docs.rual.nl/core-versions/150001).

- [Back to `mssgs mail`](https://docs.rual.nl/block-types/mssgs%20mail): Return to the main group to view all sub-groups

- [Back to `mssgs mail`](https://docs.rual.nl/block-types/mssgs%20mail?group=mssgs%20mail): Return to the group to view all blocks within this group

Was this page helpful? [Tell us what to improve](https://docs.rual.nl/support) · RUAL Docs is an integral component of the [RUAL ecosystem](https://rual.nl)