MailReceivedTrigger

MailReceivedTrigger

Trigger on new email messages.

yaml
type: "io.kestra.plugin.email.MailReceivedTrigger"

Examples

yaml
id: email_monitor
namespace: company.team

tasks:
  - id: process_email
    type: io.kestra.core.tasks.log.Log
    message: |
      New email received:
      Subject: {{ trigger.latestEmail.subject }}
      From: {{ trigger.latestEmail.from }}
      Date: {{ trigger.latestEmail.date }}

triggers:
  - id: gmail_inbox_trigger
    type: io.kestra.plugin.email.MailReceivedTrigger
    protocol: IMAP
    host: imap.gmail.com
    port: 993
    username: "{{ secret('GMAIL_USERNAME') }}"
    password: "{{ secret('GMAIL_PASSWORD') }}"
    folder: INBOX
    interval: PT30S
    ssl: true

Properties

host *string

password *string

username *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 }}

folder string

DefaultINBOX

interval string

DefaultPT1M

port integerstring

protocol string

DefaultIMAP

Possible Values

IMAPPOP3

ssl booleanstring

Defaulttrue

stopAfter array

SubTypestring

Possible Values

CREATEDSUBMITTEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTRESUBMITTED

trustAllCertificates booleanstring

Defaultfalse

Outputs

emails array

Definitions

io.kestra.plugin.email.MailService-EmailData

attachmentsarray

io.kestra.plugin.email.MailService-AttachmentInfo

contentTypestring

filenamestring

sizeinteger

bccarray

SubTypestring

bodystring

ccarray

SubTypestring

datestring

Formatdate-time

fromstring

messageIdstring

subjectstring

toarray

SubTypestring

latestEmail

Definitions

io.kestra.plugin.email.MailService-EmailData

attachmentsarray

io.kestra.plugin.email.MailService-AttachmentInfo

contentTypestring

filenamestring

sizeinteger

bccarray

SubTypestring

bodystring

ccarray

SubTypestring

datestring

Formatdate-time

fromstring

messageIdstring

subjectstring

toarray

SubTypestring

total integer

Atlassian Opsgenie

Tasks that create alerts in Opsgenie.

Business

Discord

Tasks that send notifications to Discord via webhooks.

Business

Klaviyo

Tasks that interact with Klaviyo campaign APIs.

AIBusiness

MailReceivedTrigger

Trigger on new email messages.

More Plugins in this Category

Atlassian Opsgenie

Discord

Klaviyo

1.1.0

MailReceivedTrigger Trigger on new email messages.

More Plugins in this Category

Atlassian Opsgenie

Discord

Klaviyo

1.1.0

MailReceivedTrigger

Trigger on new email messages.