Overview

The node sends an Email when a trigger condition is met. It can also send a link to live stream, attach a snapshot as well as any Clips saved Locally using Save Clip Node.

Inputs & Outputs

Inputs : 1, Media Format : Raw Video
Outputs : 1, Media Format: Raw Video
Output Metadata : None

Properties

Property	Value
`trigger`	Send the Email once this trigger condition is met. The trigger expression must be a valid Dot-notation expression that operates on Pipeline Metadata and evaluates to `True` or `False`. See details here. ex. `nodes.annotate_line_counter1.lines.line1.total_objects_crossed_delta > 0`
`enabled`	If false, this node will be disabled and will not send any emails. Ex. `false`
`to_email`	Comma separated list of email addresses to send to. Ex. `[email protected]`
`subject`	Email subject. You may use template variables in this field. See below for template variables available. Ex. `Event triggered on {{ source_name }}`
`body`	Email body. You may use template variables in this field. See below for template variables available. If the body starts with `<html>` will send a HTML email, else will send a plain text email.
`include_snapshot`	Attach a snapshot from the time the trigger happened with the email.
`media_node`	Includes the most recent clip from the named Save Clip Node with the alarm. The node must be configured to store clips locally.
`enable_embedded_media`	If true, enables `livestream_node` capabilities.
`livestream_node`	Enables including the Live stream URL from the named WebRTC node with the email using `livestream_url` template variable. Ex. `stream_webrtc_out1`
`lumeo_api_key`	API Key for this Lumeo application. Required if `livestream_node` is specified.Find it here: API
`use_custom_smtp_server`	Enable to use your own/custom SMTP server. Boolean. Ex. `true` / `false`
`server`	Hostname or IP Address of the SMTP Server. Only used when `use_custom_smtp_server` is `true`.
`port`	Port of the SMTP server. Only used when `use_custom_smtp_server` is `true`.
`use_tls`	If true, a TLS socket will be used for the SMTP session. Your SMTP server must support the STARTTLS SMTP extension to use this. Only used when `use_custom_smtp_server` is `true`.
`from_email`	From email. Only used when `use_custom_smtp_server` is `true`.
`user`	SMTP Server user. Only used when `use_custom_smtp_server` is `true`.
`password`	SMTP Server password. Only used when `use_custom_smtp_server` is `true`.
`interval`	Min time (seconds) between consecutive Email notifications. Ex. `10`
`max_media_wait_time`	Maximum time to wait after a trigger until a media clip is available from the Save Clip Node. Ex. `10`

Template Syntax

The following Template variables are available to use in Email Subject and Body. The templates can be built using Jinja2 Template Syntax.

Variables available to the template:

Variable	Description
`meta`	Frame metadata. Contains keys like `nodes`, `objects`, and other custom metadata inserted by Custom function node.
`application_id`	The application ID of the deployment that produced this metadata.
`application_name`	The application name of the deployment that produced this metadata.
`deployment_id`	The deployment ID of the deployment that produced this metadata.
`deployment_name`	The deployment name of the deployment that produced this metadata.
`source_name`	The name of the source that produced this metadata.
`livestream_url`	The URL of the livestream.

Example templates

Static text content:

Text content

Reference specific metadata:

Person detected on {{ source_name }}. View live stream at {{ livestream_url }}

Metadata reinserted as is:

{{ meta | tojson }}

Metadata

Metadata Property	Description
None	None