Contract for use with the Gmail content provider.
30 | * 31 | *Developers can use this content provider to display label information to the user.
32 | *
33 | * The label information includes:
34 | *
This content provider is available in Gmail version 2.3.6 or newer for Froyo/Gingerbread 43 | * and version 4.0.5 and newer for Honeycomb and Ice Cream Sandwich
44 | *An application can query the 45 | * 46 | * Content Resolver directly 47 | * (or use a Loader) 49 | * to obtain a Cursor with information for all labels on an account
50 | *Cursor labelsCursor = getContentResolver().query(GmailContract.Labels.getLabelsUri(
51 | * selectedAccount), null, null, null, null);
52 | */
53 | public final class GmailContract {
54 | private GmailContract() {}
55 |
56 | /**
57 | * Permission required to access this {@link android.content.ContentProvider}
58 | */
59 | public static final String PERMISSION =
60 | "com.google.android.gm.permission.READ_CONTENT_PROVIDER";
61 |
62 | /**
63 | * Authority for the Gmail content provider.
64 | */
65 | public static final String AUTHORITY = "com.google.android.gm";
66 |
67 | static final String LABELS_PARAM = "/labels";
68 | static final String LABEL_PARAM = "/label/";
69 | static final String BASE_URI_STRING = "content://" + AUTHORITY;
70 | static final String PACKAGE = "com.google.android.gm";
71 |
72 |
73 | /**
74 | * Check if the installed Gmail app supports querying for label information.
75 | *
76 | * @param c an application Context
77 | * @return true if it's safe to make label API queries
78 | */
79 | public static boolean canReadLabels(Context c) {
80 | boolean supported = false;
81 |
82 | try {
83 | final PackageInfo info = c.getPackageManager().getPackageInfo(PACKAGE,
84 | PackageManager.GET_PROVIDERS | PackageManager.GET_PERMISSIONS);
85 | boolean allowRead = false;
86 | if (info.permissions != null) {
87 | for (int i = 0, len = info.permissions.length; i < len; i++) {
88 | final PermissionInfo perm = info.permissions[i];
89 | if (PERMISSION.equals(perm.name)
90 | && perm.protectionLevel < PermissionInfo.PROTECTION_SIGNATURE) {
91 | allowRead = true;
92 | break;
93 | }
94 | }
95 | }
96 | if (allowRead && info.providers != null) {
97 | for (int i = 0, len = info.providers.length; i < len; i++) {
98 | final ProviderInfo provider = info.providers[i];
99 | if (AUTHORITY.equals(provider.authority) &&
100 | TextUtils.equals(PERMISSION, provider.readPermission)) {
101 | supported = true;
102 | }
103 | }
104 | }
105 | } catch (NameNotFoundException e) {
106 | // Gmail app not found
107 | }
108 | return supported;
109 | }
110 |
111 |
112 |
113 | /**
114 | * Table containing label information.
115 | */
116 | public static final class Labels {
117 | /**
118 | * Label canonical names for default Gmail system labels.
119 | */
120 | public static final class LabelCanonicalNames {
121 | /**
122 | * Canonical name for the Primary inbox category
123 | *Note: This label may not exist, based on the user's inbox configuration
124 | */ 125 | public static final String CANONICAL_NAME_INBOX_CATEGORY_PRIMARY = "^sq_ig_i_personal"; 126 | 127 | /** 128 | * Canonical name for the Social inbox category 129 | *Note: This label may not exist, based on the user's inbox configuration
130 | */ 131 | public static final String CANONICAL_NAME_INBOX_CATEGORY_SOCIAL = "^sq_ig_i_social"; 132 | 133 | /** 134 | * Canonical name for the Promotions inbox category 135 | *Note: This label may not exist, based on the user's inbox configuration
136 | */ 137 | public static final String CANONICAL_NAME_INBOX_CATEGORY_PROMOTIONS = "^sq_ig_i_promo"; 138 | 139 | /** 140 | * Canonical name for the Updates inbox category 141 | *Note: This label may not exist, based on the user's inbox configuration
142 | */ 143 | public static final String CANONICAL_NAME_INBOX_CATEGORY_UPDATES = 144 | "^sq_ig_i_notification"; 145 | 146 | /** 147 | * Canonical name for the Forums inbox category 148 | *Note: This label may not exist, based on the user's inbox configuration
149 | */ 150 | public static final String CANONICAL_NAME_INBOX_CATEGORY_FORUMS = "^sq_ig_i_group"; 151 | 152 | /** 153 | * Canonical name for the Inbox label 154 | *Note: This label may not exist, based on the user's inbox configuration
155 | */ 156 | public static final String CANONICAL_NAME_INBOX = "^i"; 157 | 158 | /** 159 | * Canonical name for the Priority Inbox label 160 | *Note: This label may not exist, based on the user's inbox configuration
161 | */ 162 | public static final String CANONICAL_NAME_PRIORITY_INBOX = "^iim"; 163 | 164 | /** 165 | * Canonical name for the Starred label 166 | */ 167 | public static final String CANONICAL_NAME_STARRED = "^t"; 168 | 169 | /** 170 | * Canonical name for the Sent label 171 | */ 172 | public static final String CANONICAL_NAME_SENT = "^f"; 173 | 174 | /** 175 | * Canonical name for the Drafts label 176 | */ 177 | public static final String CANONICAL_NAME_DRAFTS = "^r"; 178 | 179 | /** 180 | * Canonical name for the All Mail label 181 | */ 182 | public static final String CANONICAL_NAME_ALL_MAIL = "^all"; 183 | 184 | /** 185 | * Canonical name for the Spam label 186 | */ 187 | public static final String CANONICAL_NAME_SPAM = "^s"; 188 | 189 | /** 190 | * Canonical name for the Trash label 191 | */ 192 | public static final String CANONICAL_NAME_TRASH = "^k"; 193 | 194 | private LabelCanonicalNames() {} 195 | } 196 | 197 | /** 198 | * The MIME-type of uri providing a directory of 199 | * label items. 200 | */ 201 | public static final String CONTENT_TYPE = 202 | "vnd.android.cursor.dir/vnd.com.google.android.gm.label"; 203 | 204 | /** 205 | * The MIME-type of a label item. 206 | */ 207 | public static final String CONTENT_ITEM_TYPE = 208 | "vnd.android.cursor.item/vnd.com.google.android.gm.label"; 209 | 210 | /** 211 | * This string value is the canonical name of a label. Canonical names are not localized and 212 | * are not user-facing. 213 | * 214 | *Type: TEXT
215 | */ 216 | public static final String CANONICAL_NAME = "canonicalName"; 217 | /** 218 | * This string value is the user-visible name of a label. Names of system labels 219 | * (Inbox, Sent, Drafts...) are localized. 220 | * 221 | *Type: TEXT
222 | */ 223 | public static final String NAME = "name"; 224 | /** 225 | * This integer value is the number of conversations in this label. 226 | * 227 | *Type: INTEGER
228 | */ 229 | public static final String NUM_CONVERSATIONS = "numConversations"; 230 | /** 231 | * This integer value is the number of unread conversations in this label. 232 | * 233 | *Type: INTEGER
234 | */ 235 | public static final String NUM_UNREAD_CONVERSATIONS = "numUnreadConversations"; 236 | /** 237 | * This integer value is the label's foreground text color in 32-bit 0xAARRGGBB format. 238 | * 239 | *Type: INTEGER
240 | */ 241 | public static final String TEXT_COLOR = "text_color"; 242 | /** 243 | * This integer value is the label's background color in 32-bit 0xAARRGGBB format. 244 | * 245 | *Type: INTEGER
246 | */ 247 | public static final String BACKGROUND_COLOR = "background_color"; 248 | /** 249 | * This string column value is the uri that can be used in subsequent calls to 250 | * {@link android.content.ContentProvider#query()} to query for information on the single 251 | * label represented by this row. 252 | * 253 | *Type: TEXT
254 | */ 255 | public static final String URI = "labelUri"; 256 | 257 | /** 258 | * Returns a URI that, when queried, will return the list of labels for an 259 | * account. 260 | *261 | * To use the Labels API, an app must first find the email address of a 262 | * valid Gmail account to query for label information. The AccountManager can return this information (example). 266 | *
267 | * 268 | * @param account Name of a valid Google account. 269 | * @return The URL that can be queried to retrieve the the label list. 270 | */ 271 | public static Uri getLabelsUri(String account) { 272 | return Uri.parse(BASE_URI_STRING + "/" + account + LABELS_PARAM); 273 | } 274 | 275 | private Labels() {} 276 | } 277 | } 278 | --------------------------------------------------------------------------------