Skip to content

Latest commit

 

History

History
63 lines (46 loc) · 4.44 KB

README.md

File metadata and controls

63 lines (46 loc) · 4.44 KB

Seq.App.EmailPlus Build status NuGet tag

Send log events and alerts as HTML email messages when they arrive at Seq.

Important

This app has been superseded by Seq.App.Mail.Smtp, which supports both plain text and HTML email templating with an improved syntax and modern SMTP defaults.

HTML email app icon

HTML email templates

The app uses Handlebars.Net for email templating. Check out the Handlebars Guide for information on the Handlebars syntax.

Event types and properties

All templates can access the following special properties:

  • $DateTimeFormat — the date/time format string defined in the app's settings
  • $EventType — the numeric event type assigned to the event
  • $EventUri — a link to the event in the Seq UI (not valid for alerts)
  • $Exception — the exception associated with the event, if any
  • $Id — the Seq event id
  • $Instance — the Seq server's instance name, if any
  • $Level — the event's level as a string
  • $LocalTimestamp — the timestamp of the event, in the server's time zone (deprecated)
  • $Message — the event's fully-rendered message
  • $MessageTemplate — the event's message template
  • $Properties — a dictionary containing all first-class event properties (see below)
  • $ServerUri — the Seq server's base URL
  • $TimeZoneName — the time zone name defined in the app's settings
  • $UtcTimestamp — the timestamp of the event

The event's first-class properties do not use prefixed $ names, so if an event carries a RequestId property, this is accessed in the template as {{RequestId}}, not {{$RequestId}}.

Notifications for Alerts can use the properties listed in the Seq documentation.

Built-in helper functions

The app makes the following helper functions available in templates.

Name Description Example usage
datetime Format a date time, optionally specifying a time zone {{datetime $SliceStart 'o' 'Australia/Brisbane'}}
if_eq Compare two values for equality and optionally execute a specified block {{#if_eq $Level 'Error'}} Oops! {{/if_eq}}
pretty Pretty-print a value, converting arrays and objects to JSON {{pretty Results}}
substring Compute a substring given start index and optional length {{substring Uri 0 5}}

Helpers are defined here.

Other Seq apps

This repository originally included the following apps from Datalust, each now in their own dedicated repositories: