MailReceivedTrigger

Trigger that listens for new emails in Gmail

Monitors Gmail inbox or specific labels for new messages and emits an event for each new email detected. The trigger uses polling to check for new emails and filters by message timestamp to avoid duplicates.

yaml
type: "io.kestra.plugin.googleworkspace.mail.MailReceivedTrigger"

Examples

Monitor inbox for any new email

yaml
id: gmail_new_messages
namespace: company.team

tasks:
  - id: process_email
    type: io.kestra.plugin.core.log.Log
    message: "New email from {{ trigger.from }}: {{ trigger.subject }}"

triggers:
  - id: watch_inbox
    type: io.kestra.plugin.googleworkspace.mail.MailReceivedTrigger
    clientId: "{{ secret('GMAIL_CLIENT_ID') }}"
    clientSecret: "{{ secret('GMAIL_CLIENT_SECRET') }}"
    refreshToken: "{{ secret('GMAIL_REFRESH_TOKEN') }}"
    interval: PT5M

Monitor specific labels with query filter

yaml
id: gmail_urgent_messages
namespace: company.team

tasks:
  - id: notify_urgent
    type: io.kestra.plugin.notifications.slack.SlackIncomingWebhook
    url: "{{ secret('SLACK_WEBHOOK') }}"
    payload: |
      {
        "text": "Urgent email: {{ trigger.subject }} from {{ trigger.from }}"
      }

triggers:
  - id: watch_urgent
    type: io.kestra.plugin.googleworkspace.mail.MailReceivedTrigger
    clientId: "{{ secret('GMAIL_CLIENT_ID') }}"
    clientSecret: "{{ secret('GMAIL_CLIENT_SECRET') }}"
    refreshToken: "{{ secret('GMAIL_REFRESH_TOKEN') }}"
    query: "is:unread label:urgent"
    labelIds:
      - INBOX
      - URGENT
    interval: PT2M

Properties

clientId *string

OAuth 2.0 Client ID

The OAuth 2.0 client ID from Google Cloud Console

clientSecret *string

OAuth 2.0 Client Secret

The OAuth 2.0 client secret from Google Cloud Console

refreshToken *string

OAuth 2.0 Refresh Token

The OAuth 2.0 refresh token obtained through the authorization flow

accessToken string

OAuth 2.0 Access Token

The OAuth 2.0 access token (optional, will be generated from refresh token if not provided)

conditions DateTimeBetween DayWeek DayWeekInMonth ExecutionFlow ExecutionLabels ExecutionNamespace ExecutionOutputs ExecutionStatus Expression FlowCondition FlowNamespaceCondition HasRetryAttempt MultipleCondition Not Or PublicHoliday TimeBetween Weekend

List of conditions in order to limit the flow trigger.

includeSpamTrash booleanstring

Default false

Include spam and trash

Whether to include messages from SPAM and TRASH in the results

initialLookback string

Format duration

Lookback window for first run

On first execution, how far back to look for messages. Defaults to the polling interval.

interval string

Default PT5M

Format duration

The polling interval

How frequently to check for new emails. Must be at least PT1M (1 minute).

labelIds array

SubType string

Label IDs to filter messages

List of label IDs to restrict the search (e.g., INBOX, SENT, DRAFT, UNREAD). If not specified, searches all accessible messages.

maxMessagesPerPoll integerstring

Default 50

Maximum number of messages to process per poll

Limits the number of new messages processed in a single poll to avoid overwhelming the system

query string

Gmail search query

Search query using Gmail search syntax (e.g., 'is: unread', 'from: sender@example.com', 'subject: important'). If not specified, monitors all messages.

readTimeout integerstring

Default 120

The read timeout for the request (in seconds)

scopes array

SubType string

Default

["https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://www.googleapis.com/auth/gmail.send"]

The OAuth scopes to use

List of OAuth 2.0 scopes required for the operation

stopAfter array

SubType string

Possible Values

CREATEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINT

List of execution states after which a trigger should be stopped (a.k.a. disabled).

Outputs

messages array

SubType

List of new messages found during the poll

Each message can be accessed via trigger.messages0, trigger.messages1, etc. For convenience, if only one message is found, its fields are also available directly as trigger.subject, trigger.from, etc.

Definitions

io.kestra.core.models.triggers.TimeWindow

deadline string

Format partial-time

SLA daily deadline

Use it only for DAILY_TIME_DEADLINE SLA.

endTime string

Format partial-time

SLA daily end time

Use it only for DAILY_TIME_WINDOW SLA.

startTime string

Format partial-time

SLA daily start time

Use it only for DAILY_TIME_WINDOW SLA.

type string

Default DURATION_WINDOW

Possible Values

