Gmail 用 Android コンテンツ プロバイダ

Android 版 Gmail アプリには、サードパーティ デベロッパーがラベル情報（名前や未読数など）を取得し、その情報が変更されたときに最新の状態を維持するために使用できるコンテンツ プロバイダが含まれています。たとえば、アプリやウィジェットで特定のアカウントの受信トレイの未読数を表示できます。

このコンテンツ プロバイダを使用する前に、GmailContract.canReadLabels(Context) メソッドを呼び出して、ユーザーの Gmail アプリのバージョンがこれらのクエリをサポートしているかどうかを判断します。

クエリを実行する有効な Gmail アカウントを見つける

アプリは、ラベル情報をクエリするために、まず有効な Gmail アカウントのメールアドレスを見つける必要があります。GET_ACCOUNTS 権限を持つ AccountManager は、次の情報を返すことができます。

// Get the account list, and pick the first one.
final String ACCOUNT_TYPE_GOOGLE = "com.google";
final String[] FEATURES_MAIL = {
        "service_mail"
};
AccountManager.get(this).getAccountsByTypeAndFeatures(ACCOUNT_TYPE_GOOGLE, FEATURES_MAIL,
        new AccountManagerCallback() {
            @Override
            public void run(AccountManagerFuture future) {
                Account[] accounts = null;
                try {
                    accounts = future.getResult();
                    if (accounts != null && accounts.length > 0) {
                        String selectedAccount = accounts[0].name;
                        queryLabels(selectedAccount);
                    }

                } catch (OperationCanceledException oce) {
                    // TODO: handle exception
                } catch (IOException ioe) {
                    // TODO: handle exception
                } catch (AuthenticatorException ae) {
                    // TODO: handle exception
                }
            }
        }, null /* handler */);

コンテンツ プロバイダをクエリする

メールアドレスを選択すると、クエリ対象の ContentProvider URI を取得できます。URI を構築し、返される列を定義するために、GmailContract というクラスが用意されています。アプリはこの URI を直接クエリできます。

Cursor のデータを使用すると、GmailContract.Labels.URI 列に URI 値を保持して、単一のラベルに対するクエリと変更の監視を行うことができます。

事前定義されたラベルの NAME 値は言語 / 地域によって異なるため、GmailContract.Labels.NAME は使用しないでください。代わりに、GmailContract.Labels.CANONICAL_NAME 列の文字列値を使用して、受信トレイ、送信済み、下書きなどの事前定義されたラベルをプログラムで識別できます。

// Query for all labels and find the Inbox.
try (Cursor labelsCursor = getContentResolver().query(
        GmailContract.Labels.getLabelsUri(selectedAccount), null, null, null, null)) {
    if (labelsCursor != null) {
        final String inboxCanonicalName = GmailContract.Labels.LabelCanonicalName.CANONICAL_NAME_INBOX;
        final int canonicalNameIndex = labelsCursor.getColumnIndexOrThrow(GmailContract.Labels.CANONICAL_NAME);
        while (labelsCursor.moveToNext()) {
            if (inboxCanonicalName.equals(labelsCursor.getString(canonicalNameIndex))) {
                // This row corresponds to the Inbox.
            }
        }
    }
}

詳しくは、コンテンツ プロバイダの基本をご覧ください。

例を確認する

このコンテンツ プロバイダの動作例については、サンプルアプリをダウンロードしてください。