plugin-imap (1.0.0)
Installation
registry=npm install plugin-imap@1.0.0"plugin-imap": "1.0.0"About this package
IMAP
Read and manage email via IMAP (imapflow + mailparser): mailboxes, list/search/read messages, flags, move and delete
- Package:
plugin-imap - Author: Kai
- Version: 1.0.0
Credentials
| Key | Label | Type | Required | Default |
|---|---|---|---|---|
host |
Host | string | yes | – |
port |
Port | number | no | 993 |
user |
User | string | yes | – |
password |
Password | secret | yes | – |
secure |
Use TLS (port 993) | boolean | no | true |
rejectUnauthorized |
Verify TLS certificate | boolean | no | true |
Settings
| Key | Label | Type | Required | Default |
|---|---|---|---|---|
timeoutMs |
Timeout (ms) | number | no | 15000 |
defaultMailbox |
Default mailbox | string | no | INBOX |
maxFetchBytes |
Max text/HTML bytes per fetched message | number | no | 1048576 |
listLimit |
Max messages per list/search result | number | no | 200 |
maxAttachmentBytes |
Max attachment size returned as base64 (bytes) | number | no | 5242880 |
Tools
| Tool | Description |
|---|---|
imap_ping |
Connects to the IMAP server, authenticates and reports connection details (server greeting, capabilities, message count of the default mailbox) |
imap_list_mailboxes |
Lists all mailboxes/folders of the account with their flags and delimiter |
imap_list_messages |
Lists messages of a mailbox (envelope: from/subject/date, flags, size). Select by uids, date range (since/before, internal date) or the newest count messages |
imap_read |
Fetches one message by uid: headers, plain text and HTML body (capped at maxFetchBytes) and attachment metadata. Set attachments=true to also get base64 content (capped at maxAttachmentBytes). Does not mark the message as seen unless markSeen=true |
imap_search |
Searches messages in a mailbox and returns matching uids (newest last, capped at listLimit). Criteria: from, to, subject, text, since/before (internal date), unseen/seen, flagged/unflagged, answered/unanswered |
imap_set_flags |
Adds, removes or sets flags on messages. Flag names: seen, flagged, answered, deleted, draft (case-insensitive; raw IMAP flags like \Seen are passed through) |
imap_move |
Moves messages to another mailbox |
imap_delete |
Marks messages as \Deleted and expunges them (permanently removes them from the mailbox) |
Dependencies
Dependencies
| ID | Version |
|---|---|
| imapflow | ^1.6.0 |
| mailparser | ^3.9.0 |
Details
Assets (1)
Versions (3)
View all
plugin-imap-1.0.0.tgz
5.6 KiB