emailReadImap.json•3.37 kB
{
"nodeType": "n8n-nodes-base.emailReadImap",
"displayName": "EmailReadImap",
"description": null,
"version": "2.1",
"properties": [
{
"name": "mailbox",
"displayName": "Mailbox Name",
"type": "string",
"default": "INBOX"
},
{
"name": "postProcessAction",
"displayName": "Action",
"type": "options",
"default": "read",
"description": "What to do after the email has been received. If \"nothing\" gets selected it will be processed multiple times.",
"options": [
{
"name": "Mark as Read",
"value": "read"
},
{
"name": "Nothing",
"value": "nothing"
}
]
},
{
"name": "downloadAttachments",
"displayName": "Download Attachments",
"type": "boolean",
"default": false,
"description": "Whether attachments of emails should be downloaded. Only set if needed as it increases processing.",
"displayOptions": {
"show": {
"format": [
"simple"
]
}
}
},
{
"name": "format",
"displayName": "Format",
"type": "options",
"default": "simple",
"description": "Returns the full email message data with body content in the raw field as a base64url encoded string; the payload field is not used",
"options": [
{
"name": "RAW",
"value": "raw",
"description": "Returns the full email message data with body content in the raw field as a base64url encoded string; the payload field is not used"
},
{
"name": "Resolved",
"value": "resolved",
"description": "Returns the full email with all data resolved and attachments saved as binary data"
},
{
"name": "Simple",
"value": "simple",
"description": "Returns the full email; do not use if you wish to gather inline attachments"
}
]
},
{
"name": "dataPropertyAttachmentsPrefixName",
"displayName": "Property Prefix Name",
"type": "string",
"default": "attachment_",
"description": "Prefix for name of the binary property to which to write the attachments. An index starting with 0 will be added. So if name is \"attachment_\" the first attachment is saved to \"attachment_0\"",
"displayOptions": {
"show": {
"format": [
"resolved"
]
}
}
},
{
"name": "options",
"displayName": "Options",
"type": "collection",
"default": {},
"description": "Custom email fetching rules. See <a href=\"https://github.com/mscdex/node-imap\">node-imap</a>'s search function for more details.",
"placeholder": "Add option"
}
],
"credentialsConfig": [
{
"name": "imap",
"required": true
},
{
"name": "mailbox",
"required": false
},
{
"name": "downloadAttachments",
"required": false
},
{
"name": "dataPropertyAttachmentsPrefixName",
"required": false
}
],
"io": {
"inputs": [],
"outputs": [],
"outputNames": [],
"hints": {}
},
"wiring": {
"role": "generic",
"requires": [],
"optional": [],
"consumedBy": [],
"consumes": [],
"produces": []
}
}