
Microsoft 365 MailReceivedTrigger
CertifiedTrigger on new Outlook mail
Microsoft 365 MailReceivedTrigger
Trigger on new Outlook mail
Polls a mailbox folder for new messages using Graph. Optional OData filter and attachment download to Kestra storage. Requires Microsoft Graph permission Mail.Read (application).
type: io.kestra.plugin.microsoft365.outlook.MailReceivedTriggerExamples
Wait for new emails in inbox and iterate through them
id: outlook_listen
namespace: company.team
tasks:
- id: each
type: io.kestra.plugin.core.flow.EachSequential
value: "{{ trigger.messages }}"
tasks:
- id: log
type: io.kestra.plugin.core.debug.Return
format: "New email: {{ taskrun.value.subject }}"
triggers:
- id: watch
type: io.kestra.plugin.microsoft365.outlook.MailReceivedTrigger
interval: PT5M
tenantId: "{{ secret('AZURE_TENANT_ID') }}"
clientId: "{{ secret('AZURE_CLIENT_ID') }}"
clientSecret: "{{ secret('AZURE_CLIENT_SECRET') }}"
userEmail: "user@example.com"
folderId: "inbox"
Wait for emails with attachments and process them
id: outlook_with_attachments
namespace: company.team
tasks:
- id: each
type: io.kestra.plugin.core.flow.EachSequential
value: "{{ trigger.messages }}"
tasks:
- id: process
type: io.kestra.plugin.core.debug.Return
format: "Processing {{ taskrun.value.subject }} with {{ taskrun.value.attachments | length }} attachments"
- id: each_attachment
type: io.kestra.plugin.core.flow.EachSequential
values: "{{ taskrun.value.attachments }}"
tasks:
- id: log_attachment
type: io.kestra.plugin.core.log.Log
message: "Attachment: {{ taskrun.value.name }} stored at {{ taskrun.value.uri }}"
triggers:
- id: watch
type: io.kestra.plugin.microsoft365.outlook.MailReceivedTrigger
interval: PT2M
tenantId: "{{ secret('AZURE_TENANT_ID') }}"
clientId: "{{ secret('AZURE_CLIENT_ID') }}"
clientSecret: "{{ secret('AZURE_CLIENT_SECRET') }}"
userEmail: "invoices@company.com"
folderId: "inbox"
filter: "hasAttachments eq true"
includeAttachments: true
Wait for emails from specific sender
id: outlook_filtered_sender
namespace: company.team
tasks:
- id: process
type: io.kestra.plugin.core.log.Log
message: "Received {{ trigger.count }} email(s) from important sender"
triggers:
- id: watch
type: io.kestra.plugin.microsoft365.outlook.MailReceivedTrigger
interval: PT1M
tenantId: "{{ secret('AZURE_TENANT_ID') }}"
clientId: "{{ secret('AZURE_CLIENT_ID') }}"
clientSecret: "{{ secret('AZURE_CLIENT_SECRET') }}"
userEmail: "user@example.com"
filter: "from/emailAddress/address eq 'boss@company.com'"
stateTtl: P30D
Properties
clientId *Requiredstring
Azure client ID
Application (client) ID of the Graph app registration
clientSecret *Requiredstring
Azure client secret
Client secret for the app registration; required for client-credentials flow
tenantId *Requiredstring
Azure tenant ID
Entra tenant (directory) ID used for Graph auth
allowConcurrent Non-dynamicboolean
falseSpecifies whether a trigger is allowed to start a new execution even if a previous run is still in progress.
conditions Non-dynamic
List of conditions in order to limit the flow trigger.
Allow events only between two datetimes.
Compares a rendered date (defaults to {{ trigger.date }}) against optional after and before bounds expressed as ISO-8601 datetimes with zone.
You must provide at least one bound; if both are set the date must fall strictly between them. Missing both bounds triggers an evaluation error.
Trigger condition to execute the flow only after the specific date.
id: schedule_condition_datetimebetween
namespace: company.team
tasks:
- id: log_message
type: io.kestra.plugin.core.log.Log
message: "This flow will execute once every 5 minutes after the date 2025-12-31T23:59:59Z"
triggers:
- id: schedule
type: io.kestra.plugin.core.trigger.Schedule
cron: "*/5 * * * *"
conditions:
- type: io.kestra.plugin.core.condition.DateTimeBetween
date: "{{ trigger.date }}"
after: "2025-12-31T23:59:59Z"
Trigger condition to execute the flow between two specific dates.
id: schedule_condition_datetimebetween
namespace: company.team
tasks:
- id: log_message
type: io.kestra.plugin.core.log.Log
message: "This flow will be executed once every 5 minutes between the before and after dates"
triggers:
- id: schedule
type: io.kestra.plugin.core.trigger.Schedule
cron: "*/5 * * * *"
conditions:
- type: io.kestra.plugin.core.condition.DateTimeBetween
date: "{{ trigger.date }}"
after: "2025-01-01T00:00:00Z"
before: "2025-12-31T23:59:59Z"
io.kestra.plugin.core.condition.DateTimeBetweenio.kestra.core.models.conditions.types.DateTimeBetweenConditionio.kestra.plugin.core.condition.DateTimeBetweenConditionThe 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).
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).
{{ trigger.date }}The date to test.
Can be any variable or any valid ISO 8601 datetime. By default, it will use the trigger date.
Allow events on a specific weekday.
Renders a date (defaults to the trigger timestamp) and checks its day-of-week against the provided dayOfWeek.
Accepts ISO-8601 date/time strings; the comparison uses the rendered timezone.
Trigger condition to execute the flow only on a specific day of the week.
id: schedule_condition_dayweek
namespace: company.team
tasks:
- id: log_message
type: io.kestra.plugin.core.log.Log
message: "This flow will execute only on Mondays at 11:00 am."
triggers:
- id: schedule
type: io.kestra.plugin.core.trigger.Schedule
cron: "0 11 * * *"
conditions:
- type: io.kestra.plugin.core.condition.DayWeek
dayOfWeek: "MONDAY"
MONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAYSUNDAYThe day of week.
io.kestra.plugin.core.condition.DayWeekio.kestra.core.models.conditions.types.DayWeekConditionio.kestra.plugin.core.condition.DayWeekCondition{{ trigger.date }}The date to test.
Can be any variable or any valid ISO 8601 datetime. By default, it will use the trigger date.
Allow events on an nth weekday within the month.
Renders a date (defaults to the trigger timestamp) and checks whether it matches the requested weekday and position in the month (FIRST, SECOND, THIRD, FOURTH, or LAST).
Useful for patterns like “first Monday” or “last Friday”. Dates must be valid ISO-8601 strings.
Trigger condition to execute the flow only on the first Monday of the month.
id: schedule_condition_dayweekinmonth
namespace: company.team
tasks:
- id: log_message
type: io.kestra.plugin.core.log.Log
message: "This flow will execute only on the first Monday of the month at 11:00 am."
triggers:
- id: schedule
type: io.kestra.plugin.core.trigger.Schedule
cron: "0 11 * * *"
conditions:
- type: io.kestra.plugin.core.condition.DayWeekInMonth
dayOfWeek: "MONDAY"
dayInMonth: FIRST
FIRSTLASTSECONDTHIRDFOURTHAre you looking for the first or the last day in the month?
MONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAYSUNDAYThe day of week.
io.kestra.plugin.core.condition.DayWeekInMonthio.kestra.plugin.core.condition.DayWeekInMonthConditionio.kestra.core.models.conditions.types.DayWeekInMonthCondition{{ trigger.date }}The date to test.
Can be any variable or any valid ISO 8601 datetime. By default, it will use the trigger date.
Match events from a specific flow.
Passes only when the triggering execution belongs to the given Namespace and Flow ID.
Pair with the Flow trigger to react to a single upstream flow; for broader namespace matching use ExecutionNamespace.
Trigger condition to execute the flow based on execution of another flow.
id: flow_condition_executionflow
namespace: company.team
tasks:
- id: hello
type: io.kestra.plugin.core.log.Log
message: "This flow will execute when flow `flow_a` of namespace `company.team` enters RUNNING state."
triggers:
- id: flow_trigger
type: io.kestra.plugin.core.trigger.Flow
conditions:
- type: io.kestra.plugin.core.condition.ExecutionFlow
flowId: flow_a
namespace: company.team
states:
- RUNNING
The Flow ID
The Flow Namespace
io.kestra.plugin.core.condition.ExecutionFlowio.kestra.plugin.core.condition.ExecutionFlowConditionio.kestra.core.models.conditions.types.ExecutionFlowConditionMatch executions by label set.
Evaluates true only if the execution carries all provided labels. Labels can be declared as a map or list; system-reserved labels are rejected.
Useful for filtering Flow triggers to specific environments, owners, or any custom tagging strategy.
Trigger condition to execute the flow based on execution of another flow(s) with certain execution labels.
id: flow_condition_executionlabels
namespace: company.team
tasks:
- id: hello
type: io.kestra.plugin.core.log.Log
message: "This flow will execute when flow with specified labels enters FAILED state."
triggers:
- id: flow_trigger
type: io.kestra.plugin.core.trigger.Flow
conditions:
- type: io.kestra.plugin.core.condition.ExecutionLabels
labels:
owner: john.doe
env: prod
states:
- FAILED
List of labels to match in the execution.
io.kestra.plugin.core.condition.ExecutionLabelsio.kestra.core.models.conditions.types.ExecutionLabelsConditionio.kestra.plugin.core.condition.ExecutionLabelsConditionMatch executions by namespace.
Compares the triggering execution’s namespace against a target string using EQUALS, PREFIX, or SUFFIX. The prefix boolean is a shorthand for comparison: PREFIX.
If no comparison is set, it defaults to strict equality unless prefix is true.
Trigger condition to execute the flow based on execution of another flow(s) belonging to certain namespace.
id: flow_condition_executionnamespace
namespace: company.team
tasks:
- id: hello
type: io.kestra.plugin.core.log.Log
message: "This flow will execute when any flow within `company.engineering` namespace enters RUNNING state."
triggers:
- id: flow_trigger
type: io.kestra.plugin.core.trigger.Flow
conditions:
- type: io.kestra.plugin.core.condition.ExecutionNamespace
namespace: company.engineering
comparison: PREFIX
states:
- RUNNING
String against which to match the execution namespace depending on the provided comparison.
io.kestra.plugin.core.condition.ExecutionNamespaceio.kestra.core.models.conditions.types.ExecutionNamespaceConditionio.kestra.plugin.core.condition.ExecutionNamespaceConditionEQUALSPREFIXSUFFIXComparison to use when checking if namespace matches. If not provided, it will use EQUALS by default.
falseWhether to look at the flow namespace by prefix. Shortcut for comparison: PREFIX.
Only used when comparison is not set
Condition based on the outputs of an upstream execution.
Renders the provided boolean expression against the upstream execution outputs exposed under trigger.outputs.
If the execution exposes no outputs the condition is false and the expression is skipped. A rendered result of blank, space-only, or literal false is treated as false.
The upstream flow_a must explicitly define its outputs
to be used in the ExecutionOutputs condition.
id: flow_a
namespace: company.team
inputs:
- id: user_value
type: STRING
defaults: hello
tasks:
- id: hello
type: io.kestra.plugin.core.debug.Return
format: "{{ inputs.user_value }}"
outputs:
- id: flow_a_output
type: STRING
value: "{{ outputs.hello.value }}"
The flow_condition_executionoutputs will run whenever flow_a finishes successfully
and returns an output matching the value 'hello':
id: flow_condition_executionoutputs
namespace: company.team
tasks:
- id: upstream_outputs
type: io.kestra.plugin.core.log.Log
message: hello from a downstream flow
triggers:
- id: condition_on_flow_execution_outputs
type: io.kestra.plugin.core.trigger.Flow
states:
- SUCCESS
conditions:
- type: io.kestra.plugin.core.condition.ExecutionOutputs
expression: "{{ trigger.outputs.flow_a_output == 'hello' }}"
io.kestra.plugin.core.condition.ExecutionOutputsio.kestra.core.models.conditions.types.ExecutionOutputsConditionio.kestra.plugin.core.condition.ExecutionOutputsConditionMatch executions by status.
Passes when the triggering execution’s current state is included in in and not present in notIn.
If a list is empty it is ignored, so provide at least one of them to avoid unintentionally matching everything.
Trigger condition to execute the flow based on execution status of another flow(s).
id: flow_condition_executionstatus
namespace: company.team
tasks:
- id: hello
type: io.kestra.plugin.core.log.Log
message: "This flow will execute when any flow enters FAILED or KILLED state."
triggers:
- id: flow_trigger
type: io.kestra.plugin.core.trigger.Flow
conditions:
- type: io.kestra.plugin.core.condition.ExecutionStatus
in:
- FAILED
- KILLED
io.kestra.plugin.core.condition.ExecutionStatusio.kestra.core.models.conditions.types.ExecutionStatusConditionio.kestra.plugin.core.condition.ExecutionStatusConditionCREATEDSUBMITTEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTRESUBMITTEDList of states that are authorized.
CREATEDSUBMITTEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTRESUBMITTEDList of states that aren't authorized.
Condition based on variable expression.
Renders a templated expression and treats the result as truthy/falsey to decide whether the condition passes.
Blank strings or the literal false (case-sensitive) evaluate to false; everything else is true. Expressions can reference any flow variables available at evaluation time, so make sure they resolve without errors.
Trigger condition to execute the flow when the expression evaluates to true.
id: myflow
namespace: company.team
tasks:
- id: hello
type: io.kestra.plugin.core.log.Log
message: Average value has gone below 10
triggers:
- id: expression_trigger
type: io.kestra.plugin.core.trigger.Schedule
cron: "*/1 * * * *"
conditions:
- type: io.kestra.plugin.core.condition.Expression
expression: "{{ kv('average_value') < 10 }}"
io.kestra.plugin.core.condition.Expressionio.kestra.plugin.core.condition.ExpressionConditionio.kestra.core.models.conditions.types.VariableConditionMatch executions where a task was retried.
Passes if any task run has more than one attempt and its state satisfies in / notIn filters.
Provide in states to avoid matching nothing (an empty in list fails all attempts). Use with Flow triggers to react when retries occur.
Trigger condition when any flow task on retry enters the state specified in the in states under the HasRetryAttempt condition.
id: flow_condition_hasretryattempt
namespace: company.team
tasks:
- id: log_message
type: io.kestra.plugin.core.log.Log
message: "This flow will execute when any flow task on retry enters a specific state(s)."
triggers:
- id: flow_condition
type: io.kestra.plugin.core.trigger.Flow
conditions:
- type: io.kestra.plugin.core.condition.HasRetryAttempt
in:
- FAILED
io.kestra.plugin.core.condition.HasRetryAttemptio.kestra.plugin.core.condition.HasRetryAttemptConditionio.kestra.core.models.conditions.types.HasRetryAttemptConditionCREATEDSUBMITTEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTRESUBMITTEDList of states that are authorized.
CREATEDSUBMITTEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTRESUBMITTEDList of states that aren't authorized.
Invert one or more conditions.
Fails the evaluation if any nested condition is true; otherwise passes.
Combine with other schedule conditions to express “not these dates/states” patterns.
Trigger condition to execute the flow when the condition is not satisfied.
id: schedule_condition_not
namespace: company.team
tasks:
- id: log_message
type: io.kestra.plugin.core.log.Log
message: "This flow will execute on all days except Sunday at 11am."
triggers:
- id: schedule
type: io.kestra.plugin.core.trigger.Schedule
cron: "0 11 * * *"
conditions:
- type: io.kestra.plugin.core.condition.Not
conditions:
- type: io.kestra.plugin.core.condition.DayWeek
dayOfWeek: "SUNDAY"
1The list of conditions to exclude.
If any condition is true, it will prevent the event's execution.
io.kestra.plugin.core.condition.Notio.kestra.core.models.conditions.types.NotConditionio.kestra.plugin.core.condition.NotConditionPass when any condition is true.
Evaluates nested conditions and succeeds if at least one passes.
Useful for schedule scenarios like “weekends or holidays” without duplicating triggers.
Trigger condition to execute the flow when any of the conditions are satisfied.
id: schedule_condition_or
namespace: company.team
tasks:
- id: log_message
type: io.kestra.plugin.core.log.Log
message: "This flow will execute on Sundays and Mondays at 11am."
triggers:
- id: schedule
type: io.kestra.plugin.core.trigger.Schedule
cron: "0 11 * * *"
conditions:
- type: io.kestra.plugin.core.condition.Or
conditions:
- type: io.kestra.plugin.core.condition.DayWeek
dayOfWeek: "MONDAY"
- type: io.kestra.plugin.core.condition.DayWeek
dayOfWeek: "SUNDAY"
1The list of conditions to validate.
If any condition is true, it will allow the event's execution.
io.kestra.plugin.core.condition.Orio.kestra.core.models.conditions.types.OrConditionio.kestra.plugin.core.condition.OrConditionAllow events on public holidays.
Uses the Jollyday calendar to check whether a rendered date (defaults to {{ trigger.date }}) is a public holiday for the given country/sub-division.
If country is omitted, the default locale is used. Provide ISO 3166-1 (country) and optionally 3166-2 (region) codes.
Trigger condition to execute the flow only on public holidays.
id: schedule_condition_public-holiday
namespace: company.team
tasks:
- id: log_message
type: io.kestra.plugin.core.log.Log
message: "This flow will execute only on the public holidays of France at 11:00 am."
triggers:
- id: schedule
type: io.kestra.plugin.core.trigger.Schedule
cron: "0 11 * * *"
conditions:
- type: io.kestra.plugin.core.condition.PublicHoliday
country: FR
Trigger condition to execute the flow only on work days in France.
id: schedule-condition-work-days
namespace: company.team
tasks:
- id: log_message
type: io.kestra.plugin.core.log.Log
message: "This flow will execute only on the work days of France at 11:00 am."
triggers:
- id: schedule
type: io.kestra.plugin.core.trigger.Schedule
cron: "0 11 * * *"
conditions:
- type: io.kestra.plugin.core.condition.Not
conditions:
- type: io.kestra.plugin.core.condition.PublicHoliday
country: FR
- type: io.kestra.plugin.core.condition.Weekend
io.kestra.plugin.core.condition.PublicHolidayio.kestra.plugin.core.condition.PublicHolidayConditionio.kestra.core.models.conditions.types.PublicHolidayConditionISO 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.
{{ trigger.date}}The date to test.
Can be any variable or any valid ISO 8601 datetime. By default, it will use the trigger date.
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.
Allow events between two times of day.
Compares the rendered date/time (defaults to the trigger timestamp) against optional after and before offsets (ISO-8601 times).
Supports ranges that cross midnight (e.g., 22: 00→02: 00). At least one bound is required; missing both raises an evaluation error.
Trigger condition to execute the flow between two specific times.
id: schedule_condition_timebetween
namespace: company.team
tasks:
- id: log_message
type: io.kestra.plugin.core.log.Log
message: "This flow will execute every 5 minutes between 4pm and 8pm."
triggers:
- id: schedule
type: io.kestra.plugin.core.trigger.Schedule
cron: "*/5 * * * *"
conditions:
- type: io.kestra.plugin.core.condition.TimeBetween
after: "16:00:00+02:00"
before: "20:00:00+02:00"
io.kestra.plugin.core.condition.TimeBetweenio.kestra.plugin.core.condition.TimeBetweenConditionio.kestra.core.models.conditions.types.TimeBetweenConditionThe time to test must be after this one.
Must be a valid ISO 8601 time with offset.
The time to test must be before this one.
Must be a valid ISO 8601 time with offset.
{{ trigger.date }}The time to test.
Can be any variable or any valid ISO 8601 time. By default, it will use the trigger date.
Allow events on weekends.
Renders a date (defaults to the trigger timestamp) and passes only if it falls on Saturday or Sunday.
Accepts ISO-8601 date/time strings; uses the rendered timezone to determine the day.
Trigger the flow only on weekend, i.e. on Saturdays and Sundays.
id: schedule_condition_weekend
namespace: company.team
tasks:
- id: log_message
type: io.kestra.plugin.core.log.Log
message: "This flow will execute only on weekends at 11:00 am."
triggers:
- id: schedule
type: io.kestra.plugin.core.trigger.Schedule
cron: "0 11 * * *"
conditions:
- type: io.kestra.plugin.core.condition.Weekend
io.kestra.plugin.core.condition.Weekendio.kestra.plugin.core.condition.WeekendConditionio.kestra.core.models.conditions.types.WeekendCondition{{ trigger.date }}The date to test.
Can be any variable or any valid ISO 8601 datetime. By default, it will use the trigger date.
filter string
OData filter
Graph OData filter, e.g., from/emailAddress/address eq sender@example.com or hasAttachments eq true
folderId string
inboxFolder ID or name
Mailbox folder to monitor (e.g., inbox, drafts, sentitems, deleteditems, or folder ID)
includeAttachments booleanstring
falseInclude attachments
If true, downloads file attachments to Kestra internal storage
interval Non-dynamicstring
PT5MdurationPolling interval
ISO-8601 duration between polls; default PT5M
maxMessages integerstring
10Max messages per poll
Maximum messages processed each poll
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this trigger.
scopes string
https://graph.microsoft.com/.defaultScopes
Space-separated Graph scopes; default uses .default application permissions
stateKey string
State key
Custom key for persisted state; defaults to trigger ID
stateTtl string
State TTL
TTL for state entries (e.g., PT24H, P30D); after expiry messages may retrigger
stopAfter Non-dynamicarray
CREATEDSUBMITTEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTRESUBMITTEDList of execution states after which a trigger should be stopped (a.k.a. disabled).
userEmail string
User email
Mailbox to monitor; if not specified, uses the authenticated user's mailbox.
userPrincipalName string
User principal name
Mailbox UPN/email to act on; defaults to app context when omitted
Outputs
count integer
Number of new messages
folderId string
The folder that was monitored
messages array
List of new messages that triggered the flow
io.kestra.plugin.microsoft365.outlook.MailReceivedTrigger-EmailMessage
List of attachments with URIs to stored files in Kestra
io.kestra.plugin.microsoft365.outlook.MailReceivedTrigger-AttachmentData
Content type
Attachment ID
Whether the attachment is inline
Attachment name
Size in bytes
uriURI to the downloaded attachment in Kestra's internal storage
Full message body content
Body content type (Text or HTML)
Preview of the message body
CC recipients
Sender email address
Sender name
Whether the message has attachments
Message ID
Message importance (Low, Normal, High)
Whether the message has been read
date-timeDate and time the message was received
date-timeDate and time the message was sent
Email subject
To recipients