lib/logstash/outputs/email.rb in logstash-output-email-4.0.3 vs lib/logstash/outputs/email.rb in logstash-output-email-4.0.4

@@ -1,18 +1,37 @@
+#
+# ==== Usage Example
+
+# [source,ruby]
+# ----------------------------------
+# output {
+#   if "shouldmail" in [tags] {
+#     email {
+#       to => '[e-mail]'
+#       from => '[e-mail]'
+#       subject => 'Alert - %{title}'
+#       body => "Tags: %{tags}\\n\\Content:\\n%{message}"
+#       domain => 'mail.logstash.net'
+#       port => 25
+#     }
+#   }
+# }
+# ----------------------------------
+
 # encoding: utf-8
 require "logstash/outputs/base"
 require "logstash/namespace"
 
 # Send email when an output is received. Alternatively, you may include or
-# exclude the email output execution using conditionals. 
+# exclude the email output execution using conditionals.
 class LogStash::Outputs::Email < LogStash::Outputs::Base
 
   config_name "email"
 
   # The fully-qualified email address to send the email to.
   #
-  # This field also accepts a comma-separated string of addresses, for example: 
+  # This field also accepts a comma-separated string of addresses, for example:
   # `"[e-mail], [e-mail]"`
   #
   # You can also use dynamic fields from the event with the `%{fieldname}` syntax.
   config :to, :validate => :string, :required => true
 
@@ -22,11 +41,11 @@
   # The fully qualified email address for the Reply-To: field.
   config :replyto, :validate => :string
 
   # The fully-qualified email address(es) to include as cc: address(es).
   #
-  # This field also accepts a comma-separated string of addresses, for example: 
+  # This field also accepts a comma-separated string of addresses, for example:
   # `"[e-mail], [e-mail]"`
   config :cc, :validate => :string
 
   # How Logstash should send the email, either via SMTP or by invoking sendmail.
   config :via, :validate => :string, :default => "smtp"
@@ -102,10 +121,10 @@
     @logger.debug("Email Output Registered!", :config => options, :via => @via)
   end # def register
 
   public
   def receive(event)
-    
+
 
       @logger.debug? and @logger.debug("Creating mail with these settings : ", :via => @via, :options => @options, :from => @from, :to => @to, :cc => @cc, :subject => @subject, :body => @body, :content_type => @contenttype, :htmlbody => @htmlbody, :attachments => @attachments, :to => to, :to => to)
       formatedSubject = event.sprintf(@subject)
       formattedBody = event.sprintf(@body)
       formattedHtmlBody = event.sprintf(@htmlbody)