diff --git a/workflows/Receive email updates via IMAP-587/readme-587.md b/workflows/Receive email updates via IMAP-587/readme-587.md new file mode 100644 index 000000000..dc61916b8 --- /dev/null +++ b/workflows/Receive email updates via IMAP-587/readme-587.md @@ -0,0 +1,92 @@ +Receive email updates via IMAP + +https://n8nworkflows.xyz/workflows/receive-email-updates-via-imap-587 + + +# Receive email updates via IMAP + +### 1. Workflow Overview + +This workflow is designed to receive email updates via the IMAP protocol. It acts as a companion example for the IMAP Email node documentation in n8n, demonstrating how to connect to an IMAP server, read incoming emails, and process them within an automation workflow. + +The workflow consists of a single logical block: + +- **1.1 Email Reception via IMAP:** Connects to an IMAP email server, reads new emails, and outputs the email data for downstream processing. + +--- + +### 2. Block-by-Block Analysis + +#### 1.1 Email Reception via IMAP + +- **Overview:** + This block connects to an IMAP mail server using configured credentials, retrieves emails from the inbox (or specified mailbox), and outputs the email data for further automation steps. It is the entry point to receive email updates in the workflow. + +- **Nodes Involved:** + - IMAP Email + +- **Node Details:** + + - **Name:** IMAP Email + - **Type:** EmailReadImap (built-in n8n node) + - **Technical Role:** Connects to an IMAP server to read emails. + - **Configuration Choices:** + - Uses saved IMAP credentials (`imap_creds`) for authentication. + - Option `Allow Unauthorized Certificates` is set to `false`, enforcing valid SSL/TLS certificates. + - No advanced options or filters configured, defaults apply (e.g., reading from Inbox). + - **Key Expressions/Variables:** None beyond credentials reference. + - **Input Connections:** None (start node). + - **Output Connections:** None (workflow ends here or can be extended). + - **Version-Specific Requirements:** Compatible with n8n version supporting `emailReadImap` node Type Version 1. + - **Edge Cases / Potential Failures:** + - Authentication failure if IMAP credentials are invalid. + - Connection failure due to network issues or incorrect server details. + - SSL/TLS certificate validation failure if server uses self-signed or invalid cert and `Allow Unauthorized Certificates` is false. + - Email retrieval failure if mailbox is empty or server limits are exceeded. + - **Sub-workflow Reference:** None. + +--- + +### 3. Summary Table + +| Node Name | Node Type | Functional Role | Input Node(s) | Output Node(s) | Sticky Note | +|------------|--------------------|--------------------------|---------------|----------------|------------------------------------| +| IMAP Email | EmailReadImap (n8n) | Receive and read emails via IMAP server | None | None | Companion workflow for IMAP Email node docs | + +--- + +### 4. Reproducing the Workflow from Scratch + +1. **Create a new workflow** in n8n. + +2. **Add a new node:** + - Select the node type: **EmailReadImap** (usually named "IMAP Email"). + - Position it appropriately on the canvas. + +3. **Configure the IMAP Email node:** + - Set **Credentials:** Choose or create new IMAP credentials with the following details: + - IMAP server hostname (e.g., `imap.example.com`) + - Port (usually 993 for IMAP over SSL) + - Username and password for the mailbox + - Authentication method as needed + - In the **Options** section: + - Set **Allow Unauthorized Certificates** to `false` to enforce valid SSL/TLS certificate validation. + - (Optional) Adjust mailbox or search parameters if needed (default is Inbox). + +4. **No input connections** are needed, as this node acts as the start trigger or input provider. + +5. **No output connections** are configured in this minimal workflow, but downstream nodes can be attached to process the emails. + +6. **Save the workflow** and execute it to test email retrieval. + +--- + +### 5. General Notes & Resources + +| Note Content | Context or Link | +|----------------------------------------|----------------------------------------| +| This workflow serves as a companion example for the IMAP Email node documentation in n8n. | https://docs.n8n.io/integrations/builtin/app-nodes/n8n-nodes-base.emailReadImap/ | + +--- + +This documentation covers all aspects of the simple "Receive email updates via IMAP" workflow, enabling users and automation agents to understand, reproduce, and extend it confidently. \ No newline at end of file