fluent-plugin-mail 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f383ef142caab20f8176e6c38e7cf774ed5d1a4d
-  data.tar.gz: a5006e52c3e4a0fde6b7c713f245fdf44b5b07c9
+  metadata.gz: 481b1b97a2f2766802bcbd11bb3eb4d351e59fc6
+  data.tar.gz: 68d5a406f5cba6041b7086ced8234d40050685cf
 SHA512:
-  metadata.gz: 81aca182ab3d260cbea3f57294a648770a22278d5fa525f69be6eb4448b1df75646faea58e7b3a1c77d100042314cae6a308cd1a9b1964c48e3e0414d8578a3c
-  data.tar.gz: d412c15b6df8914e240b7491e5085b45031a5aaca8de4012d8d3833be7f442480545bfbd17b68fd81ae10e465b6a7e6d735ed9286e93b4fe3fe758d583dd629a
+  metadata.gz: d934bc3e3e385f876ef068a213738f28a752046a24922bb76f69ba684d820a138f23d7daedc2d134815586165aeaf7b3447740878f206617f31ce700d983de5e
+  data.tar.gz: fb72bf8db210ef6e3606583b5446a1a5b284c77349e9167e7f04f115ccdaa0306c8358388cae11959b2ca419404b320fa9d39702915fef81cc2e6d6213a1a9c3

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.2.4
+
+Enhancements:
+
+* Add to_key, cc_key, bcc_key options (thanks to authorNari)
+
 # 0.2.3
 
 Enhancements:

data/README.md

@@ -205,10 +205,23 @@ log server("/etc/td-agent/td-agent.conf")
     </match>
 
 
+### Dynamic identiciation of mail destination (to, cc, bcc)
 
-## TODO
+You can dynamically identify mail destination (to, cc, bcc) from event records as:
 
-* add config "mail_text_format"
+
+```
+<match mail.test>
+  type mail
+  from from@example.com
+  to_key to
+  cc_key cc
+  bcc_key bcc
+  ....
+</match>
+```
+
+With this example, `to`, `cc`, `bcc` are dynamically extracted from `record["to"]`, `record["cc"]`, `record["bcc"]` respectively.
 
 ## ChangeLog
 
@@ -228,7 +241,7 @@ It starts STMP server on localhost:1025, and has Web UI running on localhost:108
 Run Fluentd as:
 
 ```
-$ bundle exec fluentd -c example.conf
+$ bundle exec fluentd -c example/example.conf
 ```
 
 Put a message to the Fluentd as:

data/{example.conf → example/example.conf}

@@ -1,3 +1,5 @@
+# echo '{"message":"This is a test"}' | bundle exec fluent-cat mail.test
+
 <source>
   type forward
 </source>
@@ -7,9 +9,9 @@
   log_level debug
   host localhost
   port 1025
-  from foo@example.com
-  to   bar@example.com
-  bcc  baz@example.com
+  from from@example.com
+  to   to@example.com
+  bcc  bcc@example.com
   subject this is a test
   message Hello from out_mail\n[%s] %s
   message_out_keys time,message

data/example/to_cc_bcc_key.conf

@@ -0,0 +1,23 @@
+# echo '{"message":"This is a test","bcc":"bcc@example.com"}' | bundle exec fluent-cat mail.test
+
+<source>
+  type forward
+</source>
+
+<match mail.test>
+  type mail
+  log_level debug
+  host localhost
+  port 1025
+  from from@example.com
+  to   to@example.com
+  to_key to
+  bcc_key bcc
+  subject this is a test
+  message Hello from out_mail\n[%s] %s
+  message_out_keys time,message
+  time_key time
+  time_locale Asia/Taipei
+  # localtime false
+  time_format %Y-%m-%d %H:%M:%S %z
+</match>

data/fluent-plugin-mail.gemspec

@@ -6,13 +6,12 @@ Gem::Specification.new do |gem|
   gem.description   = %q{output plugin for Mail}
   gem.summary       = %q{output plugin for Mail}
   gem.homepage      = "https://github.com/u-ichi/fluent-plugin-mail"
-  gem.rubyforge_project = "fluent-plugin-mail"
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "fluent-plugin-mail"
   gem.require_paths = ["lib"]
-  gem.version       = '0.2.3'
+  gem.version       = '0.2.4'
   gem.license       = "Apache-2.0"
 
   gem.add_runtime_dependency "fluentd"

data/lib/fluent/plugin/out_mail.rb

@@ -42,8 +42,14 @@ class Fluent::MailOutput < Fluent::Output
   config_param :to,                   :string,  :default => ''
   desc "Mail destination (Cc)"
   config_param :cc,                   :string,  :default => ''
-  desc "Mail destination (BCc)"
+  desc "Mail destination (Bcc)"
   config_param :bcc,                  :string,  :default => ''
+  desc "Dyanmically identify mail destination (To) from records"
+  config_param :to_key,               :string,  :default => nil
+  desc "Dynamically identify mail destination (Cc) from records"
+  config_param :cc_key,               :string,  :default => nil
+  desc "Dynamically identify mail destination (Bcc) from records"
+  config_param :bcc_key,              :string,  :default => nil
   desc "Format string to construct mail subject"
   config_param :subject,              :string,  :default => 'Fluent::MailOutput plugin'
   desc "Specify comma delimited keys output to `subject`"
@@ -90,6 +96,35 @@ class Fluent::MailOutput < Fluent::Output
       @create_message_proc = Proc.new {|tag, time, record| create_key_value_message(tag, time, record) }
     end
 
