适用于 Gmail 的 Android content provider

适用于 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 以进行查询。我们提供了一个名为 GmailContract 的类来构建 URI 并定义返回的列。应用可以直接查询此 URI。

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

如需了解详情,请参阅内容提供程序 基础知识

查看示例

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