codeなにがし::Rootmailer Primitive: スプレッドシートからのメール個別配信プログラム

Rootmailer Primitive: スプレッドシートからのメール個別配信プログラム: ゲスト (theorist)

ソースコードID：　751
登録日時：　2009/06/04 02:55
最終更新日時：　2009/06/04 12:31
アクセス数：　304
タグ：　 ruby

0 users

説明

■RootMailer Primitive
OpenOffice Calc や Microsoft Excel などの表計算ソフト用のファイルから，各受取人に個別化されたメールを一括送信するプログラムです．いくつか疑問点などを列挙するので，コメントよろしく．

●オブジェクト指向の考え方はまちがっていないか？　(これを尋ねたいからコードが長い．)
-クラスのデザイン
-インスタンス変数の使い方

●sm.send(mail, mail.from, mail.to)
が宛先に対応する各行ごとに呼び出されている．それって毎回ホストとの接続を切ってログインし直してるってことなのか？　30人くらいでしか試験していないが，かなり遅く，一通2.7秒ていどだった，メール配信時にたぶん一通一通接続を切っている．何通かまとめて送った方がいいのか？

何通かまとめるときは，

  Net::SMTP.start(@host, @port, "localhost", @account, @password, :plain) do |smtp|
    smtp.sendmail(mail1.to_s, from, to)
    smtp.sendmail(mail2.to_s, from, to)
    smtp.sendmail(mail3.to_s, from, to)
  end

という感じでひとつの start メソッド内で複数メールを送れるようだが，たとえば gmail のばあい何通分くらいまでなら一度に送っていいのか？

●s = Openoffice.new("your_spreadsheet.ods")
はファイルをぜんぶメモリに取り込むのか．それだと大きなファイルは大変そう．それともファイル名だけを記憶しておいて，cell が読み出されるたびにその cell に行くのか．スプレッドシートファイル ods がどういう形式でデータを持ってるかに依存する．csv だとテキスト形式なのでたぶんファイルを特定行まで読み込まないとその行が何行目にあるか分からない？のかな．もし始めから行や列に番号が割り当てられているようなデータならばそういうことはないだろうが．

■利用法
-Ruby をインストール．
-Rubygems をインストール．
    Mac OS X 10.5 Leopard ならすでにインストールされている．
    MacPorts でインストールしたければ，MacPorts 自体をインストールしたあと，ターミナルで
        $ sudo port install rb-rubygems
    環境によっては sudo は省略可．
-以下の Rubygems をインストール．
    $ sudo gem install tmail
    $ sudo gem install tlsmail
    $ sudo gem install roo
-データの入ったスプレッドシートを準備．
    スプレッドシートは OpenOffice .ods, MS Excel .xls, .xlsx など．
    その中身は以下のようになっている．
        最初の数行
        start_here を1列目にふくむ行
        項目名を示すヘッダ行
        データの入った行たち
        stop_here を1列目にふくむ行
-実行ファイルの前半部でスプレッドシートファイル名とか出力する列とかメールサーバーなどの必要な情報を入力して設定．
-実行ファイルの 165 行目 self.to = mock_to を self.to = real_to に変更．
-ターミナルでスプレッドシートファイルと実行ファイルの置いてある場所に移動して，
    $ ruby ファイル名
-smtp サーバーのパスワードを求められるので入力．

ソースコード

履歴表示コピペ用

#!ruby -Ku
# rootmailer090604.rb
# Rootmailer Primitive: A program for sending personalized mails from a spreadsheet file,
# using roo and TMail
# Rootmailer Primitive: スプレッドシートからのメール個別配信プログラム
# ------------------------------------------------------------------------ 
### User's guide

=begin
This script sends each recipient an email contaning data concerning herself.
The data is stored in a spreadsheet (OpenOffice.org .ods, Excel .xls or .xlsx etc.).
It sends out data in all rows and columns you specify. 
To specify columns, use a variable called outputcolumns.
To specify rows, use 
-a variblle called skiprows and 
-the following two markers
  --start_here (placed just before the header row) and
  --stop_here.

The user is supposed to configure the settings in the first half of this file.
The rest is for programmers only.
=end

# ------------------------------------------------------------------------ 
require 'rubygems'
require 'roo'  # http://roo.rubyforge.org/
require 'tmail' # http://tmail.rubyforge.org/
require 'tlsmail'
require 'kconv' 
# ------------------------------------------------------------------------ 
## First, prepare a spreadsheet

## Choose a file and a sheet to be processed:
s = Openoffice.new("your_spreadsheet.ods") # creates an OpenOffice Spreadsheet instance
# Alternatively, replace the above line with s = Excel.new(...) or Excelx.new(...)
# or Google.new(...).  Check the official site for roo for details.

s.default_sheet = s.sheets.first  # first sheet of the spreadsheet file
# The sheet must consist of
# -a few lines, which will be skipped,
# -a line containing "start_here" in the first column,
# -a header line contaning field names, 
# -lines containing data (empty rows are skipped)
# -a line containing "stop_here" in the first column,
# -remaning lines, which will be skipped.

## Activate either of the following two lines to choose columns to be sent
outputcolumns = (1..s.last_column) # to send all columns
# outputcolumns = %w[B E]   # to send selected columns; %w[B E] means ["B", "E"]

## Exclude certain rows if you want.
skiprows = []  # skiprows = [] skips no rows; skiprows = [3, 6, 7] skips rows 3, 6, 7.

