MailReceivedTrigger

MailReceivedTrigger

Trigger on new Outlook mail

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

allowConcurrent boolean

Defaultfalse

conditions

Definitions

Condition to allow events between two specific datetime values.

type*object

Possible Values

io.kestra.plugin.core.condition.DateTimeBetweenio.kestra.core.models.conditions.types.DateTimeBetweenConditionio.kestra.plugin.core.condition.DateTimeBetweenCondition

afterstring

beforestring

datestring

Default{{ trigger.date }}

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

dayOfWeek*string

Possible Values

MONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAYSUNDAY

type*object

Possible Values

io.kestra.plugin.core.condition.DayWeekio.kestra.core.models.conditions.types.DayWeekConditionio.kestra.plugin.core.condition.DayWeekCondition

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

Possible Values

io.kestra.plugin.core.condition.DayWeekInMonthio.kestra.plugin.core.condition.DayWeekInMonthConditionio.kestra.core.models.conditions.types.DayWeekInMonthCondition

datestring

Default{{ trigger.date }}

Condition for a specific flow of an execution.

flowId*string

namespace*string

type*object

Possible Values

io.kestra.plugin.core.condition.ExecutionFlowio.kestra.plugin.core.condition.ExecutionFlowConditionio.kestra.core.models.conditions.types.ExecutionFlowCondition

Condition that checks labels of an execution.

labels*arrayobject

type*object

Possible Values

io.kestra.plugin.core.condition.ExecutionLabelsio.kestra.core.models.conditions.types.ExecutionLabelsConditionio.kestra.plugin.core.condition.ExecutionLabelsCondition

Condition for an execution namespace.

namespace*string

type*object

Possible Values

io.kestra.plugin.core.condition.ExecutionNamespaceio.kestra.core.models.conditions.types.ExecutionNamespaceConditionio.kestra.plugin.core.condition.ExecutionNamespaceCondition

comparisonstring

Possible Values

EQUALSPREFIXSUFFIX

prefixbooleanstring

Defaultfalse

Condition based on the outputs of an upstream execution.

expression*booleanstring

type*object

Possible Values

io.kestra.plugin.core.condition.ExecutionOutputsio.kestra.core.models.conditions.types.ExecutionOutputsConditionio.kestra.plugin.core.condition.ExecutionOutputsCondition

Condition based on execution status.

type*object

Possible Values

io.kestra.plugin.core.condition.ExecutionStatusio.kestra.core.models.conditions.types.ExecutionStatusConditionio.kestra.plugin.core.condition.ExecutionStatusCondition

inarray

SubTypestring

Possible Values

CREATEDSUBMITTEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTRESUBMITTED

notInarray

SubTypestring

Possible Values

CREATEDSUBMITTEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTRESUBMITTED

Condition based on variable expression.

expression*string

type*object

Possible Values

io.kestra.plugin.core.condition.Expressionio.kestra.plugin.core.condition.ExpressionConditionio.kestra.core.models.conditions.types.VariableCondition

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

Possible Values

io.kestra.plugin.core.condition.FlowConditionio.kestra.core.models.conditions.types.FlowCondition

Condition for a flow namespace.

namespace*string

type*object

Possible Values

io.kestra.plugin.core.condition.FlowNamespaceConditionio.kestra.core.models.conditions.types.FlowNamespaceCondition

prefixboolean

Defaultfalse

Condition that matches if any taskRun has retry attempts.

type*object

Possible Values

io.kestra.plugin.core.condition.HasRetryAttemptio.kestra.plugin.core.condition.HasRetryAttemptConditionio.kestra.core.models.conditions.types.HasRetryAttemptCondition

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

Possible Values

io.kestra.plugin.core.condition.MultipleConditionio.kestra.core.models.conditions.types.MultipleCondition

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

Possible Values

io.kestra.plugin.core.condition.Notio.kestra.core.models.conditions.types.NotConditionio.kestra.plugin.core.condition.NotCondition

Condition to have at least one condition validated.

conditions*

Min items1

type*object

Possible Values

io.kestra.plugin.core.condition.Orio.kestra.core.models.conditions.types.OrConditionio.kestra.plugin.core.condition.OrCondition

Condition to allow events on public holidays.

type*object

Possible Values

io.kestra.plugin.core.condition.PublicHolidayio.kestra.plugin.core.condition.PublicHolidayConditionio.kestra.core.models.conditions.types.PublicHolidayCondition

countrystring

datestring

Default{{ trigger.date}}

subDivisionstring

Condition to allow events between two specific times.

type*object

Possible Values

io.kestra.plugin.core.condition.TimeBetweenio.kestra.plugin.core.condition.TimeBetweenConditionio.kestra.core.models.conditions.types.TimeBetweenCondition

afterstring

beforestring

datestring

Default{{ trigger.date }}

Condition to allow events on weekend.

type*object

Possible Values

io.kestra.plugin.core.condition.Weekendio.kestra.plugin.core.condition.WeekendConditionio.kestra.core.models.conditions.types.WeekendCondition

datestring

Default{{ trigger.date }}

filter string

folderId string

Defaultinbox

includeAttachments booleanstring

Defaultfalse

interval string

DefaultPT5M

Formatduration

maxMessages integerstring

Default10

scopes string

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

stateKey string

stateTtl string

stopAfter array

SubTypestring

Possible Values

CREATEDSUBMITTEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTRESUBMITTED

userEmail string

userPrincipalName string

Outputs

count integer

folderId string

messages array

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

ServiceNow

Tasks that create, update, read, and delete ServiceNow records via REST.

DataBusiness

Atlassian Opsgenie

Tasks that create alerts in Opsgenie.

Business

Slack

Tasks that send messages to Slack.

Business

MailReceivedTrigger

Trigger on new Outlook mail

More Plugins in this Category

ServiceNow

Atlassian Opsgenie

Slack

1.4.2

MailReceivedTrigger Trigger on new Outlook mail

More Plugins in this Category

ServiceNow

Atlassian Opsgenie

Slack

1.4.2

MailReceivedTrigger

Trigger on new Outlook mail