Email Platform

The email adapter sends through SMTP and receives through IMAP IDLE. It preserves threads, addresses, attachments, and raw headers, and reconnects indefinitely after a disconnect.

Installation

Open Extensions in the Web console and select the adapter, or run:

onebots ui --data-dir <workspace> --setup

The manager installs the adapter and its required peer dependencies into a verified immutable runtime generation. Do not run package-manager install commands directly in the OneBots runtime directory.

Configuration

email.my_bot:
  address: bot@example.com
  display_name: My Bot
  auth:
    user: bot@example.com
    password: your-app-password
  smtp:
    host: smtp.example.com
    port: 587
    security: starttls
    pool: true
  imap:
    host: imap.example.com
    port: 993
    security: tls
    mailbox: INBOX
    mark_seen: true
    poll_interval_ms: 60000
  onebot.v11:
    access_token: your-token

SMTP and IMAP share authentication and proxy settings. auth.access_token can replace the password. security accepts tls, starttls, or plain.

Existing mail systems can set receive_mode: manual, omit IMAP, and reliably submit parsed messages with await account.client.ingest(email) while retaining SMTP sending.

Message model

• One recipient is a private scene; reply-all conversations use direct.
• The scene ID is a comma-separated list of email addresses.
• RFC Message-ID becomes the common message_id; IMAP UID and mailbox remain in extensions.email.
• Common text, image, file, and reply segments are supported. The email segment controls subject, HTML, CC, BCC, Reply-To, references, priority, and headers.
• Inbound HTML is also preserved losslessly in the receive-only email_html segment.

callAction() exposes native send, search, mailbox listing, read/flag operations, moving/deleting messages, and mailbox management. Query the exact action list with get_supported_actions.

Deletion semantics

delete_message deletes the IMAP mailbox copy. SMTP cannot recall mail that has already been delivered.

See Email adapter configuration for every field.