适用于 Gmail 的 Android content provider

Android 版 Gmail 应用程序包含一个 content provider 第三方开发者可以用来检索标签信息,如名称和 未读消息数,并随着信息的变化而更新。例如,某个应用 或微件可以显示特定账号收件箱的未读邮件数。

使用此内容提供程序之前,请先调用 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 */);

查询 content provider

选择电子邮件地址之后,您就可以获取 ContentProvider 要查询的 URI。我们提供了一个名为 GmailContract.java 来构建 URI 并定义返回的列。

应用可以直接查询此 URI,或者最好使用 CursorLoader — 获取一个游标,其中包含账号中所有标签的信息:

Cursor labelsCursor = getContentResolver().query(GmailContract.Labels.getLabelsUri(selectedAccount), null, null, null, null);

借助此游标中的数据,您可以将 URI 值保留在 GmailContract.Labels.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
        }
    }
}

如需更多帮助,请参阅 content provider 基础知识

查看示例

如需查看实际使用此 content provider 的示例, 下载示例应用