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

# Unipile: Get Email Folder

> Get one email folder by folder_id. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Get one email folder by folder\_id.

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

## 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(
  'unipile_get_email_folder',
  {
    "folder_id": "folder_123"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute unipile_get_email_folder --input '{
  "folder_id": "folder_123"
}' --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": {
    "object": "Folder",
    "id": "id_123",
    "name": "Example",
    "account_id": "123456789",
    "role": "inbox",
    "provider_id": "provider_123"
  }
}
```

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

## Input reference

Retrieve the details of a mail folder.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.folder_id` | `string` | Yes | — | The id of the wanted folder. Either the Unipile id or the provider uid. |
| `payload.account_id` | `string` | No | — | The id of the account related to the folder. Required when using the provider uid. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Retrieve the details of a mail folder.",
    "properties": {
      "folder_id": {
        "type": "string",
        "description": "The id of the wanted folder. Either the Unipile id or the provider uid."
      },
      "account_id": {
        "type": "string",
        "description": "The id of the account related to the folder. Required when using the provider uid."
      }
    },
    "required": [
      "folder_id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.object` | `"Folder"` | Yes | — | Allowed: `Folder`. |
| `result.data.id` | `string` | Yes | — | A unique identifier. Minimum length: 1. |
| `result.data.name` | `string` | Yes | — | — |
| `result.data.account_id` | `string` | Yes | — | A unique identifier. Minimum length: 1. |
| `result.data.role` | `"inbox" \| "sent" \| "archive" \| "drafts" \| "trash" \| "spam" \| "all" \| "important" \| "starred" \| "unknown"` | Yes | — | — |
| `result.data.nb_mails` | `number` | No | — | — |
| `result.data.provider_id` | `string` | Yes | — | — |
| `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": {
          "object": {
            "type": "string",
            "enum": [
              "Folder"
            ]
          },
          "id": {
            "type": "string",
            "description": "A unique identifier.",
            "minLength": 1
          },
          "name": {
            "type": "string"
          },
          "account_id": {
            "type": "string",
            "description": "A unique identifier.",
            "minLength": 1
          },
          "role": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "inbox"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "sent"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "archive"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "drafts"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "trash"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "spam"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "all"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "important"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "starred"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "unknown"
                ]
              }
            ]
          },
          "nb_mails": {
            "type": "number"
          },
          "provider_id": {
            "type": "string"
          }
        },
        "required": [
          "object",
          "id",
          "name",
          "account_id",
          "role",
          "provider_id"
        ],
        "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

* [Unipile provider guide](https://deepline.com/docs/providers/unipile/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.