# IMAP Adapter

This adapter represents an IMAP adapter for fetching folder and email fetching.

## Class: ImapAttachment

Represents an attachment of an email message.

| Field           | Type    | Format                           | Remarks                                                               |
| --------------- | ------- | -------------------------------- | --------------------------------------------------------------------- |
| ContentId       | String  |                                  | The content Id of the attachment.                                     |
| ContentLocation | String  |                                  | The content location of the attachment.                               |
| ContentType     | String  |                                  | The content type of the attachment.                                   |
| Filesize        | Integer |                                  | The size of the attachment.                                           |
| Id              | String  | \<Email-ID>\\\<Attachment-Index> | The index of the attachment prepended by the ID of the email message. |
| MailId          | String  |                                  | The ID of the email message.                                          |
| Name            | String  |                                  | The name of the file the attachment is linked to.                     |

## Class: ImapMail

Represents an email message.

### Action: Create

Creates an email (without saving it). Either an email message is created from scratch or the **Action** parameter provided. Replying and forwarding an email message updates the **Subject** and **Body**.

| Parameter                               | Type     | Format                                            | Required | Remarks                                                                                      |
| --------------------------------------- | -------- | ------------------------------------------------- | -------- | -------------------------------------------------------------------------------------------- |
| Action                                  | String   | “Reply”, “ReplyAll”, “Forward”, “Update”,         | No       | The action to perform on an original email message.                                          |
| BCC                                     | String   | <p>Email addresses                                |          |                                                                                              |
| <br>(<john@doe.com>;<jane@doe.com>)</p> | No       | The list of Bcc recipients for the email message. |          |                                                                                              |
| Body                                    | String   |                                                   | No       | The text of the message body.                                                                |
| CC                                      | String   | <p>Email addresses                                |          |                                                                                              |
| <br>(<john@doe.com>;<jane@doe.com>)</p> | No       | The list of Cc recipients for the email message.  |          |                                                                                              |
| Folder                                  | String   |                                                   | No       | The folder the email message should be saved in.                                             |
| From                                    | String   | Email address (<john@doe.com>)                    | No       | Used as the "on behalf" sender of the email message. Defaults to the accounts email address. |
| Id                                      | String   |                                                   | No       | The ID of the email message. Defaults to a generated GUID.                                   |
| IsAnswered                              | Boolean  |                                                   | No       | Determines whether the email message is marked as answered. Defaults to false.               |
| IsDraft                                 | Boolean  |                                                   | No       | Determines whether the email message is marked as draft. Defaults to false.                  |
| IsSeen                                  | Boolean  |                                                   | No       | Determines whether the email message is marked as seen. Defaults to false.                   |
| IsStarred                               | Boolean  |                                                   | No       | Determines whether the email message is marked as starred. Defaults to false.                |
| OriginalMessageId                       | String   |                                                   | No       | The ID of the original email message to reply, forward, or update.                           |
| ReceivedOn                              | DateTime |                                                   | No       | The date and time the email message was received.                                            |
| SentOn                                  | DateTime |                                                   | No       | The date and time the email message was sent.                                                |
| Subject                                 | String   |                                                   |          | The subject of the message.                                                                  |
| To                                      | String   | Email addresses (<john@doe.com><;jane@doe.com>)   | No       | The list of To recipients for the email message.                                             |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.tivity.one/extensibility-and-integration/source-adapter/imap-adapter.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
