Blastengine SDK

Blastengine SDKは、Rubyを用いてエンジニア向けメール配信システム「ブラストエンジン」にてメール送信を行うSDKです。

インストール

Gemfileに以下を追加します。

gem 'blastengine'

そして下記コマンドを実行します。

$ bundle install

またはgemコマンドでインストールしてください。

$ gem install blastengine

使い方

初期化

APIキーとユーザー名はblastengineのサイトで取得してください。

client = Blastengine.initialize api_key: "API_KEY", user_name: "YOUR_USER_NAME"

メール送信

mail = Blastengine::Mail.new
mail.from email: "[email protected]", name: "Administrator"
mail.addTo email: config["to"], insert_code: { name1: "name 1" }
mail.subject = "Test email"
mail.text_part = "This is a test email __name1__"
mail.html_part = "<html><body>This is a test email __name1__</body></html>"
mail.attachments << "README.md"
bol = mail.send
expect(bol).to be true
delivery_id = mail.delivery_id
expect(delivery_id).to be_an(Integer)

送信先は制限なく登録できます。

mail = Blastengine::Mail.new
mail.from email: "[email protected]", name: "Administrator"
10000.times do |i|
    mail.addTo email: "bulk#{i}@example.jp", insert_code: { name1: "name #{i}" }
end
mail.subject = "Test email"
mail.text_part = "This is a test email __name1__"
mail.html_part = "<html><body>This is a test email __name1__</body></html>"
mail.attachments << "README.md"
bol = mail.send
expect(bol).to be true
delivery_id = mail.delivery_id
expect(delivery_id).to be_an(Integer)

メール検索

params = {
    "delivery_start": Time.now - 60 * 60 * 24 * 30,
    "delivery_end": Time.now,
    "delivery_type": ["BULK"],
    "status": ["EDIT", "SENT"]
}
ary = Blastengine::Mail.find params
ary[0].delivery_type # BULK
ary[0].status # SENT

配信ログ検索

params = {
    "delivery_type": ["BULK"],
    "status": ["EDIT", "SENT"]
}
ary = Blastengine::Log.find params

トランザクションメール

テキストメール

transaction = Blastengine::Transaction.new
transaction.from email: "[email protected]", name: "Administrator"
transaction.to = "[email protected]"
transaction.subject = "Test subject"
transaction.text_part = "This is a test email"
transaction.html_part = "<H1>Hello, world!</h1>"
delivery_id = transaction.send

添付ファイル付きメール

transaction = Blastengine::Transaction.new
transaction.from "[email protected]", "Administrator"
transaction.to = "[email protected]"
transaction.subject = "Test subject"
transaction.text_part = "This is a test email"
transaction.html_part = "<H1>Hello, world!</h1>"
transaction.attachments << "README.md"
transaction.attachments << "./spec/test.jpg"
delivery_id = transaction.send

バルクメール

bulk = Blastengine::Bulk.new
bulk.from "[email protected]", "Administrator"
bulk.subject = "Test bulk email"
bulk.text_part = "This is a test email to __name__"
# Register email as template
bulk.register

# Add address
bulk.addTo "[email protected]", {name: "User 1"}
bulk.addTo "[email protected]", {name: "User 2"}
bulk.update

# Send email immediately
bulk.send

# Send email 2 minutes later
bulk.send Time.now + 120

アドレスのCSVアップロード

bulk = Blastengine::Bulk.new
bulk.from email: config["from"]["email"], name: config["from"]["name"]
bulk.subject = "Test bulk email, 2 minute later"
bulk.text_part = "This is a test email to __name__"
bulk.register

job = bulk.import "./spec/example.csv"

while !job.finish?
    puts job.percentage
end

# Result of importing email addresses
job.total_count
job.success_count
job.failed_count
job.error_file_url

# Get error if there is it
job.error_message

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Blastengine project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.