Overview

This node, named IMAP Manager, allows users to manage their email via the IMAP protocol. It supports various operations such as listing mailboxes, searching messages by Message-ID, adding or removing keywords (tags) on messages, moving or copying messages between mailboxes, deleting messages, and marking messages as unread. It is useful for automating email management tasks, for example, filtering mailboxes by name, tagging emails for categorization, or moving emails to specific folders automatically.

Use Case Examples

1. List all mailboxes containing 'Sales' in their name or path.
2. Search for emails by their RFC822 Message-ID to find specific messages.
3. Add custom tags to an email to categorize it.
4. Move an email from the inbox to an archive folder, creating the archive folder if it doesn't exist.

Properties

Output

JSON

• mailboxes - An array of mailbox objects when listing mailboxes, each containing path, name, flags, specialUse, delimiter, and listed status.
• path - The full path of a mailbox.
• name - The display name of a mailbox.
• flags - Array of flags associated with the mailbox.
• specialUse - Special use attribute of the mailbox, if any.
• delimiter - Delimiter character used in mailbox paths.
• listed - Boolean indicating if the mailbox is listed.
• mailbox - The mailbox name involved in the operation.
• messageId - The RFC822 Message-ID used in search operations.
• uids - Array of UIDs of messages matching the search criteria.
• uid - UID of the message involved in keyword, move, copy, delete, or mark unread operations.
• operation - The operation performed, e.g., addKeywords or removeKeywords.
• keywords - List of keywords added or removed from a message.
• movedTo - Destination mailbox path where a message was moved.
• copiedTo - Destination mailbox path where a message was copied.
• result - Result of move or copy operation, indicating success or failure.
• deleted - Boolean indicating if a message was deleted.
• unread - Boolean indicating if a message was marked as unread.

Dependencies

• Requires IMAP server credentials including host, port, security setting, username, and password.

Troubleshooting

• Common errors include missing required parameters such as messageId for search, uid for message operations, or destMailbox for move/copy operations. Ensure these are provided to avoid NodeOperationError.
• If the destination mailbox does not exist during move or copy operations and 'Create Destination If Missing' is enabled, the node attempts to create it. If creation fails, the operation will error out.
• Connection issues may arise if IMAP credentials are incorrect or the server is unreachable. Verify credentials and network connectivity.

Links

• ImapFlow Library - The underlying IMAP client library used by the node for IMAP operations.