SendGrid公式ライブラリ利用のコツ

SendGrid公式ライブラリ利用のコツ

はじめに

SendGridの機能は、ほぼ全てAPI経由で利用することができます。このうち、最も利用頻度の高いメール送信については、SendGrid社が主要なプログラミング言語向けに公式ライブラリを提供しています。今回は、公式ライブラリをうまく活用するためのコツをご紹介します。

どんなライブラリが提供されているの?

SendGridの公式ライブラリには大きく分けて2種類あります。それぞれプログラミング言語(C#、Go、Java、Node.js、PHP、Python、Rubyなど)毎に用意されています

  • メール送信ライブラリ(名称が「sendgrid-」で始まるもの)
    Web APIのメール送信用エンドポイントのラッパーです。メール送信に特化しているため、Web APIの他の機能(バウンスリストの取得や、各種設定変更など)を呼び出すことはできません。
  • SMTP APIライブラリ(名称が「smtpapi-」で始まるもの)
    SMTP API(※)を利用するためのJSON文字列生成用ライブラリです。メール送信ライブラリに組み込まれていますが、SMTPプロトコルでSMTP APIを利用する場合、単独で使用することも可能です。
     
    ※ SMTP APIはメール送信機能を拡張するオプションパラメータ(X-SMTPAPI)です。SMTPプロトコルとは別物です。

今回の記事では、よく使用されるメール送信ライブラリに話題を絞ってご紹介します。

どうやって利用するの?

具体的な利用方法とサンプルコードはこちらを参照してください。より詳細なドキュメントが必要な場合、各ライブラリのリポジトリを確認してください。

ライセンスは?

MITライセンスで提供されています。このライセンスは利用制限が緩い一方、ライブラリの提供者が責任を負わないものとなっています。

更新通知を受け取るには?

2015年7月現在、各ライブラリは機能改善およびバグ修正など、頻繁に更新されています。ライブラリの更新情報はGitHubのWatch機能を利用して受け取ることができます。基本的にSendGridの公式アナウンスでは更新情報は通知されません。

また、一般的なライブラリと同様、メジャーバージョンが変わるとインターフェイスが大きく変更されることもあるので、ライブラリをバージョンアップする際には注意してください。重大な変更については各リポジトリのREADMEに掲載される場合もありますので、合わせて確認することをお勧めします。

機能改善依頼をするには?

各ライブラリのリポジトリでPull Requestを送ってください。マージされるとSendGrid特製ノベルティがもらえる場合もあります

バグ報告をするには?

バグを発見した場合、各ライブラリのリポジトリでIssueを上げてください。もちろん、修正内容をPull Requestで送っていただくのも大歓迎です。

さいごに

SendGridでは公式ライブラリ以外にもサンプルコード、ドキュメント、ツールなど様々なものをオープンソースで提供しています。是非チェックしてみてください。