gas-gmail-to-slack

Gmail APIを利用して未読メールをSlackの指定チャンネルに転送する Google App Script (GAS) です。

これはSlackの公式App「Email」に似た機能を実現するものです。公式AppはHTMLメールをかっこよくSlack上で再現してくれますが、gas-gmail-to-slack は最低限の文字情報をSlackに転送します。また、公式Appに比べると設定が煩雑です。

gas-gmail-to-slack のメリットとしてSlackの無料プランでも利用可能な点、メールの前に付けるテキストをカスタマイズできる点が挙げられます。

利用例

cronからのメール通知をSlackチャンネルに転送する
ドメイン更新連絡など重要な割に見逃しやすいメールをSlackチャンネルに転送する

仕様・制限

メールの転送先として複数のSlackワークスペース・チャンネルを使い分けられます
アイコンや名前の変更はできません
元のメールがHTMLメールの場合、HTMLパートとテキストパートのどちらをSlackメッセージとして転送するか選択できます
転送したメッセージの先頭に任意の文字列を指定できます
- たとえばメンションを指定することができます
メールのSubjectはSlack上では太字で、メールの送信者と受信日は小さい字で表示します
メール本文の先頭4行だけが表示されます
- 「Show more」をクリックすれば全文が表示されます

オススメの使い方

本機能のために独立したGmailアカウントを用意し、メール振り分け機能を使って新アカウントに転送することをお勧めします。

Slackに転送済かどうかの管理はGmailの未読・既読で行っています。そのため、普段使いするGmailアカウントだと事故の元だと思います（転送対象メールを既読にしてしまうとSlackに転送されなくなります）。

また、後述する「複数の設定を使い分ける」機能を活用するためにも別アカウントがあった方が便利だと思います。

GASのデプロイ

まず Node.js と Visual Studio Code をインストールしましょう。

次のようにタイプすればGASをデプロイできます。

$ npm install -g @google/clasp
$ npm install -g typescript
$ npm i
$ clasp login
$ clasp create --title gmail-to-slack --type sheets --rootDir ./src
$ clasp push

このGASはスプレッドシートに紐付いたスクリプトとして使われる前提で作られていますので、clasp createのオプション指定でスプレッドシートを指定します。このスプレッドシートは設定ファイルとして利用します。

また、このGASはメールと同じアカウントで動作させる前提になっています。clasp loginでGASのログインを求められますが、専用Gmailアカウントを使う場合はそちらのアカウントでログインする必要があります。

設定（スプレッドシート）

既に説明した通り、設定にはスプレッドシートの1枚目のシートを利用します。

GAS中にスプレッドシートのひな形を作る関数 initConfigSpreadsheet() があるので、初回のGASデプロイの後で実行してみてください。

シート内の1行につき1組の設定を記述します。設定できる値は以下の通りです。

変数名	値
SLACK_API_ENDPOINT	Incoming WebhookのURL、スペース区切りで複数指定が可能
SLACK_PRETEXT	Slack投稿時にメール本文の前につける説明文（任意）
USE_HTMLBODY	HTMLメールを転送するかどうか（任意、デフォルト値:false）

Incoming WebhookのURLはAppとチャンネルに紐付くもので、App設定ページの「Incoming Webhook」で確認できます。古い方のIncoming Webhook（カスタムインテグレーション）でも動くと思いますが未確認です。

A列にはメールアドレスを書きます。後述する通り、メールアドレスごとに挙動を変えることができます。どのメールアドレスにも該当しなかった場合、先頭の設定（＝2行目）が採用されます。

複数の設定を使い分ける

Gmailではメールアドレスのローカルパート（@の前の部分）に+記号をつけ、その後に任意の文字列を付加したようなメールアドレスがエイリアスとして機能します。たとえば、gmail2slack@gmail.comがあなたのメールアドレスだとすれば、gmail2slack+abracadabra@gmail.comというメールアドレス宛のメールも同じアカウントで受け取れるというわけです。

これを利用して、メールエイリアスごとに投稿するSlackの部屋を変えるなど設定を使い分けることができます。

PRETEXTでメンションを指定する

すでに説明した通り、SLACK_PRETEXTを指定すれば任意の文字列をメール本文の前に追加することができます。

この機能を使えば、個人やチャンネル全体にメンションを指定することもできます。ただし、普段のSlackクライアントとは書き方が変わる点に注意してください。

SLACK_PRETEXT中に下記のように書けば個人またはチャンネル全体にメンションを送れます。

記述例	意味
<@[メンバーID]>	特定ユーザーに対するメンション
<!here>	@here の意味

参考：Formatting text for app surfaces | Slack

設定（スクリプトプロパティ）

一部の設定についてはGASのスクリプトプロパティを利用します。これはGASエディタから「プロジェクトの設定」「スクリプトプロパティ」でアクセスできます。

設定できる値は以下の通りです。

プロパティ名	値
GMAIL_SEARCH_STR	Gmailの検索条件（任意）

Gmailの検索条件を設定しないとGmailアカウントに届いた全てのメールをSlackに転送します。専用アカウントを作った場合はそれでも問題ないと思いますが、Slackに表示したくないメールも届くような場合はGmailの振り分け機能を使ってSlackに転送したいメールにタグをつけ、それをGMAIL_SEARCH_STRで指定すれば良いでしょう。

GASのトリガー設定

Gmailに未読メールが数通ある状態でGASエディタからgmailToSlack()を「実行」してみてください。未読メールが既読になり、メールがSlackに転送されれば成功です。再度テストする場合はGmailから対象メールを未読に戻してください。

手動実行がうまくいったら、「トリガー」「トリガーの追加」からスケジュール実行の設定をしてください。私は1時間に1回で設定していますが、即時性が重要な場合は1分1回などとしても良いでしょう。

以後、メールが届いたら自動的にSlackに転送されるはずです。

hnw/gas-gmail-to-slack