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

# Outreach: List Mailboxes

> List the sending mailboxes connected to Outreach. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

List the sending mailboxes connected to Outreach.

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

## 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(
  'outreach_list_mailboxes',
  {
    "newFilterSyntax": true,
    "page_size": 123,
    "page_after": "cursor_123"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute outreach_list_mailboxes --input '{
  "newFilterSyntax": true,
  "page_size": 123,
  "page_after": "cursor_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": {
    "data": [
      {
        "attributes": {
          "authId": 1,
          "createdAt": "2026-01-15T12:00:00Z",
          "editable": false
        },
        "id": 123,
        "relationships": {
          "creator": {},
          "mailAliases": {},
          "mailings": {}
        }
      }
    ]
  }
}
```

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

## Input reference

Get a Collection of Mailboxes

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.newFilterSyntax` | `boolean` | No | — | Use Outreach array/range filter syntax for literal commas and ranges. |
| `payload.page_size` | `integer` | No | — | Cursor page size sent as page\[size]. Minimum: 1. Maximum: 1000. |
| `payload.page_after` | `string` | No | — | Cursor returned by the previous page. |
| `payload.page_before` | `string` | No | — | Cursor returned by the next page. |
| `payload.page_limit` | `integer` | No | — | Deprecated offset-pagination limit sent as page\[limit]. Prefer page\_size. Minimum: 1. Maximum: 1000. |
| `payload.page_offset` | `integer` | No | — | Deprecated offset-pagination offset sent as page\[offset]. Prefer cursors. Minimum: 0. Maximum: 10000. |
| `payload.count` | `boolean` | No | — | Request Outreach total-count metadata. false is faster for pagination. |
| `payload.sort` | `string` | No | — | Comma-separated sortable fields. prefix a field with - for descending order. |
| `payload.include` | `string` | No | — | Comma-separated related resources to include. |
| `payload.provideAuthorizationMeta` | `boolean` | No | — | Request resource authorization metadata. |
| `payload.fields` | `object` | No | — | Sparse fieldsets keyed by JSON:API resource type, sent as fields\[resource]. |
| `payload.filters` | `object` | No | — | Endpoint-specific Outreach filters. Relationship attributes use keys such as owner\[id]. |