DAILY_TIME_DEADLINEDAILY_TIME_WINDOWDURATION_WINDOWSLIDING_WINDOW

The type of the SLA

The default SLA is a sliding window (DURATION_WINDOW) with a window of 24 hours.

window string

Format duration

The duration of the window

Use it only for DURATION_WINDOW or SLIDING_WINDOW SLA. See ISO_8601 Durations for more information of available duration value. The start of the window is always based on midnight except if you set windowAdvance parameter. Eg if you have a 10 minutes (PT10M) window, the first window will be 00: 00 to 00: 10 and a new window will be started each 10 minutes

windowAdvance string

Format duration

The window advance duration

Use it only for DURATION_WINDOW SLA. Allow to specify the start time of the window Eg: you want a window of 6 hours (window=PT6H), by default the check will be done between: 00: 00 and 06: 00, 06: 00 and 12: 00, 12: 00 and 18: 00, and 18: 00 and 00: 00. If you want to check the window between 03: 00 and 09: 00, 09: 00 and 15: 00, 15: 00 and 21: 00, and 21: 00 and 3: 00, you will have to shift the window of 3 hours by settings windowAdvance: PT3H

Condition for a specific flow of an execution.

flowId *string

The flow id.

namespace *string

The namespace of the flow.

type *object

Condition for a flow namespace.

namespace *string

The namespace of the flow or the prefix if prefix is true.

type *object

prefix boolean

Default false

If we must look at the flow namespace by prefix (checked using startsWith). The prefix is case sensitive.

Condition for a specific flow. Note that this condition is deprecated, use `io.kestra.plugin.core.condition.ExecutionFlow` instead.

flowId *string

The flow id.

namespace *string

The namespace of the flow.

type *object

Condition to allow events between two specific times.

type *object

after string

Format time

The time to test must be after this one.

Must be a valid ISO 8601 time with offset.

before string

Format time

The time to test must be before this one.

Must be a valid ISO 8601 time with offset.

date string

Default {{ trigger.date }}

The time to test.

Can be any variable or any valid ISO 8601 time. By default, it will use the trigger date.

Condition that checks labels of an execution.

labels *arrayobject

List of labels to match in the execution.

type *object

Condition based on the outputs of an upstream execution.

expression *booleanstring

type *object

Condition to allow events on weekend.

type *object

date string

Default {{ trigger.date }}

The date to test.

Can be any variable or any valid ISO 8601 datetime. By default, it will use the trigger date.

io.kestra.plugin.googleworkspace.mail.models.EmailMetadata

bcc array

SubType string

The BCC recipient email addresses

cc array

SubType string

The CC recipient email addresses

from string

The sender email address

headers object

SubType string

The parsed headers of the message

historyId string

The ID of the last history record that modified this message

id string

The immutable ID of the message

internalDate string

Format date-time

The internal message creation timestamp

labelIds array

SubType string

List of IDs of labels applied to this message

sizeEstimate integer

Estimated size in bytes of the message

snippet string

A short part of the message text

subject string

The message subject

threadId string

The ID of the thread the message belongs to

to array

SubType string

The recipient email addresses

Condition to have at least one condition validated.

conditions *DateTimeBetween DayWeek DayWeekInMonth ExecutionFlow ExecutionLabels ExecutionNamespace ExecutionOutputs ExecutionStatus Expression FlowCondition FlowNamespaceCondition HasRetryAttempt MultipleCondition Not Or PublicHoliday TimeBetween Weekend

Min items 1

The list of conditions to validate.

If any condition is true, it will allow the event's execution.

type *object

Condition for an execution namespace.

namespace *string

String against which to match the execution namespace depending on the provided comparison.

type *object

comparison string

Possible Values

EQUALSPREFIXSUFFIX

Comparison to use when checking if namespace matches. If not provided, it will use EQUALS by default.

prefix booleanstring

Default false

Whether to look at the flow namespace by prefix. Shortcut for comparison: PREFIX.

Only used when comparison is not set

Run a flow if the list of preconditions is met in a time window.

conditions *object

SubType

The list of preconditions to wait for

The key must be unique for a trigger because it will be used to store the previous evaluation result.

id *string

Validation RegExp ^[a-zA-Z0-9][a-zA-Z0-9_-]*

Min length 1

A unique id for the condition

type *object

resetOnSuccess boolean

Default true

Whether to reset the evaluation results of SLA conditions after a first successful evaluation within the given time period.

By default, after a successful evaluation of the set of SLA conditions, the evaluation result is reset, so, the same set of conditions needs to be successfully evaluated again in the same time period to trigger a new execution. This means that to create multiple executions, the same set of conditions needs to be evaluated to true multiple times. You can disable this by setting this property to false so that, within the same period, each time one of the conditions is satisfied again after a successful evaluation, it will trigger a new execution.

