📚 event-engine-email-plugin

Domain Ontology Reference

Auto-generated documentation from YAML ontology definition files.


Table of Contents


<a name="email"></a>

email

The email domain defines transport-specific email events and payload schemas (headers, addressing, body, attachments, flags).

<a name="emailreceived100"></a>

email.received@1.0.0

Emitted when an inbound email is received or synchronized from an IMAP server.

Properties

PropertyTypeRequiredDescription
messageIdstringNoRFC 822 Message-ID header.
fromstringYes-
toanyNo-
ccanyNo-
bccanyNo-
subjectstringNo-
datenumberNo-
inReplyTostringNo-
referencesarrayNo-
textstringNo-
htmlstringNo-
attachmentsarrayNo-
headersobjectNo-
folderstringNo-
uidnumberNo-
flagsarrayNo-

<a name="emailsent100"></a>

email.sent@1.0.0

Emitted when an outbound email is dispatched via SMTP.

Properties

PropertyTypeRequiredDescription
messageIdstringNo-
fromstringYes-
toanyNo-
ccanyNo-
bccanyNo-
subjectstringNo-
textstringNo-
htmlstringNo-
inReplyTostringNo-
referencesarrayNo-
attachmentsarrayNo-

<a name="emailsyncrequested100"></a>

email.sync.requested@1.0.0

Emitted to trigger an on-demand IMAP synchronization pass for a specified folder.

Properties

PropertyTypeRequiredDescription
folderstringNo-
sinceUidnumberNo-
limitnumberNo-