MailReceivedTrigger

yaml
type: "io.kestra.plugin.microsoft365.outlook.MailReceivedTrigger"

Examples

yaml
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"

yaml
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

yaml
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*string

clientSecret*string

tenantId*string

userEmail*string

allowConcurrentboolean

Defaultfalse

conditions

Definitions

Condition to allow events between two specific datetime values.

type*object

afterstring

Formatdate-time

beforestring

Formatdate-time

datestring

Default{{ trigger.date }}

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

dayOfWeek*string

Possible Values

MONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAYSUNDAY

type*object

datestring

Default{{ trigger.date }}

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

dayInMonth*string

Possible Values

FIRSTLASTSECONDTHIRDFOURTH

dayOfWeek*string

Possible Values

MONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAYSUNDAY

type*object

datestring

Default{{ trigger.date }}

Condition for a specific flow of an execution.

flowId*string

namespace*string

type*object

Condition that checks labels of an execution.

labels*arrayobject

type*object

Condition for an execution namespace.

namespace*string

type*object

comparisonstring

Possible Values

EQUALSPREFIXSUFFIX

prefixbooleanstring

Defaultfalse

Condition based on the outputs of an upstream execution.

expression*booleanstring

type*object

Condition based on execution status.

type*object

inarray

SubTypestring

Possible Values

CREATEDSUBMITTEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTRESUBMITTED

notInarray

SubTypestring

Possible Values

CREATEDSUBMITTEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTRESUBMITTED

Condition based on variable expression.

expression*string

type*object

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

flowId*string

namespace*string

type*object

Condition for a flow namespace.

namespace*string

type*object

prefixboolean

Defaultfalse

Condition that matches if any taskRun has retry attempts.

type*object

inarray

SubTypestring

Possible Values

CREATEDSUBMITTEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTRESUBMITTED

notInarray

SubTypestring

Possible Values

CREATEDSUBMITTEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTRESUBMITTED

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

conditions*object

id*string

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

Min length1

type*object

resetOnSuccessboolean

Defaulttrue

timeWindow

Default

{
  "type": "DURATION_WINDOW"
}

io.kestra.core.models.triggers.TimeWindow

deadlinestring

Formatpartial-time

endTimestring

Formatpartial-time

startTimestring

Formatpartial-time

typestring

DefaultDURATION_WINDOW

Possible Values

DAILY_TIME_DEADLINEDAILY_TIME_WINDOWDURATION_WINDOWSLIDING_WINDOW

windowstring

Formatduration

windowAdvancestring

Formatduration

windowstring

Formatduration

windowAdvancestring

Formatduration

Condition to exclude other conditions.

conditions*

Min items1

type*object

Condition to have at least one condition validated.

conditions*

Min items1

type*object

Condition to allow events on public holidays.

type*object

countrystring

datestring

Default{{ trigger.date}}

subDivisionstring

Condition to allow events between two specific times.

type*object

afterstring

Formattime

beforestring

Formattime

datestring

Default{{ trigger.date }}

Condition to allow events on weekend.

type*object

datestring

Default{{ trigger.date }}

filterstring

folderIdstring

Defaultinbox

includeAttachmentsbooleanstring

Defaultfalse

intervalstring

DefaultPT5M

Formatduration

maxMessagesintegerstring

Default10

scopesstring

Defaulthttps://graph.microsoft.com/.default

stateKeystring

stateTtlstring

Formatduration

stopAfterarray

SubTypestring

Possible Values

CREATEDSUBMITTEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTRESUBMITTED

userPrincipalNamestring

Outputs

countinteger

folderIdstring

messagesarray

Definitions

io.kestra.plugin.microsoft365.outlook.MailReceivedTrigger-EmailMessage

attachmentsarray

io.kestra.plugin.microsoft365.outlook.MailReceivedTrigger-AttachmentData

contentTypestring

idstring

isInlineboolean

namestring

sizeinteger

uristring

Formaturi

bodystring

bodyContentTypestring

bodyPreviewstring

ccRecipientsarray

SubTypestring

fromstring

fromNamestring

hasAttachmentsboolean

idstring

importancestring

isReadboolean

receivedDateTimestring

Formatdate-time

sentDateTimestring

Formatdate-time

subjectstring

toRecipientsarray

SubTypestring

Core Plugins and tasks

Tasks that provide Kestra's built-in orchestration, I/O, and observability capabilities.

CoreStorageScript

PostgreSQL

Tasks that connect to PostgreSQL via JDBC to run queries and loads.

Database

SurrealDB

Tasks that run SurrealQL queries against SurrealDB.

Database

MailReceivedTrigger

More Plugins in this Category

Core Plugins and tasks

PostgreSQL

SurrealDB

1.3.0