> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # unipile-email > Unipile Email - email, folders, drafts, and calendars **Server path:** `/unipile-email` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | --------------------------------------------------------------------------------------------------- | ------------------------------------ | | [`unipile_email_create_calendar_event`](#unipile_email_create_calendar_event) | Create an event | | [`unipile_email_create_draft`](#unipile_email_create_draft) | Create a draft | | [`unipile_email_delete_calendar_event`](#unipile_email_delete_calendar_event) | Delete an event | | [`unipile_email_delete_mail`](#unipile_email_delete_mail) | Delete an email | | [`unipile_email_edit_calendar_event`](#unipile_email_edit_calendar_event) | Edit an event | | [`unipile_email_get_attachment`](#unipile_email_get_attachment) | Retrieve an attachment from an email | | [`unipile_email_get_calendar`](#unipile_email_get_calendar) | Retrieve a calendar | | [`unipile_email_get_calendar_event`](#unipile_email_get_calendar_event) | Retrieve an event | | [`unipile_email_get_folder`](#unipile_email_get_folder) | Retrieve a folder | | [`unipile_email_get_mail`](#unipile_email_get_mail) | Retrieve an email | | [`unipile_email_list_calendar_events_by_calendar`](#unipile_email_list_calendar_events_by_calendar) | Retrieve all events from a calendar | | [`unipile_email_list_calendars`](#unipile_email_list_calendars) | List all calendars | | [`unipile_email_list_contacts`](#unipile_email_list_contacts) | List email contacts | | [`unipile_email_list_folders`](#unipile_email_list_folders) | List all folders | | [`unipile_email_list_mails`](#unipile_email_list_mails) | List all emails | | [`unipile_email_send_mail`](#unipile_email_send_mail) | Send an email | | [`unipile_email_update_mail`](#unipile_email_update_mail) | Update an email | *** ## unipile\_email\_create\_calendar\_event Create an event **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `account_id` | string | Yes | — | The id of the account to use. | | `calendar_id` | string | Yes | — | The id of calendar receiving the event. | | `attendees` | object\[] | Yes | — | The attendees value | | `body` | string | No | — | The body of the event. | | `color` | string | No | — | The color of the event. \
`Google Calendar`: `#7986CB`, `#33B679`, `#8E24AA`, `#E67C73`, `#F6BF26`, `#F4511E`, `#039BE5`, `#616161`, `#3F51B5`, `#0B8043`, `#D50000` | | `conference` | object | No | — | The conference value | | `end` | object | Yes | — | The end date and time of the event. | | `guests_can_modify` | boolean | No | — | If true, allow guests to modify the event. \
`Outlook Calendar`: Not supported, this parameter will always be false. | | `is_attendees_list_hidden` | boolean | No | — | Is the attendees list hidden for attendees. | | `location` | string | No | — | The location of the event. | | `notify` | boolean | No | — | If true, send notifications about the event to invited attendees. \
`Outlook Calendar`: Not supported, this parameter will always be true. | | `recurrence` | string\[] | No | — | List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. | | `start` | object | Yes | — | The start date and time of the event. | | `title` | string | Yes | — | The title of the event. | | `transparency` | object | No | — | The transparency of the event. `opaque` does block time on the calendar and is equivalent to setting Show me as to Busy in the Calendar UI. `transparent` does not block time on the calendar and is equivalent to setting Show me as to Available in the Calendar UI. | | `visibility` | object | No | — | The visibility of the event. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "account_id": { "type": "string", "description": "The id of the account to use." }, "calendar_id": { "type": "string", "description": "The id of calendar receiving the event." }, "attendees": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "description": "Email of the attendee." } }, "required": [ "email" ] }, "description": "The attendees value" }, "body": { "type": "string", "description": "The body of the event." }, "color": { "type": "string", "description": "The color of the event.
`Google Calendar`: `#7986CB`, `#33B679`, `#8E24AA`, `#E67C73`, `#F6BF26`, `#F4511E`, `#039BE5`, `#616161`, `#3F51B5`, `#0B8043`, `#D50000`" }, "conference": { "type": "object", "description": "The conference value", "properties": { "provider": { "type": "string", "description": "The conference provider.", "enum": [ "google_meet", "zoom", "teams", "unknown" ] }, "conference_id": { "type": "string", "description": "The provider-native conference ID." }, "url": { "type": "string", "description": "The conference URL. If not provided, it will automatically create a new conference (only teams and google_meet available)" } }, "required": [ "provider" ] }, "end": { "description": "The end date and time of the event." }, "guests_can_modify": { "type": "boolean", "description": "If true, allow guests to modify the event.
`Outlook Calendar`: Not supported, this parameter will always be false." }, "is_attendees_list_hidden": { "type": "boolean", "description": "Is the attendees list hidden for attendees." }, "location": { "type": "string", "description": "The location of the event." }, "notify": { "type": "boolean", "description": "If true, send notifications about the event to invited attendees.
`Outlook Calendar`: Not supported, this parameter will always be true." }, "recurrence": { "type": "array", "items": { "type": "string" }, "description": "List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545." }, "start": { "description": "The start date and time of the event." }, "title": { "type": "string", "description": "The title of the event." }, "transparency": { "description": "The transparency of the event. `opaque` does block time on the calendar and is equivalent to setting Show me as to Busy in the Calendar UI. `transparent` does not block time on the calendar and is equivalent to setting Show me as to Available in the Calendar UI." }, "visibility": { "description": "The visibility of the event." } }, "required": [ "PCID", "account_id", "calendar_id", "attendees", "end", "start", "title" ] } ``` *** ## unipile\_email\_create\_draft Create a draft **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | --------- | -------- | ------- | ------------------------------------------------------------------ | | `account_id` | string | Yes | — | A unique identifier. | | `attachments` | string\[] | No | — | The attachments value | | `bcc` | object\[] | No | — | The bcc value | | `body` | string | Yes | — | The body value | | `cc` | object\[] | No | — | The cc value | | `custom_headers` | object\[] | No | — | An array of custom headers to be added to the email. | | `from` | object | No | — | The from value | | `reply_to` | string | No | — | Either the Unipile ID or the provider ID of the email to reply to. | | `subject` | string | No | — | The subject value | | `to` | object\[] | Yes | — | The to value | | `tracking_options` | object | No | — | Tracking Options | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "account_id": { "type": "string", "description": "A unique identifier." }, "attachments": { "type": "array", "items": { "type": "string", "format": "binary" }, "description": "The attachments value" }, "bcc": { "type": "array", "items": { "type": "object", "properties": { "display_name": { "type": "string", "description": "The name of the attendee." }, "identifier": { "type": "string", "format": "emailLike", "description": "The email address of the attendee." } }, "required": [ "identifier" ] }, "description": "The bcc value" }, "body": { "type": "string", "description": "The body value" }, "cc": { "type": "array", "items": { "type": "object", "properties": { "display_name": { "type": "string", "description": "The name of the attendee." }, "identifier": { "type": "string", "format": "emailLike", "description": "The email address of the attendee." } }, "required": [ "identifier" ] }, "description": "The cc value" }, "custom_headers": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The header name. Must start with 'X-' or 'x-' or be in this list: (List-Unsubscribe, List-Unsubscribe-Post, Reply-To, Content-Type)." }, "value": { "type": "string", "description": "The value value" } }, "required": [ "name", "value" ] }, "description": "An array of custom headers to be added to the email." }, "from": { "type": "object", "description": "The from value", "properties": { "display_name": { "type": "string", "description": "The name of the attendee." }, "identifier": { "type": "string", "description": "The email address of the attendee." } } }, "reply_to": { "type": "string", "description": "Either the Unipile ID or the provider ID of the email to reply to." }, "subject": { "type": "string", "description": "The subject value" }, "to": { "type": "array", "items": { "type": "object", "properties": { "display_name": { "type": "string", "description": "The name of the attendee." }, "identifier": { "type": "string", "format": "emailLike", "description": "The email address of the attendee." } }, "required": [ "identifier" ] }, "description": "The to value" }, "tracking_options": { "type": "object", "description": "Tracking Options", "properties": { "opens": { "type": "boolean", "description": "The opens value" }, "links": { "type": "boolean", "description": "You can disable link tracking for specific links by adding the attribute `'data-disable-tracking'` to the anchor tag." }, "label": { "type": "string", "description": "The label value" }, "custom_domain": { "type": "string", "description": "Custom Domain" } } } }, "required": [ "PCID", "account_id", "body", "to" ] } ``` *** ## unipile\_email\_delete\_calendar\_event Delete an event **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | --------------------------------------- | | `calendar_id` | string | Yes | — | The id of calendar receiving the event. | | `event_id` | string | Yes | — | The id of the event to edit. | | `account_id` | string | Yes | — | The id of the account to use. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "calendar_id": { "type": "string", "description": "The id of calendar receiving the event." }, "event_id": { "type": "string", "description": "The id of the event to edit." }, "account_id": { "type": "string", "description": "The id of the account to use." } }, "required": [ "PCID", "calendar_id", "event_id", "account_id" ] } ``` *** ## unipile\_email\_delete\_mail Delete an email **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | --------------------------------------------------------------------------------- | | `email_id` | string | Yes | — | The id of the email to be deleted. Either the Unipile id or the provider uid. | | `account_id` | string | No | — | The id of the account related to the email. Required when using the provider uid. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "email_id": { "type": "string", "description": "The id of the email to be deleted. Either the Unipile id or the provider uid." }, "account_id": { "type": "string", "description": "The id of the account related to the email. Required when using the provider uid." } }, "required": [ "PCID", "email_id" ] } ``` *** ## unipile\_email\_edit\_calendar\_event Edit an event **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `account_id` | string | Yes | — | The id of the account to use. | | `event_id` | string | Yes | — | The id of the event to edit. | | `calendar_id` | string | Yes | — | The id of calendar receiving the event. | | `attendees` | object\[] | No | — | The attendees value | | `body` | string | No | — | The body of the event. | | `color` | string | No | — | The color of the event. \
`Google Calendar`: `#7986CB`, `#33B679`, `#8E24AA`, `#E67C73`, `#F6BF26`, `#F4511E`, `#039BE5`, `#616161`, `#3F51B5`, `#0B8043`, `#D50000` | | `conference` | object | No | — | The conference value | | `end` | object | No | — | The end date and time of the event. | | `guests_can_modify` | boolean | No | — | If true, allow guests to modify the event. \
`Outlook Calendar`: Not supported, this parameter will always be false. | | `is_attendees_list_hidden` | boolean | No | — | Is the attendees list hidden for attendees. | | `location` | string | No | — | The location of the event. | | `notify` | boolean | No | — | If true, send notifications about the event update to invited attendees. | | `recurrence` | string\[] | No | — | List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. | | `start` | object | No | — | The start date and time of the event. | | `title` | string | No | — | The title of the event. | | `transparency` | object | No | — | The transparency of the event. `opaque` does block time on the calendar and is equivalent to setting Show me as to Busy in the Calendar UI. `transparent` does not block time on the calendar and is equivalent to setting Show me as to Available in the Calendar UI. | | `visibility` | object | No | — | The visibility of the event. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "account_id": { "type": "string", "description": "The id of the account to use." }, "event_id": { "type": "string", "description": "The id of the event to edit." }, "calendar_id": { "type": "string", "description": "The id of calendar receiving the event." }, "attendees": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "description": "Email of the attendee." } }, "required": [ "email" ] }, "description": "The attendees value" }, "body": { "type": "string", "description": "The body of the event." }, "color": { "type": "string", "description": "The color of the event.
`Google Calendar`: `#7986CB`, `#33B679`, `#8E24AA`, `#E67C73`, `#F6BF26`, `#F4511E`, `#039BE5`, `#616161`, `#3F51B5`, `#0B8043`, `#D50000`" }, "conference": { "type": "object", "description": "The conference value", "properties": { "provider": { "type": "string", "description": "The conference provider.", "enum": [ "google_meet", "zoom", "teams", "unknown" ] }, "conference_id": { "type": "string", "description": "The provider-native conference ID." }, "url": { "type": "string", "description": "The conference URL. If not provided, it will automatically create a new conference (only teams and google_meet available)" } }, "required": [ "provider" ] }, "end": { "description": "The end date and time of the event." }, "guests_can_modify": { "type": "boolean", "description": "If true, allow guests to modify the event.
`Outlook Calendar`: Not supported, this parameter will always be false." }, "is_attendees_list_hidden": { "type": "boolean", "description": "Is the attendees list hidden for attendees." }, "location": { "type": "string", "description": "The location of the event." }, "notify": { "type": "boolean", "description": "If true, send notifications about the event update to invited attendees." }, "recurrence": { "type": "array", "items": { "type": "string" }, "description": "List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545." }, "start": { "description": "The start date and time of the event." }, "title": { "type": "string", "description": "The title of the event." }, "transparency": { "description": "The transparency of the event. `opaque` does block time on the calendar and is equivalent to setting Show me as to Busy in the Calendar UI. `transparent` does not block time on the calendar and is equivalent to setting Show me as to Available in the Calendar UI." }, "visibility": { "description": "The visibility of the event." } }, "required": [ "PCID", "account_id", "event_id", "calendar_id" ] } ``` *** ## unipile\_email\_get\_attachment Retrieve an attachment from an email **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------- | | `email_id` | string | Yes | — | The id of the email to which the attachment is linked. Either the Unipile id or the provider uid. | | `account_id` | string | No | — | The id of the account related to the email. Required when using the provider uid. | | `attachment_id` | string | Yes | — | A unique identifier. The id of the attachment to be retrieved. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "email_id": { "type": "string", "description": "The id of the email to which the attachment is linked. Either the Unipile id or the provider uid." }, "account_id": { "type": "string", "description": "The id of the account related to the email. Required when using the provider uid." }, "attachment_id": { "type": "string", "description": "A unique identifier. The id of the attachment to be retrieved." } }, "required": [ "PCID", "email_id", "attachment_id" ] } ``` *** ## unipile\_email\_get\_calendar Retrieve a calendar **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | ------------------------------ | | `account_id` | string | Yes | — | The id of the account to use. | | `calendar_id` | string | Yes | — | The id of the wanted calendar. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "account_id": { "type": "string", "description": "The id of the account to use." }, "calendar_id": { "type": "string", "description": "The id of the wanted calendar." } }, "required": [ "PCID", "account_id", "calendar_id" ] } ``` *** ## unipile\_email\_get\_calendar\_event Retrieve an event **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | --------------------------------------- | | `account_id` | string | Yes | — | The id of the account to use. | | `event_id` | string | Yes | — | The id of the wanted event. | | `calendar_id` | string | Yes | — | The id of calendar of the wanted event. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "account_id": { "type": "string", "description": "The id of the account to use." }, "event_id": { "type": "string", "description": "The id of the wanted event." }, "calendar_id": { "type": "string", "description": "The id of calendar of the wanted event." } }, "required": [ "PCID", "account_id", "event_id", "calendar_id" ] } ``` *** ## unipile\_email\_get\_folder Retrieve a folder **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ---------------------------------------------------------------------------------- | | `folder_id` | string | Yes | — | The id of the wanted folder. Either the Unipile id or the provider uid. | | `account_id` | string | No | — | The id of the account related to the folder. Required when using the provider uid. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "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": [ "PCID", "folder_id" ] } ``` *** ## unipile\_email\_get\_mail Retrieve an email **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------- | | `email_id` | string | Yes | — | The id of the email to be retrieved. Either the Unipile id or the provider uid. | | `account_id` | string | No | — | The id of the account related to the email. Required when using the provider uid. | | `include_headers` | boolean | No | — | Include the email headers in the response. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "email_id": { "type": "string", "description": "The id of the email to be retrieved. Either the Unipile id or the provider uid." }, "account_id": { "type": "string", "description": "The id of the account related to the email. Required when using the provider uid." }, "include_headers": { "type": "boolean", "description": "Include the email headers in the response." } }, "required": [ "PCID", "email_id" ] } ``` *** ## unipile\_email\_list\_calendar\_events\_by\_calendar Retrieve all events from a calendar **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | `expand_recurring` | boolean | No | — | Filter events by type (single or occurence). | | `event_type` | string | No | — | Filter events by event type. This parameter accepts a comma-delimited list of event type. | | `attendees` | string | No | — | Filter events with attendees contained in this list. This parameter accepts a comma-delimited list of email addresses. | | `updated_after` | string | No | — | Filter events updated after this date. Preferred format: RFC3339 datetime (`2026-02-27T17:07:49Z`). | | `updated_before` | string | No | — | Filter events updated before this date. Preferred format: RFC3339 datetime (`2026-02-27T17:07:49Z`). | | `busy` | boolean | No | — | Filter for events with the status `busy` | | `end` | string | No | — | Filter events ending before this date. Preferred format: RFC3339 datetime (`2026-02-27T17:07:49Z`). | | `start` | string | No | — | Filter events starting after this date. Preferred format: RFC3339 datetime (`2026-02-27T17:07:49Z`). | | `location` | string | No | — | Filter for events matching the specified location. | | `ical_uid` | string | No | — | Filter for events matching the specified iCal UID. | | `description` | string | No | — | Filter for events matching the specified description. | | `title` | string | No | — | Filter for events matching the specified title. | | `is_cancelled` | boolean | No | — | Indicates if you want to retrieve the cancelled events. | | `cursor` | string | No | — | A cursor used for pagination. If supported by the provider, use `next_cursor` given by the previous page of the list, else use `offset`. | | `offset` | number | No | — | An offset used for pagination, if supported by the provider, else use `cursor`. | | `limit` | number | No | — | The limit of items to be returned. | | `account_id` | string | Yes | — | The id of the account to use. | | `calendar_id` | string | Yes | — | The id of the calendar related to events | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "expand_recurring": { "type": "boolean", "description": "Filter events by type (single or occurence)." }, "event_type": { "type": "string", "description": "Filter events by event type. This parameter accepts a comma-delimited list of event type." }, "attendees": { "type": "string", "description": "Filter events with attendees contained in this list. This parameter accepts a comma-delimited list of email addresses." }, "updated_after": { "type": "string", "description": "Filter events updated after this date. Preferred format: RFC3339 datetime (`2026-02-27T17:07:49Z`)." }, "updated_before": { "type": "string", "description": "Filter events updated before this date. Preferred format: RFC3339 datetime (`2026-02-27T17:07:49Z`)." }, "busy": { "type": "boolean", "description": "Filter for events with the status `busy`" }, "end": { "type": "string", "description": "Filter events ending before this date. Preferred format: RFC3339 datetime (`2026-02-27T17:07:49Z`)." }, "start": { "type": "string", "description": "Filter events starting after this date. Preferred format: RFC3339 datetime (`2026-02-27T17:07:49Z`)." }, "location": { "type": "string", "description": "Filter for events matching the specified location." }, "ical_uid": { "type": "string", "description": "Filter for events matching the specified iCal UID." }, "description": { "type": "string", "description": "Filter for events matching the specified description." }, "title": { "type": "string", "description": "Filter for events matching the specified title." }, "is_cancelled": { "type": "boolean", "description": "Indicates if you want to retrieve the cancelled events." }, "cursor": { "type": "string", "description": "A cursor used for pagination. If supported by the provider, use `next_cursor` given by the previous page of the list, else use `offset`." }, "offset": { "type": "number", "description": "An offset used for pagination, if supported by the provider, else use `cursor`." }, "limit": { "type": "number", "description": "The limit of items to be returned." }, "account_id": { "type": "string", "description": "The id of the account to use." }, "calendar_id": { "type": "string", "description": "The id of the calendar related to events" } }, "required": [ "PCID", "account_id", "calendar_id" ] } ``` *** ## unipile\_email\_list\_calendars List all calendars **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | `cursor` | string | No | — | A cursor used for pagination. If supported by the provider, use `next_cursor` given by the previous page of the list, else use `offset`. | | `offset` | number | No | — | An offset used for pagination, if supported by the provider, else use `cursor`. | | `limit` | number | No | — | The limit of items to be returned. | | `account_id` | string | Yes | — | The id of the account to use. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cursor": { "type": "string", "description": "A cursor used for pagination. If supported by the provider, use `next_cursor` given by the previous page of the list, else use `offset`." }, "offset": { "type": "number", "description": "An offset used for pagination, if supported by the provider, else use `cursor`." }, "limit": { "type": "number", "description": "The limit of items to be returned." }, "account_id": { "type": "string", "description": "The id of the account to use." } }, "required": [ "PCID", "account_id" ] } ``` *** ## unipile\_email\_list\_contacts List email contacts **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `cursor` | string | No | — | A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved. | | `limit` | integer | No | — | A limit for the number of items returned in the response. The value can be set between 1 and 250. | | `account_id` | string | Yes | — | A filter to target items related to a certain account. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cursor": { "type": "string", "description": "A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved." }, "limit": { "type": "integer", "description": "A limit for the number of items returned in the response. The value can be set between 1 and 250." }, "account_id": { "type": "string", "description": "A filter to target items related to a certain account." } }, "required": [ "PCID", "account_id" ] } ``` *** ## unipile\_email\_list\_folders List all folders **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ------------------------------------------------------ | | `account_id` | string | No | — | A filter to target items related to a certain account. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "account_id": { "type": "string", "description": "A filter to target items related to a certain account." } }, "required": [ "PCID" ] } ``` *** ## unipile\_email\_list\_mails List all emails **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `message_id` | string | No | — | A filter to target items by message\_id. | | `thread_id` | string | No | — | A filter to target items by thread identifier. | | `meta_only` | boolean | No | — | Speed up the response by only returning the email metadata, excluding the body and attachments metadata. | | `include_headers` | boolean | No | — | Include the email headers in the response. `meta_only` must be false. | | `cursor` | string | No | — | A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved. | | `before` | string | No | — | A filter to target items created before the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ). | | `after` | string | No | — | A filter to target items created after the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ). | | `limit` | integer | No | — | A limit for the number of items returned in the response. The value can be set between 1 and 250. | | `any_email` | string | No | — | A filter to target items sent to or received from a comma-separated list of email addresses. | | `to` | string | No | — | A filter to target items related to a certain recipient, either in the to, cc or bcc field. | | `from` | string | No | — | A filter to target items related to a certain sender. | | `exclude_folders` | string | No | — | A filter to exclude items from a comma-separated list of folder provider\_id ( ignored if folder parameter is used ). | | `folder` | string | No | — | A filter to target items related to a certain folder provider\_id. | | `account_id` | string | Yes | — | A filter to target items related to a certain account. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "message_id": { "type": "string", "description": "A filter to target items by message_id." }, "thread_id": { "type": "string", "description": "A filter to target items by thread identifier." }, "meta_only": { "type": "boolean", "description": "Speed up the response by only returning the email metadata, excluding the body and attachments metadata." }, "include_headers": { "type": "boolean", "description": "Include the email headers in the response. `meta_only` must be false." }, "cursor": { "type": "string", "description": "A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved." }, "before": { "type": "string", "description": "A filter to target items created before the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ)." }, "after": { "type": "string", "description": "A filter to target items created after the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ)." }, "limit": { "type": "integer", "description": "A limit for the number of items returned in the response. The value can be set between 1 and 250." }, "any_email": { "type": "string", "description": "A filter to target items sent to or received from a comma-separated list of email addresses." }, "to": { "type": "string", "description": "A filter to target items related to a certain recipient, either in the to, cc or bcc field." }, "from": { "type": "string", "description": "A filter to target items related to a certain sender." }, "exclude_folders": { "type": "string", "description": "A filter to exclude items from a comma-separated list of folder provider_id ( ignored if folder parameter is used )." }, "folder": { "type": "string", "description": "A filter to target items related to a certain folder provider_id." }, "account_id": { "type": "string", "description": "A filter to target items related to a certain account." } }, "required": [ "PCID", "account_id" ] } ``` *** ## unipile\_email\_send\_mail Send an email **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | --------- | -------- | ------- | ------------------------------------------------------------------ | | `account_id` | string | Yes | — | A unique identifier. | | `attachments` | string\[] | No | — | The attachments value | | `bcc` | object\[] | No | — | The bcc value | | `body` | string | Yes | — | The body value | | `cc` | object\[] | No | — | The cc value | | `custom_headers` | object\[] | No | — | An array of custom headers to be added to the email. | | `from` | object | No | — | The from value | | `reply_to` | string | No | — | Either the Unipile ID or the provider ID of the email to reply to. | | `subject` | string | No | — | The subject value | | `to` | object\[] | Yes | — | The to value | | `tracking_options` | object | No | — | Tracking Options | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "account_id": { "type": "string", "description": "A unique identifier." }, "attachments": { "type": "array", "items": { "type": "string", "format": "binary" }, "description": "The attachments value" }, "bcc": { "type": "array", "items": { "type": "object", "properties": { "display_name": { "type": "string", "description": "The name of the attendee." }, "identifier": { "type": "string", "format": "emailLike", "description": "The email address of the attendee." } }, "required": [ "identifier" ] }, "description": "The bcc value" }, "body": { "type": "string", "description": "The body value" }, "cc": { "type": "array", "items": { "type": "object", "properties": { "display_name": { "type": "string", "description": "The name of the attendee." }, "identifier": { "type": "string", "format": "emailLike", "description": "The email address of the attendee." } }, "required": [ "identifier" ] }, "description": "The cc value" }, "custom_headers": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The header name. Must start with 'X-' or 'x-' or be in this list: (List-Unsubscribe, List-Unsubscribe-Post, Reply-To, Content-Type)." }, "value": { "type": "string", "description": "The value value" } }, "required": [ "name", "value" ] }, "description": "An array of custom headers to be added to the email." }, "from": { "type": "object", "description": "The from value", "properties": { "display_name": { "type": "string", "description": "The name of the attendee." }, "identifier": { "type": "string", "description": "The email address of the attendee." } } }, "reply_to": { "type": "string", "description": "Either the Unipile ID or the provider ID of the email to reply to." }, "subject": { "type": "string", "description": "The subject value" }, "to": { "type": "array", "items": { "type": "object", "properties": { "display_name": { "type": "string", "description": "The name of the attendee." }, "identifier": { "type": "string", "format": "emailLike", "description": "The email address of the attendee." } }, "required": [ "identifier" ] }, "description": "The to value" }, "tracking_options": { "type": "object", "description": "Tracking Options", "properties": { "opens": { "type": "boolean", "description": "The opens value" }, "links": { "type": "boolean", "description": "You can disable link tracking for specific links by adding the attribute `'data-disable-tracking'` to the anchor tag." }, "label": { "type": "string", "description": "The label value" }, "custom_domain": { "type": "string", "description": "Custom Domain" } } } }, "required": [ "PCID", "account_id", "body", "to" ] } ``` *** ## unipile\_email\_update\_mail Update an email **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `email_id` | string | Yes | — | The id of the email to be updated. Either the Unipile id or the provider uid. | | `account_id` | string | No | — | The id of the account related to the email. Required when using the provider uid. | | `categories` | string\[] | No | — | `Outlook only`: The categories to assign to the email. | | `folders` | string\[] | No | — | The names of the folders to which the email should be moved. Outlook and IMAP accounts accept only one folder. If you provide a label value that does not already exist, a new label will be created with that value. | | `unread` | boolean | No | — | Indicates whether the email should be marked as unread. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "email_id": { "type": "string", "description": "The id of the email to be updated. Either the Unipile id or the provider uid." }, "account_id": { "type": "string", "description": "The id of the account related to the email. Required when using the provider uid." }, "categories": { "type": "array", "items": { "type": "string" }, "description": "`Outlook only`: The categories to assign to the email." }, "folders": { "type": "array", "items": { "type": "string" }, "description": "The names of the folders to which the email should be moved. Outlook and IMAP accounts accept only one folder. If you provide a label value that does not already exist, a new label will be created with that value." }, "unread": { "type": "boolean", "description": "Indicates whether the email should be marked as unread." } }, "required": [ "PCID", "email_id" ] } ```