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.java
というシンプルなクラスが用意されています。
アプリは、この URI を直接クエリできます。さらに望ましいことに、CursorLoader
を使用して、アカウントのすべてのラベルの情報を含むカーソルを取得します。
Cursor labelsCursor = getContentResolver().query(GmailContract.Labels.getLabelsUri(selectedAccount), null, null, null, null);
このカーソル内のデータを使用すると、GmailContract.Labels.URI
列の URI 値を保持して、単一のラベルでの変更のクエリと監視を行うことができます。
事前定義ラベルの NAME
値は言語 / 地域によって異なる可能性があるため、GmailContract.Labels.NAME
は使用しないでください。代わりに、GmailContract.Labels.CANONICAL_NAME
列の文字列値を使用して、事前定義されたラベル(受信トレイ、送信済み、下書きなど)をプログラムで識別できます。
// loop through the cursor and find the Inbox
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
}
}
}
詳しくは、コンテンツ プロバイダの基本をご覧ください。
例を確認する
このコンテンツ プロバイダの例を見るには、サンプルアプリをダウンロードしてください。