> ## 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.

# Emailguard Test Imapconnection: Inputs, Cost & CLI Example

> Test IMAP Connection. Emailguard Emailguard Test Imapconnection docs include request fields, response shape, pricing notes, and Deepline CLI examples.

## Run in Enrichment Spreadsheet

<Info>
  Use this function as a column step in `deepline enrich`.
</Info>

```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=emailguard_test_imapconnection:{"imap_username":"{{imap_username}}","imap_password":"{{imap_password}}","imap_host":"{{imap_host}}","imap_port":"{{imap_port}}"}' --json
```

<Tip>
  Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
</Tip>

## Input Schema

| Name                    | Type     | Required | Default | Description                           |
| ----------------------- | -------- | -------- | ------- | ------------------------------------- |
| `payload.imap_username` | `string` | Yes      |         | The username for IMAP authentication. |
| `payload.imap_password` | `string` | Yes      |         | The password for IMAP authentication. |
| `payload.imap_host`     | `string` | Yes      |         | The host for IMAP                     |
| `payload.imap_port`     | `string` | Yes      |         | The port for IMAP                     |
| `payload.imap_tls`      | `string` | No       |         | optional The TLS for IMAP             |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Tests the IMAP connection for the provided credentials.",
    "properties": {
      "imap_username": {
        "type": "string",
        "description": "The username for IMAP authentication."
      },
      "imap_password": {
        "type": "string",
        "description": "The password for IMAP authentication."
      },
      "imap_host": {
        "type": "string",
        "description": "The host for IMAP"
      },
      "imap_port": {
        "type": "string",
        "description": "The port for IMAP"
      },
      "imap_tls": {
        "type": "string",
        "description": "optional The TLS for IMAP"
      }
    },
    "required": [
      "imap_username",
      "imap_password",
      "imap_host",
      "imap_port"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output Schema

| Name          | Type     | Required | Default | Description                                    |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | Yes      |         | Provider response payload.                     |
| `result.meta` | `object` | No       |         | Additional response metadata (status, paging). |

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

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "additionalProperties": true
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Advanced: Direct CLI

<Info>
  Use direct execution for single payload debugging.
</Info>

```bash theme={null}
deepline tools execute emailguard_test_imapconnection --payload '{
  "imap_username": "string",
  "imap_password": "string",
  "imap_host": "string",
  "imap_port": "string"
}' --json
```

### CLI flags

| Flag                        | Description                                         |
| --------------------------- | --------------------------------------------------- |
| `--json`                    | Print machine-readable output.                      |
| `--wait`                    | Wait for terminal provider status when supported.   |
| `--debug`                   | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS`    | Max seconds to wait in wait mode.                   |
| `--poll-interval SECONDS`   | Polling interval in seconds during wait mode.       |
| `--timeout SECONDS`         | Request timeout in seconds.                         |
| `--connect-timeout SECONDS` | Connection timeout in seconds.                      |

## Cost

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