适用于 Gmail 的 Android content provider

Android 版 Gmail 应用包含一个内容提供方,第三方开发者可以使用该提供方检索标签信息(例如名称和未读邮件数),并在这些信息发生变化时及时更新。例如,应用或 widget 可以显示特定账号收件箱中的未读邮件数量。

在使用此内容提供方之前,请调用 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
        }
    }
}

如需更多帮助,请参阅内容提供程序基础知识

查看示例

如需查看此内容提供程序的实际运作示例,请下载示例应用