> [!NOTE]
>
> This input schema is too large for an inline display. Read the complete live contract with `deepline describe outreach_list_mailboxes --json`.

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.data` | `array` | No | — | — |
| `result.data.data[].attributes` | `object` | No | — | A representation of an email mailbox, used within the application for sending and syncing emails. |
| `result.data.data[].attributes.authId` | `integer \| null` | No | — | The auth id associated with the mailbox. |
| `result.data.data[].attributes.createdAt` | `string \| null` | No | — | The date and time the mailbox was created. Format: `date-time`. |
| `result.data.data[].attributes.editable` | `boolean \| null` | No | — | A boolean value to indicate if the user has the permission to edit mailbox fields. |
| `result.data.data[].attributes.email` | `string \| null` | No | — | The email address of the mailbox. Maximum length: 255. |
| `result.data.data[].attributes.emailHash` | `string \| null` | No | — | Hashed email address of the mailbox. Maximum length: 255. |
| `result.data.data[].attributes.emailProvider` | `string \| null` | No | — | The mail service provider. While not a required field, it is strongly recommended to use one of 'exchange\_online', 'exchange\_server', 'gmail', 'gmail\_api', 'google\_oauth2', 'intermedia', 'office365\_oauth2', 'microsoft\_hma\_oauth2', 'office\_365', 'rackspace'. If no value is provided, send and sync will make assumptions based on the ews, imap, and smtp values provided. Maximum length: 255. |
| `result.data.data[].attributes.emailSignature` | `string \| null` | No | — | The default signature, in HTML, to be appended to sent email messages. Maximum length: 65535. |
| `result.data.data[].attributes.ewsEndpoint` | `string \| null` | No | — | The url of the Exchange Web Service. Maximum length: 255. |
| `result.data.data[].attributes.ewsSslVerifyMode` | `integer \| null` | No | — | The SSL verify mode, represented as an integer, the EWS connection will used. (verify none=0, verify peer=1, verify client once=4, verify fail if no peer cert=2) |
| `result.data.data[].attributes.exchangeVersion` | `string \| null` | No | — | The version of Exchange. Must be one of 'Exchange2007', 'Exchange2007\_SP1', 'Exchange2010', 'Exchange2010\_SP1', 'Exchange2010\_SP2', 'Exchange2013', 'Exchange2013\_SP1'. Maximum length: 255. |
| `result.data.data[].attributes.imapHost` | `string \| null` | No | — | The address of the IMAP host, used for syncing (e.g. 'imap.gmail.com'). Maximum length: 255. |
| `result.data.data[].attributes.imapPort` | `integer \| null` | No | — | The port number the IMAP server is using (e.g. '993'). |
| `result.data.data[].attributes.imapSsl` | `boolean \| null` | No | — | A boolean value whether the IMAP connection will use SSL. |
| `result.data.data[].attributes.maxEmailsPerDay` | `integer \| null` | No | — | The maximum number of in/out emails per day. |
| `result.data.data[].attributes.maxMailingsPerDay` | `integer \| null` | No | — | The maximum number of emails the application can send in a day from this mailbox. Recommended value is 500. |
| `result.data.data[].attributes.maxMailingsPerWeek` | `integer \| null` | No | — | The maximum number of emails the application can send within a week from this mailbox. Recommended value is 5000. |
| `result.data.data[].attributes.optOutMessage` | `string \| null` | No | — | The message displayed on the unsubscribe confirmation page, seen after clicking the unsubscribe link in the email (e.g. "To unsubscribe, click the button below."). Maximum length: 512. |
| `result.data.data[].attributes.optOutSignature` | `string \| null` | No | — | The message below the signature, in HTML, when the sequence requires an unsubscribe link (e.g. "If you'd like me to stop sending you emails, please `click here`"). Maximum length: 512. |
| `result.data.data[].attributes.password` | `string \| null` | No | — | The password of the mailbox. This attribute can be used to set the password, but is not available for read. Maximum length: 65535. |
| `result.data.data[].attributes.prospectEmailExclusions` | `string \| null` | No | — | A list (provided as a string, newline-delimited) of email address patterns to be excluded from syncing (e.g. "`*@outreach.io daniel@example.com`"). Maximum length: 65535. |
| `result.data.data[].attributes.providerId` | `integer \| null` | No | — | The id of the provider associated with this calendar. |
| `result.data.data[].attributes.providerType` | `string \| null` | No | — | Email provider type. Maximum length: 255. |
| `result.data.data[].attributes.sendDisabled` | `boolean \| null` | No | — | A boolean value whether sending is disabled from this mailbox. |
| `result.data.data[].attributes.sendErroredAt` | `string \| null` | No | — | The date and time the most recent send error occurred. Format: `date-time`. |
| `result.data.data[].attributes.sendMaxRetries` | `integer \| null` | No | — | The maximum number of times to auto-retry a delivery when it fails. |
| `result.data.data[].attributes.sendMethod` | `string \| null` | No | — | The method used for sending email. Must be either 'ews', 'sendgrid', or 'smtp'. Maximum length: 255. |
| `result.data.data[].attributes.sendPeriod` | `integer \| null` | No | — | The amount of time in seconds that the number of sendThreshold emails can be sent. Recommended value is two deliveries per minute (sendPeriod is 60). |
| `result.data.data[].attributes.sendRequiresSync` | `boolean \| null` | No | — | A boolean value whether the mailbox is required to be recently synced before sending. |
| `result.data.data[].attributes.sendSuccessAt` | `string \| null` | No | — | The date and time the most recent successful email send occurred. Format: `date-time`. |
| `result.data.data[].attributes.sendThreshold` | `integer \| null` | No | — | The maximum number of email sends per the sendPeriod amount of time. Recommended value is two deliveries per minute (sendThreshold is 2). |
| `result.data.data[].attributes.sendgridApiKey` | `string \| null` | No | — | The api key of the SendGrid account used for sending. Maximum length: 65535. |
| `result.data.data[].attributes.sendgridWebhookUrl` | `string \| null` | No | — | The endpoint required within the SendGrid account settings to support bounce and spam-report tracking. |
| `result.data.data[].attributes.smtpHost` | `string \| null` | No | — | The address of the SMTP host, used for sending (e.g. 'smtp.gmail.com'). Maximum length: 255. |
| `result.data.data[].attributes.smtpPassword` | `string \| null` | No | — | The password for the SMTP account. This value should be left blank unless a separate SMTP account is being used for sending (i.e. not the mailbox's main username/password). Maximum length: 65535. |
| `result.data.data[].attributes.smtpPort` | `integer \| null` | No | — | The port number the SMTP server is using (e.g. '587'). |
| `result.data.data[].attributes.smtpSsl` | `boolean \| null` | No | — | A boolean value whether the SMTP connection will use SSL. |
| `result.data.data[].attributes.smtpUsername` | `string \| null` | No | — | The username for the SMTP account. This value should be left blank unless a separate SMTP account is being used for sending (i.e. not the mailbox's main username/password). Maximum length: 255. |
| `result.data.data[].attributes.syncActiveFrequency` | `integer \| null` | No | — | The amount of time in seconds between syncing when the user is actively using the application. |
| `result.data.data[].attributes.syncDisabled` | `boolean \| null` | No | — | A boolean value whether syncing is disabled from this mailbox. |
| `result.data.data[].attributes.syncErroredAt` | `string \| null` | No | — | The date and time the most recent sync error occurred. Format: `date-time`. |
| `result.data.data[].attributes.syncFinishedAt` | `string \| null` | No | — | The date and time the most recent sync finished. Format: `date-time`. |
| `result.data.data[].attributes.syncMethod` | `string \| null` | No | — | The method used for syncing email. Must be either 'ews', 'gmail\_api', or 'imap'. Maximum length: 255. |
| `result.data.data[].attributes.syncOutreachFolder` | `boolean \| null` | No | — | A boolean value whether the folder for syncing is named 'Outreach' instead of 'Inbox'. Only available for Exchange version 'Exchange2007\_SP1'. |
| `result.data.data[].attributes.syncPassiveFrequency` | `integer \| null` | No | — | The amount of time in seconds between syncing when the user is not actively using the application. |
| `result.data.data[].attributes.syncSuccessAt` | `string \| null` | No | — | The date and time the most recent successful email sync occurred. Format: `date-time`. |
| `result.data.data[].attributes.updatedAt` | `string \| null` | No | — | The date and time the mailbox was last updated. Format: `date-time`. |
| `result.data.data[].attributes.userId` | `integer \| null` | No | — | The id of the user associated with this mailbox. |

The table shows the first 50 fields. Expand the raw schema below for every field.

> [!NOTE]
>
> This output schema is too large for an inline display. Read the complete live contract with `deepline describe outreach_list_mailboxes --json`.

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

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