Licensed to be used in conjunction with basebox, only.
// integration
Email (IMAP)
Applies to
Product: Cloud · Server · Audience: Administrator
The Email (IMAP) connector lets the basebox assistant search and read emails in a mailbox. It connects to your organisation's mail server over IMAP; it cannot send, move or delete. The administrator sets the mail server, and each person signs in with their own mailbox. A company account only fits a team mailbox such as info@.
What does the connector do?
This and the following sections are generated from the information the connector's image carries. What applies to every connector is described under What applies to every connector.
In the catalog it describes itself as:
Search and read email through an IMAP account.
It gives the assistant these instructions:
Read the current user's own mailbox; there is exactly one. search_emails finds emails, in INBOX unless given another folder from list_folders, and read_emails reads them by uid.
Settings
The administrator fills in these fields in the connector's settings. They apply to the whole organisation.
| Field | Required | Meaning |
|---|---|---|
| IMAP server | no | Host name of the mail server every user's mailbox is on. Example: imap.example.org |
| IMAP port | no | Leave empty for the usual port, 993 with TLS or 143 with STARTTLS. Example: 993 |
| Connection security | no | Unencrypted connections are not supported. |
| Help link for signing in | no | Where users can read how to get an app password, e.g. a page on your intranet. |
Sign-in
The administrator decides how the connector signs in: with Personal sign-in each person signs in with their own account and sees only what they may. With Company account everyone uses one account the administrator enters.
Personal sign-in
- Mailbox login – asks for a username and password. Email address or IMAP username: For most providers this is your email address. Password: Use an app password if your provider requires one.
Company account
- Shared mailbox login – asks for a username and password. Email address or IMAP username: The login of the team mailbox, e.g. info@example.org. Password: Use an app password if your provider requires one.
A company account gives everyone the same rights
Every basebox user reaches the system with the rights of this one account. Results are not trimmed to what each person may see.
The connector adds:
One mailbox for everyone. That is right for a team address such as info@, and wrong for personal mail: every basebox user would read the same inbox.
Tools
The assistant can call 4 tools.
| Tool | Effect | Description |
|---|---|---|
get_folder_status |
reads | Count the emails in one folder of the user's mailbox: how many there are in total and how many are unread. |
list_folders |
reads | List the folders of the user's mailbox (INBOX, Sent, project folders, ...). Returns each folder's full name, which the other email tools take as folder, and its role where the server declares one (sent, drafts, trash, junk, archive), so e.g. the sent folder is found whatever its name. |
read_emails |
reads | Read up to 10 emails from one folder of the user's mailbox by their uids (from search_emails). Returns each email's date, sender, recipients, subject, flags and its text as Markdown: the readable part, HTML converted, followed by the text of each attachment (PDF, Office documents, forwarded emails, scans through OCR) under a heading of its own, and whether that text was truncated. Uids that match no email in the folder are listed as not_found. |
search_emails |
reads | Find emails in one folder of the user's mailbox, newest first. All criteria are optional and combine with AND; none lists the whole folder. Returns the total number of matches and one page of them, each with its uid, date, sender, recipients, subject and whether it is unread. Use offset for further pages. To read an email's text, pass its uid and the same folder to read_emails. |
Generated from mcp-email-rs:v2.0.1.