timeWindow TimeWindow

Default

{
  "type": "DURATION_WINDOW"
}

Define the time period (or window) for evaluating preconditions.

You can set the type of sla to one of the following values:

DURATION_WINDOW: this is the default type. It uses a start time (windowAdvance) and end time (window) that are moving forward to the next interval whenever the evaluation time reaches the end time, based on the defined duration window. For example, with a 1-day window (the default option: window: PT1D), the SLA conditions are always evaluated during 24h starting at midnight (i.e. at time 00: 00: 00) each day. If you set windowAdvance: PT6H, the window will start at 6 AM each day. If you set windowAdvance: PT6H and you also override the window property to PT6H, the window will start at 6 AM and last for 6 hours — as a result, Kestra will check the SLA conditions during the following time periods: 06: 00 to 12: 00, 12: 00 to 18: 00, 18: 00 to 00: 00, and 00: 00 to 06: 00, and so on.
SLIDING_WINDOW: this option also evaluates SLA conditions over a fixed time window, but it always goes backward from the current time. For example, a sliding window of 1 hour (window: PT1H) will evaluate executions for the past hour (so between now and one hour before now). It uses a default window of 1 day.
DAILY_TIME_DEADLINE: this option declares that some SLA conditions should be met "before a specific time in a day". With the string property deadline, you can configure a daily cutoff for checking conditions. For example, deadline: "09: 00: 00" means that the defined SLA conditions should be met from midnight until 9 AM each day; otherwise, the flow will not be triggered.
DAILY_TIME_WINDOW: this option declares that some SLA conditions should be met "within a given time range in a day". For example, a window from startTime: "06: 00: 00" to endTime: "09: 00: 00" evaluates executions within that interval each day. This option is particularly useful for declarative definition of freshness conditions when building data pipelines. For example, if you only need one successful execution within a given time range to guarantee that some data has been successfully refreshed in order for you to proceed with the next steps of your pipeline, this option can be more useful than a strict DAG-based approach. Usually, each failure in your flow would block the entire pipeline, whereas with this option, you can proceed with the next steps of the pipeline as soon as the data is successfully refreshed at least once within the given time range.

Condition to exclude other conditions.

Min items 1

The list of conditions to exclude.

If any condition is true, it will prevent the event's execution.

type *object

Condition to execute tasks on a specific day of the week relative to the current month (first, last, ...)

dayInMonth *string

Possible Values

FIRSTLASTSECONDTHIRDFOURTH

Are you looking for the first or the last day in the month?

dayOfWeek *string

Possible Values

MONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAYSUNDAY

The day of week.

type *object

date string

Default {{ trigger.date }}

The date to test.

Can be any variable or any valid ISO 8601 datetime. By default, it will use the trigger date.

Condition based on variable expression.

expression *string

type *object

Condition to allow events on a particular day of the week.

dayOfWeek *string

Possible Values

MONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAYSUNDAY

The day of week.

type *object

date string

Default {{ trigger.date }}

The date to test.

Can be any variable or any valid ISO 8601 datetime. By default, it will use the trigger date.

Condition based on execution status.

type *object

in array

SubType string

Possible Values

CREATEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINT

List of states that are authorized.

notIn array

SubType string

Possible Values

CREATEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINT

List of states that aren't authorized.

Condition to allow events between two specific datetime values.

type *object

after string

Format date-time

The date to test must be after this one.

Must be a valid ISO 8601 datetime with the zone identifier (use 'Z' for the default zone identifier).

before string

Format date-time

The date to test must be before this one.

Must be a valid ISO 8601 datetime with the zone identifier (use 'Z' for the default zone identifier).

date string

Default {{ trigger.date }}

The date to test.

Can be any variable or any valid ISO 8601 datetime. By default, it will use the trigger date.

Condition that matches if any taskRun has retry attempts.

type *object

in array

SubType string

Possible Values

CREATEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINT

List of states that are authorized.

notIn array

SubType string

Possible Values

CREATEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINT

List of states that aren't authorized.

Condition to allow events on public holidays.

type *object

country string

ISO 3166-1 alpha-2 country code. If not set, it uses the country code from the default locale.

It uses the Jollyday library for public holiday calendar that supports more than 70 countries.

date string

Default {{ trigger.date }}

The date to test.

Can be any variable or any valid ISO 8601 datetime. By default, it will use the trigger date.

subDivision string

ISO 3166-2 country subdivision (e.g., provinces and states) code.

It uses the Jollyday library for public holiday calendar that supports more than 70 countries.

​Mail​Received​Trigger

MailReceivedTrigger