Laravel SocialiteのgetEmailでTwitterのメールアドレスが取得できなかったので調べてみた

こんにちは、エンジニアの @akase244 です。

当社で開発・運営している「chirami（Webデザイナー向けのHTMLプレビューツール）」では、Twitter、GitHub、Facebookアカウントを利用しログインができます。（chiramiの使い方についてはこちらをご覧ください）

f:id:akase244:20170807102032p:plain

おかしい。。。前回書いた記事とまったく同じ導入になっている気がするが。。。気にしない。

chiramiのログイン部分はLaravel Socialiteを利用しています。
以前の記事では、Laravel Socialiteの「getName()」で日本語名が返ってくるカスタマイズについて触れましたが、今回は「getEmail()」についてちょっと調べてみました。

認証後にメールアドレスを取得してみると。。。

繰り返しになりますが、chiramiではTwitter、GitHub、Facebookアカウントを利用しログインができます。
ということで、各SNSプロバイダで認証後に以下のように getEmail() を実行すると、Twitterの場合のみメールアドレスが取得できませんでした。

（現状、chiramiでは新規ログイン時にメールアドレスの取得フローは設けておりませんが、今後利用者の方との連絡手段としてメールアドレスの取得を検討中です）

Facebookの開発者向けドキュメント「アクセス許可のリファレンス」を見ると、以下の記述のとおり、メールアドレスを取得するには「email」という権限が必要なことが分かります。

userオブジェクトのemailプロパティを介して、利用者のプライマリメールアドレスにアクセスできるようにします。

また、「ログインレビューとは」のページを見ると、以下のように記載されています。

次の3つの基本的なアクセス許可をリクエストする場合は、レビューは不要です。

public_profile、user_friends､email。

利用者がアプリにログインする際にそれ以外の許可をリクエストする場合は、レビューが必要です。

つまり、メールアドレスを取得する場合、以下のようなOAuthアプリ設定画面で「アイテムを審査に送信」といった特別な操作は不要であることが分かります。

f:id:akase244:20170806134538p:plain:w500

さらに、Laravel SocialiteのFacebookプロバイダに実装を見てみると、スコープとして email が指定されているため、 getEmail() でメールアドレスが取得できそうだということが分かります。

次にGitHubですが、「About scopes for OAuth Apps」を見ると、「user:email」の権限でメールアドレスが取得できることが分かります。

Name	Description
user:email	Grants read access to a user’s email addresses.

Laravel SocialiteのGitHubプロバイダもFacebookプロバイダと同じような作りになっており、スコープとして user:email が指定されているため、 getEmail() でメールアドレスが取得できそうだということが分かります。

さて、いよいよTwitterです。
Twitter Developer Documentationの「GET account/verify_credentials」の「Parameters」を見ると、「include_email」というパラメータに「true」を渡すと、メールアドレス取得できることが分かります。

Name	Required	Description	Default Value	Example
include_email	optional	When set to true email will be returned in the user objects as a string. If the user does not have an email address on their account, or if the email address is not verified, null will be returned.		true