emailedit

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

 

Synopsisedit

This plugin supports the following configuration options:

Required configuration options:

email {
    to => ...
}

Available configuration options:

SettingInput typeRequiredDefault value

attachments

array

No

[]

body

string

No

""

cc

string

No

 

codec

codec

No

"plain"

contenttype

string

No

"text/html; charset=UTF-8"

from

string

No

"logstash.alert@nowhere.com"

htmlbody

string

No

""

options

hash

No

{}

replyto

string

No

 

subject

string

No

""

to

string

Yes

 

via

string

No

"smtp"

workers

number

No

1

Detailsedit

 

attachmentsedit

  • Value type is array
  • Default value is []

Attachments - specify the name(s) and location(s) of the files.

bodyedit

  • Value type is string
  • Default value is ""

Body for the email - plain text only.

  • Value type is string
  • There is no default value for this setting.

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"

codecedit

  • Value type is codec
  • Default value is "plain"

The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline.

contenttypeedit

  • Value type is string
  • Default value is "text/html; charset=UTF-8"

contenttype : for multipart messages, set the content-type and/or charset of the HTML part. NOTE: this may not be functional (KH)

exclude_tags (DEPRECATED)edit

  • DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
  • Value type is array
  • Default value is []

Only handle events without any of these tags. Optional.

fromedit

  • Value type is string
  • Default value is "logstash.alert@nowhere.com"

The fully-qualified email address for the From: field in the email.

htmlbodyedit

  • Value type is string
  • Default value is ""

HTML Body for the email, which may contain HTML markup.

match (DEPRECATED)edit

  • DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
  • Value type is hash
  • There is no default value for this setting.

This setting is deprecated in favor of Logstash’s "conditionals" feature If you were using this setting previously, please use conditionals instead.

If you need help converting your older match setting to a conditional, I welcome you to join the #logstash irc channel on freenode or to post a message on https://discuss.elastic.co/c/logstash and ask for help! :)

optionsedit

  • Value type is hash
  • Default value is {}

Specify the options to use:

Via SMTP: smtpIporHost, port, domain, userName, password, authenticationType, starttls

Via sendmail: location, arguments

If you do not specify any options, you will get the following equivalent code set in every new mail object:

    Mail.defaults do
      delivery_method :smtp, { :smtpIporHost         => "localhost",
                               :port                 => 25,
                               :domain               => 'localhost.localdomain',
                               :userName             => nil,
                               :password             => nil,
                               :authenticationType   => nil,(plain, login and cram_md5)
                               :starttls             => true  }
retriever_method :pop3, { :address             => "localhost",
                          :port                => 995,
                          :user_name           => nil,
                          :password            => nil,
                          :enable_ssl          => true }
  Mail.delivery_method.new  #=> Mail::SMTP instance
  Mail.retriever_method.new #=> Mail::POP3 instance
end

Each mail object inherits the defaults set in Mail.delivery_method. However, on a per email basis, you can override the method:

    mail.delivery_method :sendmail

Or you can override the method and pass in settings:

    mail.delivery_method :sendmail, { :address => 'some.host' }

You can also just modify the settings:

    mail.delivery_settings = { :address => 'some.host' }

The hash you supply is just merged against the defaults with "merge!" and the result assigned to the mail object. For instance, the above example will change only the :address value of the global smtp_settings to be some.host, retaining all other values.

replytoedit

  • Value type is string
  • There is no default value for this setting.

The fully qualified email address for the Reply-To: field.

subjectedit

  • Value type is string
  • Default value is ""

Subject: for the email.

tags (DEPRECATED)edit

  • DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
  • Value type is array
  • Default value is []

Only handle events with all of these tags. Optional.

  • This is a required setting.
  • Value type is string
  • There is no default value for this setting.

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.

type (DEPRECATED)edit

  • DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
  • Value type is string
  • Default value is ""

The type to act on. If a type is given, then this output will only act on messages with the same type. See any input plugin’s type attribute for more. Optional.

viaedit

  • Value type is string
  • Default value is "smtp"

How Logstash should send the email, either via SMTP or by invoking sendmail.

workersedit

  • Value type is number
  • Default value is 1

The number of workers to use for this output. Note that this setting may not be useful for all outputs.