https://embedded-workflow-builder.netlify.app/assets/js/47c97223.8fdd0dab.js

1"use strict";(self.webpackChunkembedded_workflow_builder_docs=self.webpackChunkembedded_workflow_builder_docs||[]).push([["751"],{33579(n,e,s){s.r(e),s.d(e,{metadata:()=>t,default:()=>a,frontMatter:()=>d,contentTitle:()=>l,toc:()=>o,assets:()=>c});var t=JSON.parse('{"id":"connectors/imap","title":"IMAP Connector","description":"Interact with your IMAP email account","source":"@site/docs/connectors/imap.md","sourceDirName":"connectors","slug":"/connectors/imap","permalink":"/connectors/imap","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{"title":"IMAP Connector","sidebar_label":"IMAP","description":"Interact with your IMAP email account"},"sidebar":"docs","previous":{"title":"HubSpot","permalink":"/connectors/hubspot"},"next":{"title":"Intercom","permalink":"/connectors/intercom"}}'),i=s(74848),r=s(28453);let d={title:"IMAP Connector",sidebar_label:"IMAP",description:"Interact with your IMAP email account"},l,c={},o=[{value:"API Documentation",id:"api-documentation",level:2},{value:"Connections",id:"connections",level:2},{value:"IMAP Connection",id:"imap",level:3},{value:"Prerequisites",id:"prerequisites",level:4},{value:"Setup Steps",id:"setup-steps",level:4},{value:"Gmail",id:"gmail",level:4},{value:"Microsoft Office 365",id:"microsoft-office-365",level:4},{value:"Configure the Connection",id:"configure-the-connection",level:4},{value:"Triggers",id:"triggers",level:2},{value:"New Emails",id:"newemailspollingtrigger",level:3},{value:"Actions",id:"actions",level:2},{value:"Add Flags",id:"addflags",level:3},{value:"Append Message",id:"appendmessage",level:3},{value:"Copy Message",id:"copymessage",level:3},{value:"Create Mailbox",id:"createmailbox",level:3},{value:"Delete Message",id:"deletemessage",level:3},{value:"Download Message",id:"downloadmessage",level:3},{value:"Get Mailbox Status",id:"getstatus",level:3},{value:"List Mailboxes",id:"listmailboxes",level:3},{value:"Remove Flags From Message",id:"removeflags",level:3},{value:"Rename Mailbox",id:"renamemailbox",level:3},{value:"Search / List Mailbox Messages",id:"searchmailbox",level:3},{value:"Set Flags",id:"setflags",level:3}];function h(n){let e={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",img:"img",li:"li",ol:"ol",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,r.R)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.img,{alt:"IMAP",src:s(36404).A+"#connector-icon",width:"32",height:"32"}),"\n",(0,i.jsx)(e.a,{href:"https://en.wikipedia.org/wiki/Internet_Message_Access_Protocol",children:"IMAP"})," (Internet Message Access Protocol) is an Internet standard protocol used by email clients to retrieve email messages from a mail server over a TCP/IP connection.\nThis component gives you the ability to list mailboxes, search and fetch emails, manage message flags, and copy or move messages on any IMAP server."]}),"\n",(0,i.jsx)(e.h2,{id:"api-documentation",children:"API Documentation"}),"\n",(0,i.jsxs)(e.p,{children:["This component was built using the ",(0,i.jsx)(e.a,{href:"https://imapflow.com/docs/",children:"ImapFlow Node.js library"}),"."]}),"\n",(0,i.jsx)(e.h2,{id:"connections",children:"Connections"}),"\n",(0,i.jsx)(e.h3,{id:"imap",children:"IMAP Connection"}),"\n",(0,i.jsx)(e.p,{children:"Provide the details of your IMAP server."}),"\n",(0,i.jsx)(e.p,{children:"To configure a connection to an IMAP server, the server's host address, port, login credentials, and TLS settings are required."}),"\n",(0,i.jsx)(e.p,{children:"The setup can vary widely depending on the email service in use. Context for some popular services is provided below."}),"\n",(0,i.jsx)(e.h4,{id:"prerequisites",children:"Prerequisites"}),"\n",(0,i.jsxs)(e.ul,{children:["\n",(0,i.jsx)(e.li,{children:"Access to an IMAP-enabled email account"}),"\n",(0,i.jsx)(e.li,{children:"The IMAP server host address and port"}),"\n",(0,i.jsx)(e.li,{children:"Valid login credentials (username and password or app password)"}),"\n"]}),"\n",(0,i.jsx)(e.h4,{id:"setup-steps",children:"Setup Steps"}),"\n",(0,i.jsx)(e.h4,{id:"gmail",children:"Gmail"}),"\n",(0,i.jsxs)(e.p,{children:["To set up an IMAP connection to a Gmail account, create a ",(0,i.jsx)(e.a,{href:"https://support.google.com/accounts/answer/185833?hl=en",children:"Google App Password"}),":"]}),"\n",(0,i.jsxs)(e.ol,{children:["\n",(0,i.jsxs)(e.li,{children:["Navigate to the ",(0,i.jsx)(e.a,{href:"https://myaccount.google.com/",children:"Google Account"})," page and select ",(0,i.jsx)(e.strong,{children:"Security"}),"."]}),"\n",(0,i.jsxs)(e.li,{children:["Under ",(0,i.jsx)(e.strong,{children:"Signing in to Google"}),", select ",(0,i.jsx)(e.strong,{children:"App Passwords"}),". Sign-in may be required."]}),"\n",(0,i.jsxs)(e.li,{children:["If the ",(0,i.jsx)(e.strong,{children:"App Passwords"})," option is not available, possible reasons include:\n",(0,i.jsxs)(e.ul,{children:["\n",(0,i.jsx)(e.li,{children:"2-Step Verification is not set up for the account"}),"\n",(0,i.jsx)(e.li,{children:"2-Step Verification is only set up for security ke

1ys"}),"\n",(0,i.jsx)(e.li,{children:"The account is through work, school, or another organization"}),"\n",(0,i.jsx)(e.li,{children:"Advanced Protection is enabled"}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(e.li,{children:["At the bottom, click ",(0,i.jsx)(e.strong,{children:"Select App"})," and choose ",(0,i.jsx)(e.strong,{children:"Mail"}),", then click ",(0,i.jsx)(e.strong,{children:"Select device"})," and choose ",(0,i.jsx)(e.strong,{children:"Other (Custom name)"}),"."]}),"\n",(0,i.jsxs)(e.li,{children:["Click ",(0,i.jsx)(e.strong,{children:"GENERATE"}),"."]}),"\n",(0,i.jsxs)(e.li,{children:["A 16-character code will be generated \u2014 this is the ",(0,i.jsx)(e.strong,{children:"app password"}),". Copy it to a safe location."]}),"\n"]}),"\n",(0,i.jsxs)(e.p,{children:["If authentication problems occur, ensure the account has ",(0,i.jsx)(e.a,{href:"https://support.google.com/mail/answer/7126229",children:"IMAP enabled"}),"."]}),"\n",(0,i.jsx)(e.h4,{id:"microsoft-office-365",children:"Microsoft Office 365"}),"\n",(0,i.jsx)(e.p,{children:"If the Office 365 domain does not use multi-factor authentication (this is rare), the username and password can be used to authenticate directly."}),"\n",(0,i.jsxs)(e.p,{children:["If MFA is enabled, an ",(0,i.jsx)(e.strong,{children:"app password"})," is required to authenticate. To create an app password:"]}),"\n",(0,i.jsxs)(e.ol,{children:["\n",(0,i.jsxs)(e.li,{children:["Log in to the ",(0,i.jsx)(e.a,{href:"https://mysignins.microsoft.com/security-info",children:"Microsoft Security Center"})," and open the ",(0,i.jsx)(e.strong,{children:"Security info"})," tab."]}),"\n",(0,i.jsxs)(e.li,{children:["Click ",(0,i.jsx)(e.strong,{children:"+Add method"})," and choose ",(0,i.jsx)(e.strong,{children:"App password"}),"."]}),"\n",(0,i.jsx)(e.li,{children:"Enter a name for the app password, and copy the password that is generated."}),"\n"]}),"\n",(0,i.jsxs)(e.p,{children:["If the ",(0,i.jsx)(e.strong,{children:"App password"})," option is unavailable, contact the Office 365 administrator to ",(0,i.jsx)(e.a,{href:"https://support.microsoft.com/en-us/account-billing/manage-app-passwords-for-two-step-verification-d6dc8c6d-4bf7-4851-ad95-6d07799387e9",children:"enable it"}),"."]}),"\n",(0,i.jsx)(e.h4,{id:"configure-the-connection",children:"Configure the Connection"}),"\n",(0,i.jsxs)(e.p,{children:["Create a connection of type ",(0,i.jsx)(e.strong,{children:"IMAP Connection"})," and enter the following values:"]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,i.jsxs)(e.table,{children:[(0,i.jsx)(e.thead,{children:(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.th,{children:"Input"}),(0,i.jsx)(e.th,{children:"Description"}),(0,i.jsx)(e.th,{children:"Default"})]})}),(0,i.jsxs)(e.tbody,{children:[(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:(0,i.jsx)(e.strong,{children:"Host"})}),(0,i.jsxs)(e.td,{children:["The IMAP server hostname (e.g., ",(0,i.jsx)(e.code,{children:"imap.gmail.com"})," for Gmail, ",(0,i.jsx)(e.code,{children:"outlook.office365.com"})," for Office 365)"]}),(0,i.jsx)(e.td,{children:"\u2014"})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:(0,i.jsx)(e.strong,{children:"Port"})}),(0,i.jsx)(e.td,{children:"The IMAP server port"}),(0,i.jsx)(e.td,{children:(0,i.jsx)(e.code,{children:"993"})})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:(0,i.jsx)(e.strong,{children:"Secure"})}),(0,i.jsx)(e.td,{children:"Whether to use a secure (TLS) connection"}),(0,i.jsx)(e.td,{children:(0,i.jsx)(e.code,{children:"true"})})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:(0,i.jsx)(e.strong,{children:"Username"})}),(0,i.jsx)(e.td,{children:"The email address or username for the IMAP account"}),(0,i.jsx)(e.td,{children:"\u2014"})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:(0,i.jsx)(e.strong,{children:"Password"})}),(0,i.jsx)(e.td,{children:"The account password or app password"}),(0,i.jsx)(e.td,{children:"\u2014"})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:(0,i.jsx)(e.strong,{children:"Minimum TLS Version"})}),(0,i.jsx)(e.td,{children:"The minimum TLS version accepted by the connection"}),(0,i.jsx)(e.td,{children:(0,i.jsx)(e.code,{children:"TLSv1.1"})})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:(0,i.jsx)(e.strong,{children:"Maximum TLS Version"})}),(0,i.jsx)(e.td,{children:"The maximum TLS version accepted by the connection"}),(0,i.jsx)(e.td,{children:(0,i.jsx)(e.code,{children:"TLSv1.3"})})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:(0,i.jsx)(e.strong,{children:"Min DH Size"})}),(0,i.jsx)(e.td,{children:"Minimum key size (in bits) to accept in a TLS connection"}),(0,i.jsx)(e.td,{children:(0,i.jsx)(e.code,{children:"1024"})})]})]})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,i.jsxs)(e.table,{children:[(0,i.jsx)(e.thead,{children:(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.th,{children:"Input"}),(0,i.jsx)(e.th,{children:"Comments"}),(0,i.jsx)(e.th,{children:"Default"})]})}),(0,i.jsxs)(e.tbody,{children:[(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Host"}),(0,i.jsx)(e.td,{children:"Provide the host address for the desired IMAP server."}),(0,i.jsx)(e.td,{})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Port"}),(0,i.jsx)(e.td,{children:"Provide the port for the desired IMAP server."}),(0,i.jsx)(e.td,{children:"993"})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Secure"}),(0,i.jsx)(e.td,{children:"Determines if the connection is secure."}),(0,i.jsx)(e.td,{children:"true"})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Username"}),(0,i.jsx)(e.td,{children:"Provide a valid username or email."}),(0,i.jsx)(e.td,{})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Password"}),(0,i.jsx)(e.td,{children:"Provide the password for the given user. This value is required if secured is set to true."}),(0,i.jsx)(e.td,{})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Minimum TLS Version"}),(0,i.jsx)(e.td,{children:"Provide a valid TLS version to be used in the connection."}),(0,i.jsx)(e.td,{children:"TLSv1.1"})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Maximum TLS Version"}),(0,i.jsx)(e.td,{children:"Provide a valid TLS version to be used in the connection."}),(0,i.jsx)(e.td,{children:"TLSv1.3"})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Min DH Size"}),(0,i.jsx)(e.td,{children:"Minimum size of bits to accept in a TLS connection"}),(0,i.jsx)(e.td,{children:"1024"})]})]})]}),"\n",(0,i.jsx)(e.h2,{id:"triggers",children:"Triggers"}),"\n",(0,i.jsx)(e.h3,{id:"newemailspollingtrigger",children:"New Emails"}),"\n",(0,i.jsx)(e.p,{children:"Fetches new emails from a specified mailbox on a recurring schedule."}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,i.jsxs)(e.table,{children:[(0,i.jsx)(e.thead,{children:(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.th,{children:"Input"}),(0,i.jsx)(e.th,{children:"Comments"}),(0,i.jsx)(e.th,{children:"Default"})]})}),(0,i.jsxs)(e.tbody,{children:[(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Connection"}),(0,i.jsx)(e.td,{children:"The IMAP connection to use."}),(0,i.jsx)(e.td,{})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Mailbox"}),(0,i.jsx)(e.td,{children:"Provide a string value for the name of the mailbox."}),(0,i.jsx)(e.td,{})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Fetch Content"}),(0,i.jsx)(e.td,{children:"When enabled, downloads and parses the full message body for each new email."}),(0,i.jsx)(e.td,{children:"false"})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Mark as Read"}),(0,i.jsx)(e.td,{children:"When enabled, sets the Seen flag on new emails after polling."}),(0,i.jsx)(e.td,{children:"false"})]})]})]}),"\n",(0,i.jsx)(e.h2,{id:"actions",children:"Actions"}),"\n",(0,i.jsx)(e.h3,{id:"addflags",children:"Add Flags"}),"\n",(0,i.jsx)(e.p,{children:"Add new flags to an existing message"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,i.jsxs)(e.table,{children:[(0,i.jsx)(e.thead,{children:(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.th,{children:"Input"}),(0,i.jsx)(e.th,{children:"Comments"}),(0,i.jsx)(e.th,{children:"Default"})]})}),(0,i.jsxs)(e.tbody,{children:[(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Connection"}),(0,i.jsx)(e.td,{children:"The IMAP connection to use."}),(0,i.jsx)(e.td,{})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Mailbox"}),(0,i.jsx)(e.td,{children:"Provide a string value for the name of the mailbox."}),(0,i.jsx)(e.td,{})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Range"}),(0,i.jsx)(e.td,{children:"Provide a range of messages. Alternatively you can specify * to get the latest message."}),(0,i.jsx)(e.td,{})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Flags"}),(0,i.jsx)(e.td,{children:"For each item, provide a string value to be added to an existing message."}),(0,i.jsx)(e.td,{})]})]})]}),"\n",(0,i.jsx)(e.h3,{id:"appendmessage",children:"Append Message"}),"\n",(0,i.jsx)(e.p,{children:"Appends a new message to an existing mailbox"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,i.jsxs)(e.table,{children:[(0,i.jsx)(e.thead,{children:(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.th,{children:"Input"}),(0,i.jsx)(e.th,{children:"Comments"}),(0,i.jsx)(e.th,{children:"Default"})]})}),(0,i.jsxs)(e.tbody,{children:[(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Connection"}),(0,i.jsx)(e.td,{children:"The IMAP connection to use."}),(0,i.jsx)(e.td,{})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Mailbox"}),(0,i.jsx)(e.td,{children:"Provide a string value for the name of the mailbox."}),(0,i.jsx)(e.td,{})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Path"}),(0,i.jsx)(e.td,{children:"Mailbox path to upload the message to."}),(0,i.jsx)(e.td,{})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Message Content"}),(0,i.jsx)(e.td,{children:"The raw RFC 822 formatted message content to append."}),(0,i.jsx)(e.td,{})]})]})]}),"\n",(0,i.jsx)(e.h3,{id:"copymessage",children:"Copy Message"}),"\n",(0,i.jsx)(e.p,{children:"Copies a message from one mailbox to another."}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,i.jsxs)(e.table,{children:[(0,i.jsx)(e.thead,{children:(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.th,{children:"Input"}),(0,i.jsx)(e.th,{children:"Comments"}),(0,i.jsx)(e.th,{children:"Default"})]})}),(0,i.jsxs)(e.tbody,{children:[(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Connection"}),(0,i.jsx)(e.td,{children:"The IMAP connection to use."}),(0,i.jsx)(e.td,{})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Mailbox"}),(0,i.jsx)(e.td,{children:"Provide a string value for the name of the mailbox."}),(0,i.jsx)(e.td,{})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Range"}),(0,i.jsx)(e.td,{children:"Provide a range of messages. Alternatively you can specify * to get the latest message."}),(0,i.jsx)(e.td,{})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"New Path"}),(0,i.jsx)(e.td,{children:"Mailbox path to upload the message to."}),(0,i.jsx)(e.td,{})]})]})]}),"\n",(0,i.jsx)(e.h3,{id:"createmailbox",children:"Create Mailbox"}),"\n",(0,i.jsx)(e.p,{children:"Creates a new mailbox folder and sets up subscription for the created mailbox"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,i.jsxs)(e.table,{children:[(0,i.jsx)(e.thead,{children:(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.th,{children:"Input"}),(0,i.jsx)(e.th,{children:"Comments"}),(0,i.jsx)(e.th,{children:"Default"})]})}),(0,i.jsxs)(e.tbody,{children:[(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Connection"}),(0,i.jsx)(e.td,{children:"The IMAP connection to use."}),(0,i.jsx)(e.td,{})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Path"}),(0,i.jsx)(e.td,{children:"Mailbox path to upload the message to."}),(0,i.jsx)(e.td,{})]})]})]}),"\n",(0,i.jsx)(e.h3,{id:"deletemessage",children:"Delete Message"}),"\n",(0,i.jsx)(e.p,{children:"Delete an existing message"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,i.jsxs)(e.table,{children:[(0,i.jsx)(e.thead,{children:(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.th,{children:"Input"}),(0,i.jsx)(e.th,{children:"Comments"}),(0,i.jsx)(e.th,{children:"Default"})]})}),(0,i.jsxs)(e.tbody,{children:[(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Connection"}),(0,i.jsx)(e.td,{children:"The IMAP connection to use."}),(0,i.jsx)(e.td,{})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Mailbox"}),(0,i.jsx)(e.td,{children:"Provide a string value for the name of the mailbox."}),(0,i.jsx)(e.td,{})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Message UID"}),(0,i.jsx)(e.td,{children:"The UID of the message."}),(0,i.jsx)(e.td,{})]})]})]}),"\n",(0,i.jsx)(e.h3,{id:"downloadmessage",children:"Download Message"}),"\n",(0,i.jsx)(e.p,{children:"Download either full RFC-822 formatted message or a specific body structure part"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,i.jsxs)(e.table,{children:[(0,i.jsx)(e.thead,{children:(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.th,{children:"Input"}),(0,i.jsx)(e.th,{children:"Comments"}),(0,i.jsx)(e.th,{children:"Default"})]})}),(0,i.jsxs)(e.tbody,{children:[(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Connection"}),(0,i.jsx)(e.td,{children:"The IMAP connection to use."}),(0,i.jsx)(e.td,{})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Mailbox"}),(0,i.jsx)(e.td,{children:"Provide a string value for the name of the mailbox."}),(0,i.jsx)(e.td,{})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Message Index or ID"}),(0,i.jsx)(e.td,{children:"The index of the message you would like to download (1 for the oldest message, 2 for second oldest, etc), or the ID of the message."}),(0,i.jsx)(e.td,{})]})]})]}),"\n",(0,i.jsx)(e.h3,{id:"getstatus",children:"Get Mailbox Status"}),"\n",(0,i.jsx)(e.p,{children:"Returns the status of a mailbox's properties"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,i.jsxs)(e.table,{children:[(0,i.jsx)(e.thead,{children:(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.th,{children:"Input"}),(0,i.jsx)(e.th,{children:"Comments"}),(0,i.jsx)(e.th,{children:"Default"})]})}),(0,i.jsxs)(e.tbody,{children:[(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Connection"}),(0,i.jsx)(e.td,{children:"The IMAP connection to use."}),(0,i.jsx)(e.td,{})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Mailbox"}),(0,i.jsx)(e.td,{children:"Provide a string value for the name of the mailbox."}),(0,i.jsx)(e.td,{})]})]})]}),"\n",(0,i.jsx)(e.h3,{id:"listmailboxes",children:"List Mailboxes"}),"\n",(0,i.jsx)(e.p,{children:"Returns a list of available mailboxes"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,i.jsxs)(e.table,{children:[(0,i.jsx)(e.thead,{children:(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.th,{children:"Input"}),(0,i.jsx)(e.th,{children:"Comments"}),(0,i.jsx)(e.th,{children:"Default"})]})}),(0,i.jsx)(e.tbody,{children:(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Connection"}),(0,i.jsx)(e.td,{children:"The IMAP connection to use."}),(0,i.jsx)(e.td,{})]})})]}),"\n",(0,i.jsx)(e.h3,{id:"removeflags",children:"Remove Flags From Message"}),"\n",(0,i.jsx)(e.p,{children:"Remove existing flags from an existing message"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,i.jsxs)(e.table,{children:[(0,i.jsx)(e.thead,{children:(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.th,{children:"Input"}),(0,i.jsx)(e.th,{children:"Comments"}),(0,i.jsx)(e.th,{children:"Default"})]})}),(0,i.jsxs)(e.tbody,{children:[(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Connection"}),(0,i.jsx)(e.td,{children:"The IMAP connection to use."}),(0,i.jsx)(e.td,{})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Mailbox"}),(0,i.jsx)(e.td,{children:"Provide a string value for the name of the mailbox."}),(0,i.jsx)(e.td,{})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Range"}),(0,i.jsx)(e.td,{children:"Provide a range of messages. Alternatively you can specify * to get the latest message."}),(0,i.jsx)(e.td,{})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Flags"}),(0,i.jsx)(e.td,{children:"For each item, provide a string value to be added to an existing message."}),(0,i.jsx)(e.td,{})]})]})]}),"\n",(0,i.jsx)(e.h3,{id:"renamemailbox",child

1ren:"Rename Mailbox"}),"\n",(0,i.jsx)(e.p,{children:"Change the name of an existing mailbox"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,i.jsxs)(e.table,{children:[(0,i.jsx)(e.thead,{children:(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.th,{children:"Input"}),(0,i.jsx)(e.th,{children:"Comments"}),(0,i.jsx)(e.th,{children:"Default"})]})}),(0,i.jsxs)(e.tbody,{children:[(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Connection"}),(0,i.jsx)(e.td,{children:"The IMAP connection to use."}),(0,i.jsx)(e.td,{})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Path"}),(0,i.jsx)(e.td,{children:"Mailbox path to upload the message to."}),(0,i.jsx)(e.td,{})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"New Path"}),(0,i.jsx)(e.td,{children:"Mailbox path to upload the message to."}),(0,i.jsx)(e.td,{})]})]})]}),"\n",(0,i.jsx)(e.h3,{id:"searchmailbox",children:"Search / List Mailbox Messages"}),"\n",(0,i.jsx)(e.p,{children:"Returns all messages in the given mailbox"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,i.jsxs)(e.table,{children:[(0,i.jsx)(e.thead,{children:(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.th,{children:"Input"}),(0,i.jsx)(e.th,{children:"Comments"}),(0,i.jsx)(e.th,{children:"Default"})]})}),(0,i.jsxs)(e.tbody,{children:[(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Connection"}),(0,i.jsx)(e.td,{children:"The IMAP connection to use."}),(0,i.jsx)(e.td,{})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Mailbox"}),(0,i.jsx)(e.td,{children:"Provide a string value for the name of the mailbox."}),(0,i.jsx)(e.td,{})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"From"}),(0,i.jsx)(e.td,{children:"Filter email messages by sender."}),(0,i.jsx)(e.td,{})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"To"}),(0,i.jsx)(e.td,{children:"Filter email messages by recipient."}),(0,i.jsx)(e.td,{})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Read / Unread Filter"}),(0,i.jsx)(e.td,{children:"Filter messages by read or unread status."}),(0,i.jsx)(e.td,{children:"all"})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Filter Options"}),(0,i.jsx)(e.td,{children:"Extra parameters to filter the search results."}),(0,i.jsx)(e.td,{})]})]})]}),"\n",(0,i.jsx)(e.h3,{id:"setflags",children:"Set Flags"}),"\n",(0,i.jsx)(e.p,{children:"Set a value for an existing message flag"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,i.jsxs)(e.table,{children:[(0,i.jsx)(e.thead,{children:(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.th,{children:"Input"}),(0,i.jsx)(e.th,{children:"Comments"}),(0,i.jsx)(e.th,{children:"Default"})]})}),(0,i.jsxs)(e.tbody,{children:[(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Connection"}),(0,i.jsx)(e.td,{children:"The IMAP connection to use."}),(0,i.jsx)(e.td,{})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Mailbox"}),(0,i.jsx)(e.td,{children:"Provide a string value for the name of the mailbox."}),(0,i.jsx)(e.td,{})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Range"}),(0,i.jsx)(e.td,{children:"Provide a range of messages. Alternatively you can specify * to get the latest message."}),(0,i.jsx)(e.td,{})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Flags"}),(0,i.jsx)(e.td,{children:"For each item, provide a string value to be added to an existing message."}),(0,i.jsx)(e.td,{})]})]})]})]})}function a(n={}){let{wrapper:e}={...(0,r.R)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(h,{...n})}):h(n)}},36404(n,e,s){s.d(e,{A:()=>t});let t="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAACXBIWXMAABcRAAAXEQHKJvM/AAAGaUlEQVRYhb1X6W8VVRSftuzQFtq+be7Mm3vnPUpL20eBFiVKWaJCQg2oCAalrLJFUUwkokBlKXRBwqIRg3wxRAGVJRGMdKEFWpboP0Ah0IWyNS1QSltf+445Z+Y9ppUGUMpNzsxdz/ndc84991xJ6r6ESZIUEWzYhXAwzucwzr9nnP/FuGhgXHSY1GD06XsZ92Rpmua08IkweT1VCTdJUlU1Sdb4HpmLBlX3gKp7AorQgXHRibAPx3COzEUjAlUUJbkrvycpEfhx+HwDZU3LZVy0IFMmSBDu1m/+u4J4OGaAAaaJVqaJPORl5f1Y4UzXh8qc/6nqXlCQocbbGReBRwjtjgK4BteqHi+geWTOhz0ORAR+XG7PKMZFLe3A2NHTCP43EC78Jq86p6qndQciHD+IknFRrQha0P4/BHelduIpRK1L0xKsMqWgh7pcrgGMiwoT7bMUHgJBDqqJcw6HY6BVdgR+VOHZaFE79BCRORSu53QyhdPtHs64uGuxW08BCPK+51DVJBOEJDEhdgZ3r+IRspBiLg62Q2feMtapzxIjgn1B0rxDsc+vkCz9GxLuio+Pk7mow8l2RQ1Exdkg1umCGIcTom12cKpuYoZ9SFi3MYXGg2O41qG4YYjdCQ7VHQLhUFSaN9jugOg4GwyKiQWnWzMCmcZv6LpuR8+ficgG2+wdc+bNh/PnL8CRo0fht2PHoLy8AqZkvg58aDwcOnwYftp/gBivWLkSzpSfgdlZWRDjdEGcS4bMadOhsLAIMqe/QW0UPG/hIigsLISiomIoKyuD3IIC8CYOR2AUH1TOZ0mKEDsQwBCH0//mzFlw5MhRaGq6D3V1dXDg4M8w4ZVXIdE3Alrb2gALCiqvqKD6ui/XQ2RMLGlmz9691Id/bONut+TnUx9uCDeABQE5FNVvBCj9a7R/mWmrDlzYP3owXL50GY4f/x3C+vajHY4a8wI01NdDu7+dQFVWVhKz7PUboF9UNCQkp8ClykvQ3NwMlRcvwrCkZOgbGQVb8vJoXkKKDyRJgoKvtlH7xXEZHWhGt+45LRmBRw95KGqjuqoaSkpKyIZoZwTQ2NAAZ8+ehY52P/xx4gTcvXOHdihF9IK5CxZAS0sLbNi0if7vzZ0HUkRvyN+6lQSOmziJtPLLr4cAAgEYOWZMwM4U9JVrCKAp6LWyxgE9tLqqCoqLS8AmMwKQmpYObS0tsGPnLmhsbISNOZuh/tZtyCvYClJYOPy4fz9cq60FO1PhxvXr8MO+fdSfl19AAGprauD2zZtUxz7UqnnqmkMAUAsut0YCq69WQVFxEQyxOwCR+kanEfIv1q4ju0+Zmgltra2wYVMOeXdNTQ3cb2qC0tJSeNDcDFeuXCHfyNmSS0I35+bCJ5+ugslTM8lBacPGSWiWGOdVQRMgKvRS1EDJyZOkDZfGIWXkqBAAqXcfGJacQoxXrV4Nk16bTPWyU6fgwMGDcKa8nNovT5gIa7OzDR9I9kGvAYMgTpaDOydzy1zUSkwTpWj3yJjYDjxeqGq/3

1w9/t7VB0917MGPWO+BJSCRGa9Zlk9MlpaYaAD5bDdu276B6os8HUp++MCItndo5uXnw+Zq1VB87LoM0q5HnG7mDsWn9NB7D7W6PF2yy4h+bkQEffPQxLFy8BBYtWQrLP1wBqenphPr9pctgbMZ48guMCzjnpfETYNpbM+DdrCwjWmKcFzpkzV9A8QC1sHjZctIqmjcUkjVuXtF8Fx7DGbhIETp5Jp5ftCtSZGwcnQRchG3Tc8lZg22KdDZ7p5iPbezH8ajYOJrf5U7owOsZgyCFYsbFNdMRA6gNKwXDKtZN+3VqI2HdKiA4hmutPIIXktm+7vR6bXQfYDTE9AtV04M3oUX9XkxOdoZuQ8xSGNfvMK4/t+sYU4CgfCMR1cT655WQYPJjlR2GH03T+uGx6OmUjHFRrihKf2tKFkoQMR1nQr9qJAzPOCk1eFbLQsSTxEc8VCLwI2taqsJF9bNOyxUuajDlt8p6VDESVK/Xg9mrCaKD8f/wMOHmw4QyYX5B8Xi8jxNulrdpAtqJufkmmYsHZibb9WlmBRTo+mwz34gPZDff7HKNHmCwNng/SQnv8lj5lnFe/6SPU5wra2K3U9MSu/J7mtLpeY4RU9H12YoQuxUhzjHObzIu2gzit2TOzytCfIdzQhHuIY9un+f/AAORVy4ssUWhAAAAAElFTkSuQmCC"},28453(n,e,s){s.d(e,{R:()=>d,x:()=>l});var t=s(96540);let i={},r=t.createContext(i);function d(n){let e=t.useContext(r);return t.useMemo(function(){return"function"==typeof n?n(e):{...e,...n}},[e,n])}function l(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(i):n.components||i:d(n.components),t.createElement(r.Provider,{value:e},n.children)}}}]);