Skip to content

Gmail Trigger

Node: gmailTrigger · Full type: n8n-nodes-base.gmailTrigger · Version: 1.3

Credentials

googleApi (alias: @google) / gmailOAuth2 (alias: @gmail)

CREDENTIAL @google = googleApi "My Gmail Trigger"

Parameters

Parameter Type Default Details
pollTimes fixedCollection {...} groups: item
authentication options "oAuth2" oAuth2, serviceAccount
event options "messageReceived" messageReceived
simple boolean true
filters collection {} keys: includeSpamTrash, includeDrafts, labelIds, q, readStatus, sender
options collection {} keys: dataPropertyAttachmentsPrefixName, downloadAttachments

pollTimes children:

item group:

Parameter Type Default Details
mode options "everyDay" everyMinute, everyHour, everyDay, everyWeek, everyMonth, everyX, custom
hour number 14
minute number 0
dayOfMonth number 1
weekday options "1" 1, 2, 3, 4, 5, 6, 0
cronExpression string " * * * * "
value number 2
unit options "hours" minutes, hours

filters children:

Parameter Type Default Details
includeSpamTrash boolean false
includeDrafts boolean false
labelIds multiOptions []
q string ""
readStatus options "unread" both, unread, read
sender string ""

options children:

Parameter Type Default Details
dataPropertyAttachmentsPrefixName string "attachment_"
downloadAttachments boolean false

Example

NODE "gmailTrigger" @google AS "Gmail Trigger"