RealTimeTrigger

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

Examples

yaml
id: realtime_email_monitor
namespace: company.team

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

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

yaml
id: "realtimetrigger"
type: "io.kestra.plugin.email.RealTimeTrigger"
triggers:
  - id: realtime_pop3_trigger
    type: io.kestra.plugin.email.RealTimeTrigger
    protocol: POP3
    host: pop.example.com
    port: 995
    username: "{{ secret('EMAIL_USERNAME') }}"
    password: "{{ secret('EMAIL_PASSWORD') }}"
    ssl: true
    interval: PT30S

Properties

host*string

password*string

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

folderstring

DefaultINBOX

intervalstring

DefaultPT1M

Formatduration

portintegerstring

protocolstring

DefaultIMAP

Possible Values

IMAPPOP3

sslbooleanstring

Defaulttrue

stopAfterarray

SubTypestring

Possible Values

CREATEDSUBMITTEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTRESUBMITTED

trustAllCertificatesbooleanstring

Defaultfalse

Outputs

attachmentsarray

Definitions

io.kestra.plugin.email.MailService-AttachmentInfo

contentTypestring

filenamestring

sizeinteger

bccarray

SubTypestring

bodystring

ccarray

SubTypestring

datestring

Formatdate-time

fromstring

messageIdstring

subjectstring

toarray

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

RealTimeTrigger

More Plugins in this Category

Core Plugins and tasks

PostgreSQL

SurrealDB

1.0.0