## To give a rule for generating e-mail addresses, either
# -specify the column in which addresses are stored
#def mailaddress(s, row)
#  s.cell(row, "C").to_s  # means addresses are stored in column C.
#   Just replace "C" by an appropriate column
#end
# or
# -specify a more complex rule.  An example follows:
def mailaddress(s, row)
  if address = s.cell(row, "C") # applies when this cell is nonempty
    return address.to_s
  else
    id = s.cell(row, 1) # id number
    id.downcase + "@some.domain"
  end
end

# ------------------------------------------------------------------------ 
## Second, compose mail
# NB. Do not delete the quotation marks for each item

from = 'your??@mail.address' # this will appear in the mail
# mock_to = 'your??@mail.address' # for experiment. Not yet realized.
subj = "codeなにがしに投稿したコード"
preface = "おはよう．きみに与えられた本日のミッションは，こちらのコードをレビューすることだ．コメントするときは，文末に以下のニックネームと合い言葉を入れたまえ．
"
# Data concerning each person (s.personal_data) will be inserted here. 
# 個人にかかわる情報はここに入る．
closing = "それでは，ごきげんよう．
"

# ------------------------------------------------------------------------ 
## Third, configure the mailer settings

#Enter your info:
smtpserver =  "smtp.gmail.com" # Enter your smpt server
port = 587  # usually 25 if unspecified
smtpaddress = "your??@gmail.com"
tls = true # true if the server (like that of gmail) requires encryption with TLS.
# NB. Using gmail from this mailer shows your IP address to the recipients, 
# just like a usual maier such as Thunderbird

# The following is just to avoid writing a password on this file.
# I'm not sure if this gives a sufficient protection.
# Enter your password from the keyboard; what you enter will not appear on the screen.
system 'stty -echo'
print 'smtp password: '
password = $stdin.gets.chop
system 'stty echo'
print "\n"

# ------------------------------------------------------------------------ 
## The rest is for programmers only.
# You probably do not have to rewrite the rest of this file.

module RooUtilities  # to be mixed in the GenericSpreadsheet class, 
  # the superclass of the Openoffice class
  def address(row)
    mailaddress(self, row)
  end
  def personal_data(row)
    msg = ""
    self.outputcolumns.each do |j|
      msg = msg + self.cell(self.header,j).to_s + ": " + self.cell(row,j).to_s + "\n"
    end
    msg
  end
end

class GenericSpreadsheet # the parent of the Openoffice class and other roo spreadsheet classes
  include RooUtilities  # mixin
  attr_accessor :header, :outputcolumns, :skiprows # Better not define 
    # instance variables in a module.
  def set_ss_values(outputcolumns, skiprows)
    @outputcolumns = outputcolumns
    @skiprows = skiprows
  end
end

class SMTPMailer
  def initialize(host, port, account, password,tls=false)
    @host = host
    @port = port
    @account = account
    @password = password
    @tls = tls
  end
  def send(mail,from, to)
    if @tls
      Net::SMTP.enable_tls(OpenSSL::SSL::VERIFY_NONE)
    end
    Net::SMTP.start(@host, @port, "localhost", @account, @password, :plain) do |smtp|
       smtp.sendmail(mail.to_s, from, to)
    end # do |smtp|
  end # def send
end

class TMailExtended < TMail::Mail
  # attr_accessor :row, # :preface, :closing 
  def for_recipient(row)
    @row = row
  end
  def body(s, preface, closing)
    msg = preface + "\n\n"
    msg = msg + s.personal_data(@row)
    msg = msg + "\n" + closing + "\n\n"
  end
  def compose(s, from, subj, preface, closing)
    p real_to = s.address(@row) # real stuff
    p mock_to = 'your??@mail.address' # for experiment
    puts
    self.to = mock_to # choose the right hand side!!
      # @to insted of self.to failed.

    self.from = from # using the instance variable @from gives smtp server address.
      # Better use the setters.
    self.subject = Kconv.tojis(subj)
    self.date = Time.now
    self.mime_version = '1.0'
    self.set_content_type 'text', 'plain', {'charset'=>'iso-2022-jp'}
    puts body = body(s, preface, closing) # same as self.body()
    # Without Konv.tojis mails sent to yahoo.co.jp mojibake when viewed on the yahoo web
    self.body = Kconv.tojis(body)
    self
  end
end # class

## The main process
sm=SMTPMailer.new(smtpserver, port, smtpaddress, password, tls) # Okay to send many mails?
s.set_ss_values(outputcolumns, skiprows)
count = -1
s.header = 1
(1..s.last_row).each do |row|
  case count
  when -1
    if s.cell(row, 1) == "start_here"
      count = 0
    end
  when 0
    s.header = row
    count = 1
  else
    if s.cell(row, 1) == "stop_here"
      print( count-1, " mails have been sent", "\n" )
      break
    elsif s.skiprows.include?(row) || ! (s.cell(row, 1))  # skip empty rows, too
      puts
    else
      mail = TMailExtended.new
      p mail.for_recipient(row)
      mail.compose(s, from, subj, preface, closing)
      sm.send(mail, mail.from, mail.to)
      count = count + 1
    end # if
  end # case
end # each row

1：ゲスト (theorist)
2009/06/04 12:31

投稿時にエラーが起きたので投稿に失敗したと思ったら，同じ記事が3つも上がっていました．失礼．

ちゃんと反映されませんでしたが，投稿したときにつけたタグは以下のとおり:
Ruby roo TMail Excel OpenOffice 表計算 ods メール一括配信
あと，Gmail を追加してもいいですね．

前へ 1 次へ

説明

ソースコード

コメント

ソースコードのブログパーツ

GoodJobしたユーザ

ブックマークコメント

関連するなにがし

お問い合わせ