email

Send email when an output is received. Alternatively, you may include or exclude the email output execution using conditionals.

Synopsys

email {
    # The fully-qualified email address to send the email to.
    # 
    # This field also accepts a comma-separated string of addresses, for example: `"me@host.com, you@host.com"`
    # 
    # You can also use dynamic fields from the event with the %{fieldname} syntax
    to => "me@host.com, you@host.com"

}

Available settings

Setting Type Info Default value
address string "localhost"
port int 25
username string ""
password string ""
from string "bitfan@nowhere.com"
replyto string ""
to string required ""
cc string ""
bcc string ""
subject string ""
subjectfile string ""
htmlbody location ""
body location ""
attachments array []
attachments_with_event hash {}
images array []
embed_b64_images bool false

Details

address

  • Value type is string
  • Default value is "localhost"
  • The address used to connect to the mail server

    port

  • Value type is int
  • Default value is 25
  • Port used to communicate with the mail server

    username

  • Value type is string
  • Default value is ""
  • Username to authenticate with the server

    password

  • Value type is string
  • Default value is ""
  • Password to authenticate with the server

    from

  • Value type is string
  • Default value is "bitfan@nowhere.com"
  • The fully-qualified email address for the From: field in the email

    replyto

  • Value type is string
  • Default value is ""
  • The fully qualified email address for the Reply-To: field

    to

  • This is a required setting
  • Value type is string
  • Default value is ""
  • The fully-qualified email address to send the email to.

    This field also accepts a comma-separated string of addresses, for example: "me@host.com, you@host.com"

    You can also use dynamic fields from the event with the %{fieldname} syntax

    cc

  • Value type is string
  • Default value is ""
  • The fully-qualified email address(es) to include as cc: address(es).

    This field also accepts a comma-separated string of addresses, for example: "me@host.com, you@host.com"

    bcc

  • Value type is string
  • Default value is ""
  • The fully-qualified email address(es) to include as bcc: address(es).

    This field also accepts a comma-separated string of addresses, for example: "me@host.com, you@host.com"

    subject

  • Value type is string
  • Default value is ""
  • Subject: for the email

    You can use template

    subjectfile

  • Value type is string
  • Default value is ""
  • Path to Subject template file for the email

    htmlbody

  • Value type is location
  • Default value is ""
  • HTML Body for the email, which may contain HTML markup

    body

  • Value type is location
  • Default value is ""
  • Body for the email - plain text only.

    attachments

  • Value type is array
  • Default value is []
  • Attachments - specify the name(s) and location(s) of the files

    attachments_with_event

  • Value type is hash
  • Default value is {}
  • Use event field’s values as attachment content each pair is : event field’s path => attachment’s name

    images

  • Value type is array
  • Default value is []
  • Images - specify the name(s) and location(s) of the images

    embed_b64_images

  • Value type is bool
  • Default value is false
  • Search for img:data in HTML body, and replace them to a reference to inline attachment

    Full configuration blueprint

    Expand me...