Email Connector
Execute email requests
Required inputs
| Key | Label | Type |
|---|---|---|
authentication.simpleAuthenticationUsername | Username | FEEL expression |
authentication.simpleAuthenticationPassword | Email password | secret |
data.imapHost | IMAP Host | FEEL expression |
data.imapPort | IMAP Port | FEEL expression |
imapCryptographicProtocol | Encryption protocol | string |
data.pop3Host | POP3 Host | FEEL expression |
data.pop3Port | POP3 Port | FEEL expression |
pop3CryptographicProtocol | Cryptographic protocol | string |
data.smtpHost | SMTP Host | FEEL expression |
data.smtpPort | SMTP Port | FEEL expression |
smtpCryptographicProtocol | Cryptographic protocol | string |
smtpFrom | From | FEEL expression |
smtpTo | To | FEEL expression |
smtpSubject | Subject | FEEL expression |
smtpBody | Email Content | FEEL expression |
pop3maxToBeRead | Maximum number of emails to be read | string |
pop3SortField | Sort emails by | string |
pop3SortOrder | Sort order | string |
pop3MessageIdDelete | Message ID | FEEL expression |
pop3MessageIdRead | Message ID | FEEL expression |
imapMaxToBeRead | Maximum number of emails to be read | string |
imapSortField | Sort emails by | string |
imapSortOrder | Sort order | string |
imapMessageIdRead | Message ID | FEEL expression |
imapMessageIdDelete | Message ID | FEEL expression |
imapMessageIdMove | Message ID | FEEL expression |
data.fromFolder | Source folder | FEEL expression |
data.toFolder | Target folder | FEEL expression |
Optional inputs
| Key | Label | Type |
|---|---|---|
authentication.type | Authentication | string |
protocol | Email Protocol | string |
data.smtpActionDiscriminator | SMTP action | string |
data.pop3ActionDiscriminator | POP3 action | string |
data.imapActionDiscriminator | IMAP action | string |
smtpCc | Cc | FEEL expression |
smtpBcc | Bcc | FEEL expression |
searchStringEmailPop3 | Search criteria | FEEL expression |
imapListEmailsFolder | Folder | FEEL expression |
searchStringEmailImap | Search criteria | FEEL expression |
searchEmailFolder | Folder | FEEL expression |
readEmailFolder | Folder | FEEL expression |
deleteEmailFolder | Folder | FEEL expression |
resultVariable | Result variable | string |
resultExpression | Result expression | FEEL expression |
errorExpression | Error expression | FEEL expression |
retryCount | Retries | FEEL expression |
retryBackoff | Retry backoff | FEEL expression |
Apply this connector with @bpmnkit/connectors
import { applyConnectorTemplate } from "@bpmnkit/connectors"
const result = applyConnectorTemplate("io.camunda.connectors.email.v1", {
"authentication.simpleAuthenticationUsername": "= ...",
"authentication.simpleAuthenticationPassword": "<your email password>",
"data.imapHost": "= ...",
"data.imapPort": "= 993",
"imapCryptographicProtocol": "TLS",
"data.pop3Host": "= ...",
"data.pop3Port": "= 995",
"pop3CryptographicProtocol": "TLS",
"data.smtpHost": "= ...",
"data.smtpPort": "= 587",
"smtpCryptographicProtocol": "TLS",
"smtpFrom": "= ...",
"smtpTo": "= ...",
"smtpSubject": "= ...",
"smtpBody": "= ...",
"pop3maxToBeRead": "100",
"pop3SortField": "SENT_DATE",
"pop3SortOrder": "ASC",
"pop3MessageIdDelete": "= ...",
"pop3MessageIdRead": "= ...",
"imapMaxToBeRead": "100",
"imapSortField": "RECEIVED_DATE",
"imapSortOrder": "ASC",
"imapMessageIdRead": "= ...",
"imapMessageIdDelete": "= ...",
"imapMessageIdMove": "= ...",
"data.fromFolder": "= ...",
"data.toFolder": "= ...",
"authentication.type": "simple",
"protocol": "imap",
})