> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# BounceBan: Get Bulk Emails

> Get the verification results for specific email addresses within a bulk verification task. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

Get the verification results for specific email addresses within a bulk verification task.

> [!NOTE]
>
> Tool ID: `bounceban_get_bulk_emails`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'bounceban_get_bulk_emails',
  {
    "id": "id_123",
    "emails": [
      "jane.doe@example.com"
    ]
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute bounceban_get_bulk_emails --input '{
  "id": "id_123",
  "emails": [
    "jane.doe@example.com"
  ]
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "result": "ok",
    "status": "importing",
    "items": [
      {
        "status": "success",
        "email": "jane.doe@example.com",
        "result": "deliverable"
      }
    ]
  }
}
```

Use `deepline describe bounceban_get_bulk_emails --json` for the latest machine-readable contract.

## Input reference

To retrieve verification results for specific emails from your bulk verification task, provide the task ID along with the chosen email addresses.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.id` | `string` | Yes | — | (Required) Bulk email verification task ID. |
| `payload.emails` | `array` | Yes | — | Specify the list of emails to retrieve verification results, with a maximum limit of 100 emails. Include only emails from the bulk verification task associated with the given task ID. Maximum items: 100. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "To retrieve verification results for specific emails from your bulk verification task, provide the task ID along with the chosen email addresses.",
    "properties": {
      "id": {
        "type": "string",
        "description": "(Required) Bulk email verification task ID."
      },
      "emails": {
        "type": "array",
        "description": "Specify the list of emails to retrieve verification results, with a maximum limit of 100 emails. Include only emails from the bulk verification task associated with the given task ID.",
        "maxItems": 100,
        "items": {
          "type": "string"
        }
      }
    },
    "required": [
      "id",
      "emails"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.result` | `"ok" \| "err"` | No | — | > `ok` Indicates the request is successful. > `err` The bulk task has not finished yet, please try again later. Allowed: `ok`, `err`. |
| `result.data.status` | `"importing" \| "verifying" \| "finished"` | No | — | Bulk email verification task status. > `importing` indicates the list of emails are being imported for verification. > `verifying` indicates all the emails are imported and are being verified. > `finished` indicates verification for the whole list has finished. Allowed: `importing`, `verifying`, `finished`. |
| `result.data.items` | `array` | No | — | Detailed verification results for each email. |
| `result.data.items[].status` | `"success" \| "verifying" \| "queue"` | No | — | Verification status for this task. > `success` indicates the task is finished and the final verification result can be returned. > `verifying` indicates the email is still being verified. > `queue` indicates the email is still being in queue. Allowed: `success`, `verifying`, `queue`. |
| `result.data.items[].email` | `string` | No | — | The email address submitted for verification. |
| `result.data.items[].result` | `"deliverable" \| "risky" \| "undeliverable" \| "unknown"` | No | — | The state (verification result) for the email. Allowed: `deliverable`, `risky`, `undeliverable`, `unknown`. |
| `result.data.items[].score` | `integer` | No | — | The score (0 \~ 100) represents the deliverability of an email - the higher, the better. Minimum: 0. Maximum: 100. |
| `result.data.items[].is_disposable` | `boolean` | No | — | Whether the email is disposable. |
| `result.data.items[].is_accept_all` | `boolean` | No | — | Whether the email is accept-all. |
| `result.data.items[].is_role` | `boolean` | No | — | Whether the email is role based. |
| `result.data.items[].is_free` | `boolean` | No | — | Whether the email is a free email. |
| `result.data.items[].mx_records` | `array` | No | — | All MX records for the email. |
| `result.data.items[].smtp_provider` | `string` | No | — | SMTP provider based on the main MX record, e.g. if the MX record for an email is `alt1.aspmx.l.google.com`, then the smtp provider will be `Google`. |
| `result.data.items[].mode` | `string` | No | — | Verification mode. |
| `result.data.items[].verify_at` | `string` | No | — | The time the verification task finished. Format: `date-time`. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "result": {
            "type": "string",
            "description": "> `ok` Indicates the request is successful. > `err` The bulk task has not finished yet, please try again later.",
            "enum": [
              "ok",
              "err"
            ]
          },
          "status": {
            "type": "string",
            "description": "Bulk email verification task status. > `importing` indicates the list of emails are being imported for verification. > `verifying` indicates all the emails are imported and are being verified. > `finished` indicates verification for the whole list has finished.",
            "enum": [
              "importing",
              "verifying",
              "finished"
            ]
          },
          "items": {
            "type": "array",
            "description": "Detailed verification results for each email.",
            "items": {
              "type": "object",
              "description": "Verification result for this task.",
              "properties": {
                "status": {
                  "type": "string",
                  "description": "Verification status for this task. > `success` indicates the task is finished and the final verification result can be returned. > `verifying` indicates the email is still being verified. > `queue` indicates the email is still being in queue.",
                  "enum": [
                    "success",
                    "verifying",
                    "queue"
                  ]
                },
                "email": {
                  "type": "string",
                  "description": "The email address submitted for verification."
                },
                "result": {
                  "type": "string",
                  "description": "The state (verification result) for the email.",
                  "enum": [
                    "deliverable",
                    "risky",
                    "undeliverable",
                    "unknown"
                  ]
                },
                "score": {
                  "type": "integer",
                  "description": "The score (0 ~ 100) represents the deliverability of an email - the higher, the better.",
                  "minimum": 0,
                  "maximum": 100
                },
                "is_disposable": {
                  "type": "boolean",
                  "description": "Whether the email is disposable."
                },
                "is_accept_all": {
                  "type": "boolean",
                  "description": "Whether the email is accept-all."
                },
                "is_role": {
                  "type": "boolean",
                  "description": "Whether the email is role based."
                },
                "is_free": {
                  "type": "boolean",
                  "description": "Whether the email is a free email."
                },
                "mx_records": {
                  "type": "array",
                  "description": "All MX records for the email.",
                  "items": {
                    "type": "string"
                  }
                },
                "smtp_provider": {
                  "type": "string",
                  "description": "SMTP provider based on the main MX record, e.g. if the MX record for an email is `alt1.aspmx.l.google.com`, then the smtp provider will be `Google`."
                },
                "mode": {
                  "type": "string",
                  "description": "Verification mode."
                },
                "verify_at": {
                  "type": "string",
                  "description": "The time the verification task finished.",
                  "format": "date-time"
                }
              },
              "additionalProperties": false
            }
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [BounceBan provider guide](https://deepline.com/docs/providers/bounceban/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.