+    if @to_key or @cc_key or @bcc_key
+      @process_event_stream_proc = Proc.new {|tag, es|
+        messages = []
+        subjects = []
+        dests = []
+
+        es.each do |time, record|
+          messages << @create_message_proc.call(tag, time, record)
+          subjects << create_formatted_subject(tag, time, record)
+          dests << %w(to cc bcc).each_with_object({}){|t, dest| dest[t] = create_dest_addr(t, record) }
+        end
+
+        [messages, subjects, dests]
+      }
+    else
+      @process_event_stream_proc = Proc.new {|tag, es|
+        messages = []
+        subjects = []
+        dests = []
+
+        es.each do |time, record|
+          messages << @create_message_proc.call(tag, time, record)
+          subjects << create_formatted_subject(tag, time, record)
+        end
+
+        [messages, subjects, dests]
+      }
+    end
+
     begin
       @subject % (['1'] * @subject_out_keys.length)
     rescue ArgumentError
@@ -104,19 +139,13 @@ class Fluent::MailOutput < Fluent::Output
   end
 
   def emit(tag, es, chain)
-    messages = []
-    subjects = []
+    messages, subjects, dests = @process_event_stream_proc.call(tag, es)
 
-    es.each {|time,record|
-      messages << @create_message_proc.call(tag, time, record)
-      subjects << create_formatted_subject(tag, time, record)
-    }
-
-    (0...messages.size).each do |i|
-      message = messages[i]
+    messages.each_with_index do |message, i|
       subject = subjects[i]
+      dest = dests[i]
       begin
-        sendmail(subject, message)
+        sendmail(subject, message, dest)
       rescue => e
         log.warn "out_mail: failed to send notice to #{@host}:#{@port}, subject: #{subject}, message: #{message}, " <<
           "error_class: #{e.class}, error_message: #{e.message}, error_backtrace: #{e.backtrace.first}"
@@ -179,7 +208,7 @@ class Fluent::MailOutput < Fluent::Output
     @subject % values
   end
 
-  def sendmail(subject, msg)
+  def sendmail(subject, msg, dest = nil)
     smtp = Net::SMTP.new(@host, @port)
 
     if @user and @password
@@ -193,6 +222,9 @@ class Fluent::MailOutput < Fluent::Output
 
     subject = subject.force_encoding('binary')
     body = msg.force_encoding('binary')
+    to = (dest && dest['to']) ? dest['to'] : @to
+    cc = (dest && dest['cc']) ? dest['cc'] : @cc
+    bcc = (dest && dest['bcc']) ? dest['bcc'] : @bcc
 
     # Date: header has timezone, so usually it is not necessary to set locale explicitly
     # But, for people who would see mail header text directly, the locale information may help something
@@ -203,9 +235,9 @@ class Fluent::MailOutput < Fluent::Output
     content = <<EOF
 Date: #{date}
 From: #{@from}
-To: #{@to}
-Cc: #{@cc}
-Bcc: #{@bcc}
+To: #{to}
+Cc: #{cc}
+Bcc: #{bcc}
 Subject: #{subject}
 Message-Id: #{mid}
 Mime-Version: 1.0
@@ -213,7 +245,7 @@ Content-Type: #{@content_type}
 
 #{body}
 EOF
-    response = smtp.send_mail(content, @from, @to.split(/,/), @cc.split(/,/), @bcc.split(/,/))
+    response = smtp.send_mail(content, @from, to.split(/,/), cc.split(/,/), bcc.split(/,/))
     log.debug "out_mail: content: #{content.gsub("\n", "\\n")}"
     log.debug "out_mail: email send response: #{response.string.chomp}"
     smtp.finish
@@ -245,4 +277,14 @@ EOF
       retry
     end
   end
+
+  def create_dest_addr(dest_type, record)
+    addr = instance_variable_get(:"@#{dest_type}")
+    dest_key = instance_variable_get(:"@#{dest_type}_key")
+    if dest_key
+      return record[dest_key] || addr
+    else
+      return addr
+    end
+  end
 end

data/test/plugin/test_out_mail.rb

@@ -46,6 +46,21 @@ class MailOutputTest < Test::Unit::TestCase
     to localhost@localdomain
   ]
 
+  CONFIG_DEST_ADDR = %[
+    out_keys tag,time,value
+    time_key time
+    time_format %Y/%m/%d %H:%M:%S
+    tag_key tag
+    subject Fluentd Notification Alarm %s
+    subject_out_keys tag
+    host localhost
+    port 25
+    from localhost@localdomain
+    to_key to
+    cc_key cc
+    bcc_key bcc
+  ]
+
   def create_driver(conf=CONFIG_OUT_KEYS,tag='test')
     Fluent::Test::OutputTestDriver.new(Fluent::MailOutput, tag).configure(conf)
   end
@@ -75,6 +90,20 @@ class MailOutputTest < Test::Unit::TestCase
     end
   end
 
+  def test_dest_addr
+    d = create_driver(CONFIG_DEST_ADDR)
+    time = Time.now.to_i
+    d.run do
+      d.emit({
+        'value' => "message mail from fluentd out_mail",
+        'to' => "localhost@localdomain",
+        'cc' => "localhost@localdomain",
+        'bcc' => "localhost@localdomain",
+        },
+        time)
+    end
+  end
+
   def test_with_scrub
     d = create_driver(CONFIG_MESSAGE)
     invalid_string = "\xff".force_encoding('UTF-8')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-mail
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Yuichi UEMURA
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-29 00:00:00.000000000 Z
+date: 2016-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -69,7 +69,8 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- example.conf
+- example/example.conf
+- example/to_cc_bcc_key.conf
 - fluent-plugin-mail.gemspec
 - lib/fluent/plugin/out_mail.rb
 - test/helper.rb
@@ -93,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: fluent-plugin-mail
+rubyforge_project: 
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4