這個Ruby Gem提供了與官方API集成的MailTrap。
通過MailTrap快速將電子郵件發送功能添加到Ruby應用程序中。
(該客戶端使用API V2,用於V1,請參閱此文檔)
將此行添加到您的應用程序的gemfile:
gem 'mailtrap'
然後執行:
$ bundle install
或自行安裝:
$ gem install mailtrap
# place this code in config/environments/production.rb:
config . action_mailer . delivery_method = :mailtrap
# then set the MAILTRAP_API_KEY environment variable
# using your hosting solution.
require 'mailtrap'
# create mail object
mail = Mailtrap :: Mail :: Base . new (
from : { email : '[email protected]' , name : 'Mailtrap Test' } ,
to : [
{ email : '[email protected]' }
] ,
subject : 'You are awesome!' ,
text : "Congrats for sending test email with Mailtrap!"
)
# create client and send
client = Mailtrap :: Client . new ( api_key : 'your-api-key' )
client . send ( mail )
有關更多示例,請參閱examples
文件夾。
mailtrap
GEM使用MailTrap API發送電子郵件。 MailTrap API不會嘗試複製SMTP。這就是為什麼您應該期望在發送方面有一些限制的原因。例如, /api/send
端點忽略Content-Transfer-Encoding
(請參見API文檔中的headers
)。這意味著您的收件人將僅在默認編碼中收到電子郵件,如果您使用MailTrap API發送,則quoted-printable
。
對於確實需要使用7bit
或任何其他編碼的人,SMTP在這方面提供了更好的靈活性。轉到您的MailTrap帳戶→電子郵件發送→發送域→您的域→ SMTP/API設置以查找SMTP配置示例。
更改Mailtrap::Sending::Client
端到Mailtrap::Client
。
如果使用具有Sending
命名空間的類,請刪除上面示例中的名稱空間。
檢查回購後,運行bin/setup
以安裝依賴關係。然後,運行rake spec
以運行測試。您還可以運行bin/console
以獲得交互提示,該提示可以讓您進行實驗。
要將此GEM安裝到本地計算機上,請運行bundle exec rake install
。要發布新版本,請在version.rb
中更新版本號,然後運行bundle exec rake release
,該版本將為版本創建一個Git標籤,推送Git Consits和創建標籤,然後將.gem
文件推到RubyGems。 org。
歡迎在GitHub上進行錯誤報告和拉動請求。該項目旨在是一個安全,熱情的協作空間,預計貢獻者將遵守行為準則。
根據MIT許可證的條款,該寶石可作為開源。
在MailTrap項目的代碼庫,問題跟踪器,聊天室和郵件列表中,每個人都在遵循《行為守則》中進行交互。