blob: a50050818be62f1f5598143db0f19ebb8edf7b1e [file] [log] [blame]
Vikram Aggarwal4f9a4c52012-01-11 15:04:55 -08001/*******************************************************************************
2 * Copyright (C) 2011 Google Inc.
3 * Licensed to The Android Open Source Project.
Mindy Pereira6f92de62011-12-19 11:31:48 -08004 *
Vikram Aggarwal4f9a4c52012-01-11 15:04:55 -08005 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
Mindy Pereira6f92de62011-12-19 11:31:48 -08008 *
Vikram Aggarwal4f9a4c52012-01-11 15:04:55 -08009 * http://www.apache.org/licenses/LICENSE-2.0
Mindy Pereira6f92de62011-12-19 11:31:48 -080010 *
Vikram Aggarwal4f9a4c52012-01-11 15:04:55 -080011 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *******************************************************************************/
Mindy Pereira6f92de62011-12-19 11:31:48 -080017
Andy Huang30e2c242012-01-06 18:14:30 -080018package com.android.mail.providers;
Mindy Pereira6f92de62011-12-19 11:31:48 -080019
Mindy Pereira82cc5662012-01-09 17:29:30 -080020import android.content.Context;
Mindy Pereira6f92de62011-12-19 11:31:48 -080021import android.provider.BaseColumns;
Mindy Pereira82cc5662012-01-09 17:29:30 -080022import android.text.TextUtils;
23
24import com.android.common.contacts.DataUsageStatUpdater;
Mindy Pereira6f92de62011-12-19 11:31:48 -080025
Paul Westbrook82ea6da2011-12-15 11:03:51 -080026import java.lang.String;
Mindy Pereira82cc5662012-01-09 17:29:30 -080027import java.util.ArrayList;
Paul Westbrook82ea6da2011-12-15 11:03:51 -080028
Mindy Pereira6f92de62011-12-19 11:31:48 -080029
30public class UIProvider {
Mindy Pereira82cc5662012-01-09 17:29:30 -080031 public static final String EMAIL_SEPARATOR = "\n";
Mindy Pereira326c6602012-01-04 15:32:42 -080032 public static final long INVALID_CONVERSATION_ID = -1;
33 public static final long INVALID_MESSAGE_ID = -1;
34
Paul Westbrook82ea6da2011-12-15 11:03:51 -080035 // The actual content provider should define its own authority
Andy Huang30e2c242012-01-06 18:14:30 -080036 public static final String AUTHORITY = "com.android.mail.providers";
Mindy Pereira6f92de62011-12-19 11:31:48 -080037
38 public static final String ACCOUNT_LIST_TYPE =
Paul Westbrook82ea6da2011-12-15 11:03:51 -080039 "vnd.android.cursor.dir/vnd.com.android.mail.account";
Mindy Pereira6f92de62011-12-19 11:31:48 -080040 public static final String ACCOUNT_TYPE =
Paul Westbrook82ea6da2011-12-15 11:03:51 -080041 "vnd.android.cursor.item/vnd.com.android.mail.account";
Mindy Pereira6f92de62011-12-19 11:31:48 -080042
43 public static final String[] ACCOUNTS_PROJECTION = {
44 BaseColumns._ID,
45 AccountColumns.NAME,
46 AccountColumns.PROVIDER_VERSION,
47 AccountColumns.URI,
48 AccountColumns.CAPABILITIES,
49 AccountColumns.FOLDER_LIST_URI,
50 AccountColumns.SEARCH_URI,
51 AccountColumns.ACCOUNT_FROM_ADDRESSES_URI,
Mindy Pereira33fe9082012-01-09 16:24:30 -080052 AccountColumns.SAVE_DRAFT_URI,
Mindy Pereira7ed1c112012-01-18 10:59:25 -080053 AccountColumns.SEND_MAIL_URI,
Mindy Pereira96b5c352012-02-01 11:33:40 -080054 AccountColumns.EXPUNGE_MESSAGE_URI,
55 AccountColumns.UNDO_URI
Mindy Pereira6f92de62011-12-19 11:31:48 -080056 };
57
Mindy Pereira33fe9082012-01-09 16:24:30 -080058 public static final int ACCOUNT_ID_COLUMN = 0;
59 public static final int ACCOUNT_NAME_COLUMN = 1;
60 public static final int ACCOUNT_PROVIDER_VERISON_COLUMN = 2;
61 public static final int ACCOUNT_URI_COLUMN = 3;
62 public static final int ACCOUNT_CAPABILITIES_COLUMN = 4;
63 public static final int ACCOUNT_FOLDER_LIST_URI_COLUMN = 5;
64 public static final int ACCOUNT_SEARCH_URI_COLUMN = 6;
65 public static final int ACCOUNT_FROM_ADDRESSES_URI_COLUMN = 7;
66 public static final int ACCOUNT_SAVE_DRAFT_URI_COLUMN = 8;
67 public static final int ACCOUNT_SEND_MESSAGE_URI_COLUMN = 9;
Mindy Pereira82cc5662012-01-09 17:29:30 -080068 public static final int ACCOUNT_EXPUNGE_MESSAGE_URI_COLUMN = 10;
Mindy Pereira96b5c352012-02-01 11:33:40 -080069 public static final int ACCOUNT_UNDO_URI_COLUMN = 11;
Mindy Pereira33fe9082012-01-09 16:24:30 -080070
Mindy Pereira6f92de62011-12-19 11:31:48 -080071 public static final class AccountCapabilities {
Vikram Aggarwal859681b2012-02-03 10:02:24 -080072 /**
73 * Whether folders can be synchronized back to the server.
74 */
Paul Westbrook82ea6da2011-12-15 11:03:51 -080075 public static final int SYNCABLE_FOLDERS = 0x0001;
Vikram Aggarwal859681b2012-02-03 10:02:24 -080076 /**
77 * Whether the server allows reporting spam back.
78 */
Paul Westbrook82ea6da2011-12-15 11:03:51 -080079 public static final int REPORT_SPAM = 0x0002;
Vikram Aggarwal859681b2012-02-03 10:02:24 -080080 /**
81 * Whether the server supports a concept of Archive: removing mail from the Inbox but
82 * keeping it around.
83 */
Paul Westbrook82ea6da2011-12-15 11:03:51 -080084 public static final int ARCHIVE = 0x0004;
Vikram Aggarwal859681b2012-02-03 10:02:24 -080085 /**
86 * Whether the server will stop notifying on updates to this thread? This requires
87 * THREADED_CONVERSATIONS to be true, otherwise it should be ignored.
88 */
Paul Westbrook82ea6da2011-12-15 11:03:51 -080089 public static final int MUTE = 0x0008;
Vikram Aggarwal859681b2012-02-03 10:02:24 -080090 /**
91 * Whether the server supports searching over all messages. This requires SYNCABLE_FOLDERS
92 * to be true, otherwise it should be ignored.
93 */
Paul Westbrook82ea6da2011-12-15 11:03:51 -080094 public static final int SERVER_SEARCH = 0x0010;
Vikram Aggarwal859681b2012-02-03 10:02:24 -080095 /**
96 * Whether the server supports constraining search to a single folder. Requires
97 * SYNCABLE_FOLDERS, otherwise it should be ignored.
98 */
Paul Westbrook82ea6da2011-12-15 11:03:51 -080099 public static final int FOLDER_SERVER_SEARCH = 0x0020;
Vikram Aggarwal859681b2012-02-03 10:02:24 -0800100 /**
101 * Whether the server sends us sanitized HTML (guaranteed to not contain malicious HTML).
102 */
Paul Westbrook82ea6da2011-12-15 11:03:51 -0800103 public static final int SANITIZED_HTML = 0x0040;
Vikram Aggarwal859681b2012-02-03 10:02:24 -0800104 /**
105 * Whether the server allows synchronization of draft messages. This does NOT require
106 * SYNCABLE_FOLDERS to be set.
107 */
Paul Westbrook82ea6da2011-12-15 11:03:51 -0800108 public static final int DRAFT_SYNCHRONIZATION = 0x0080;
Vikram Aggarwal859681b2012-02-03 10:02:24 -0800109 /**
110 * Does the server allow the user to compose mails (and reply) using addresses other than
111 * their account name? For instance, GMail allows users to set FROM addresses that are
112 * different from account@gmail.com address. For instance, user@gmail.com could have another
113 * FROM: address like user@android.com. If the user has enabled multiple FROM address, he
114 * can compose (and reply) using either address.
115 */
Paul Westbrook82ea6da2011-12-15 11:03:51 -0800116 public static final int MULTIPLE_FROM_ADDRESSES = 0x0100;
Vikram Aggarwal859681b2012-02-03 10:02:24 -0800117 /**
118 * Whether the server allows the original message to be included in the reply by setting a
119 * flag on the reply. If we can avoid including the entire previous message, we save on
120 * bandwidth (replies are shorter).
121 */
Paul Westbrook82ea6da2011-12-15 11:03:51 -0800122 public static final int SMART_REPLY = 0x0200;
Vikram Aggarwal859681b2012-02-03 10:02:24 -0800123 /**
124 * Does this account support searching locally, on the device? This requires the backend
125 * storage to support a mechanism for searching.
126 */
Paul Westbrook82ea6da2011-12-15 11:03:51 -0800127 public static final int LOCAL_SEARCH = 0x0400;
Vikram Aggarwal859681b2012-02-03 10:02:24 -0800128 /**
129 * Whether the server supports a notion of threaded conversations: where replies to messages
130 * are tagged to keep conversations grouped. This could be full threading (each message
131 * lists its parent) or conversation-level threading (each message lists one conversation
132 * which it belongs to)
133 */
Paul Westbrook82ea6da2011-12-15 11:03:51 -0800134 public static final int THREADED_CONVERSATIONS = 0x0800;
Vikram Aggarwal859681b2012-02-03 10:02:24 -0800135 /**
136 * Whether the server supports allowing a conversation to be in multiple folders. (Or allows
137 * multiple labels on a single conversation, since labels and folders are interchangeable
138 * in this application.)
139 */
Mindy Pereira84648892012-02-03 08:29:55 -0800140 public static final int MULTIPLE_FOLDERS_PER_CONV = 0x1000;
Mindy Pereira6f92de62011-12-19 11:31:48 -0800141 }
142
143 public static final class AccountColumns {
Paul Westbrook82ea6da2011-12-15 11:03:51 -0800144 /**
145 * This string column contains the human visible name for the account.
146 */
Mindy Pereira6f92de62011-12-19 11:31:48 -0800147 public static final String NAME = "name";
Paul Westbrook82ea6da2011-12-15 11:03:51 -0800148
149 /**
150 * This integer column returns the version of the UI provider schema from which this
151 * account provider will return results.
152 */
Mindy Pereira6f92de62011-12-19 11:31:48 -0800153 public static final String PROVIDER_VERSION = "providerVersion";
Paul Westbrook82ea6da2011-12-15 11:03:51 -0800154
155 /**
156 * This string column contains the uri to directly access the information for this account.
157 */
Mindy Pereira6349a042012-01-04 11:25:01 -0800158 public static final String URI = "accountUri";
Paul Westbrook82ea6da2011-12-15 11:03:51 -0800159
160 /**
161 * This integer column contains a bit field of the possible cabibilities that this account
162 * supports.
163 */
Mindy Pereira6f92de62011-12-19 11:31:48 -0800164 public static final String CAPABILITIES = "capabilities";
Paul Westbrook82ea6da2011-12-15 11:03:51 -0800165
166 /**
Mindy Pereira750cc732011-12-21 13:32:29 -0800167 * This string column contains the content provider uri to return the
168 * list of top level folders for this account.
Paul Westbrook82ea6da2011-12-15 11:03:51 -0800169 */
Mindy Pereira6f92de62011-12-19 11:31:48 -0800170 public static final String FOLDER_LIST_URI = "folderListUri";
Paul Westbrook82ea6da2011-12-15 11:03:51 -0800171
172 /**
173 * This string column contains the content provider uri that can be queried for search
174 * results.
175 */
Mindy Pereira6f92de62011-12-19 11:31:48 -0800176 public static final String SEARCH_URI = "searchUri";
Paul Westbrook82ea6da2011-12-15 11:03:51 -0800177
178 /**
179 * This string column contains the content provider uri that can be queried to access the
180 * from addresses for this account.
181 */
Mindy Pereira6f92de62011-12-19 11:31:48 -0800182 public static final String ACCOUNT_FROM_ADDRESSES_URI = "accountFromAddressesUri";
Paul Westbrook82ea6da2011-12-15 11:03:51 -0800183
184 /**
185 * This string column contains the content provider uri that can be used to save (insert)
Mindy Pereira82cc5662012-01-09 17:29:30 -0800186 * new draft messages for this account. NOTE: This might be better to
187 * be an update operation on the messageUri.
Paul Westbrook82ea6da2011-12-15 11:03:51 -0800188 */
Mindy Pereira33fe9082012-01-09 16:24:30 -0800189 public static final String SAVE_DRAFT_URI = "saveDraftUri";
Mindy Pereira6f92de62011-12-19 11:31:48 -0800190
Paul Westbrook82ea6da2011-12-15 11:03:51 -0800191 /**
192 * This string column contains the content provider uri that can be used to send
193 * a message for this account.
194 * NOTE: This might be better to be an update operation on the messageUri.
195 */
Mindy Pereira7ed1c112012-01-18 10:59:25 -0800196 public static final String SEND_MAIL_URI = "sendMailUri";
Mindy Pereira82cc5662012-01-09 17:29:30 -0800197
198 /**
199 * This string column contains the content provider uri that can be used
200 * to expunge a message from this account. NOTE: This might be better to
201 * be an update operation on the messageUri.
202 */
203 public static final String EXPUNGE_MESSAGE_URI = "expungeMessageUri";
Mindy Pereira96b5c352012-02-01 11:33:40 -0800204
205 /**
206 * This string column contains the content provider uri that can be used
207 * to undo the last committed action.
208 */
209 public static String UNDO_URI = "undoUri";
Mindy Pereira3a565bf2011-12-21 11:26:21 -0800210 }
Paul Westbrook82ea6da2011-12-15 11:03:51 -0800211
Mindy Pereira3a565bf2011-12-21 11:26:21 -0800212 // We define a "folder" as anything that contains a list of conversations.
213 public static final String FOLDER_LIST_TYPE =
214 "vnd.android.cursor.dir/vnd.com.android.mail.folder";
215 public static final String FOLDER_TYPE =
Mindy Pereira750cc732011-12-21 13:32:29 -0800216 "vnd.android.cursor.item/vnd.com.android.mail.folder";
Mindy Pereira3a565bf2011-12-21 11:26:21 -0800217
218 public static final String[] FOLDERS_PROJECTION = {
219 BaseColumns._ID,
Mindy Pereira6349a042012-01-04 11:25:01 -0800220 FolderColumns.URI,
Mindy Pereira3a565bf2011-12-21 11:26:21 -0800221 FolderColumns.NAME,
Mindy Pereira750cc732011-12-21 13:32:29 -0800222 FolderColumns.HAS_CHILDREN,
Mindy Pereira0973b202011-12-21 15:48:12 -0800223 FolderColumns.CAPABILITIES,
224 FolderColumns.SYNC_FREQUENCY,
225 FolderColumns.SYNC_WINDOW,
Mindy Pereira750cc732011-12-21 13:32:29 -0800226 FolderColumns.CONVERSATION_LIST_URI,
Mindy Pereirabd8f51c2012-01-06 13:41:48 -0800227 FolderColumns.CHILD_FOLDERS_LIST_URI,
228 FolderColumns.UNREAD_COUNT,
Marc Blankc8a99422012-01-19 14:27:47 -0800229 FolderColumns.TOTAL_COUNT,
Mindy Pereira9c002102012-02-17 14:45:58 -0800230 FolderColumns.REFRESH_URI
Mindy Pereira3a565bf2011-12-21 11:26:21 -0800231 };
232
Mindy Pereira818143e2012-01-11 13:59:49 -0800233 public static final int FOLDER_ID_COLUMN = 0;
234 public static final int FOLDER_URI_COLUMN = 1;
235 public static final int FOLDER_NAME_COLUMN = 2;
236 public static final int FOLDER_HAS_CHILDREN_COLUMN = 3;
237 public static final int FOLDER_CAPABILITIES_COLUMN = 4;
238 public static final int FOLDER_SYNC_FREQUENCY_COLUMN = 5;
239 public static final int FOLDER_SYNC_WINDOW_COLUMN = 6;
240 public static final int FOLDER_CONVERSATION_LIST_URI_COLUMN = 7;
241 public static final int FOLDER_CHILD_FOLDERS_LIST_COLUMN = 8;
242 public static final int FOLDER_UNREAD_COUNT_COLUMN = 9;
243 public static final int FOLDER_TOTAL_COUNT_COLUMN = 10;
Mindy Pereira9c002102012-02-17 14:45:58 -0800244 public static final int FOLDER_REFRESH_URI_COLUMN = 11;
Mindy Pereira818143e2012-01-11 13:59:49 -0800245
Mindy Pereira0973b202011-12-21 15:48:12 -0800246 public static final class FolderCapabilities {
247 public static final int SYNCABLE = 0x0001;
248 public static final int PARENT = 0x0002;
249 public static final int CAN_HOLD_MAIL = 0x0004;
250 public static final int CAN_ACCEPT_MOVED_MESSAGES = 0x0008;
251 }
252
Mindy Pereira3a565bf2011-12-21 11:26:21 -0800253 public static final class FolderColumns {
Mindy Pereira6349a042012-01-04 11:25:01 -0800254 public static String URI = "folderUri";
Mindy Pereira3a565bf2011-12-21 11:26:21 -0800255 /**
256 * This string column contains the human visible name for the folder.
257 */
258 public static final String NAME = "name";
259 /**
Mindy Pereira0973b202011-12-21 15:48:12 -0800260 * This int column represents the capabilities of the folder specified by
261 * FolderCapabilities flags.
262 */
263 public static String CAPABILITIES = "capabilities";
264 /**
Mindy Pereirafc2277e2012-01-11 10:23:44 -0800265 * This int column represents whether or not this folder has any
Mindy Pereira750cc732011-12-21 13:32:29 -0800266 * child folders.
267 */
268 public static String HAS_CHILDREN = "hasChildren";
269 /**
Vikram Aggarwalff7d02a2012-01-11 16:37:45 -0800270 * This int column represents how often the folder should be synchronized with the server.
Mindy Pereira0973b202011-12-21 15:48:12 -0800271 */
272 public static String SYNC_FREQUENCY = "syncFrequency";
273 /**
274 * This int column represents how large the sync window is.
275 */
276 public static String SYNC_WINDOW = "syncWindow";
277 /**
Mindy Pereira750cc732011-12-21 13:32:29 -0800278 * This string column contains the content provider uri to return the
279 * list of conversations for this folder.
Mindy Pereira3a565bf2011-12-21 11:26:21 -0800280 */
281 public static final String CONVERSATION_LIST_URI = "conversationListUri";
Mindy Pereira750cc732011-12-21 13:32:29 -0800282 /**
283 * This string column contains the content provider uri to return the
284 * list of child folders of this folder.
285 */
286 public static String CHILD_FOLDERS_LIST_URI = "childFoldersListUri";
Mindy Pereira3a565bf2011-12-21 11:26:21 -0800287
Mindy Pereirabd8f51c2012-01-06 13:41:48 -0800288 public static String UNREAD_COUNT = "unreadCount";
289
290 public static String TOTAL_COUNT = "totalCount";
Mindy Pereira9c002102012-02-17 14:45:58 -0800291 /**
292 * This string column contains the content provider uri to force a
293 * refresh of this folder.
294 */
295 public static String REFRESH_URI = "refreshUri";
Mindy Pereirabd8f51c2012-01-06 13:41:48 -0800296
Vikram Aggarwalff7d02a2012-01-11 16:37:45 -0800297 public FolderColumns() {}
Mindy Pereira6f92de62011-12-19 11:31:48 -0800298 }
299
Mindy Pereiraa1406072011-12-22 10:54:06 -0800300 // We define a "folder" as anything that contains a list of conversations.
301 public static final String CONVERSATION_LIST_TYPE =
302 "vnd.android.cursor.dir/vnd.com.android.mail.conversation";
303 public static final String CONVERSATION_TYPE =
304 "vnd.android.cursor.item/vnd.com.android.mail.conversation";
305
Mindy Pereira9cdc4062012-02-02 14:18:08 -0800306
Mindy Pereiraa1406072011-12-22 10:54:06 -0800307 public static final String[] CONVERSATION_PROJECTION = {
308 BaseColumns._ID,
Mindy Pereira6349a042012-01-04 11:25:01 -0800309 ConversationColumns.URI,
Mindy Pereiraf9573c52011-12-22 14:02:49 -0800310 ConversationColumns.MESSAGE_LIST_URI,
Mindy Pereiraa1406072011-12-22 10:54:06 -0800311 ConversationColumns.SUBJECT,
Mindy Pereiraf9573c52011-12-22 14:02:49 -0800312 ConversationColumns.SNIPPET,
313 ConversationColumns.SENDER_INFO,
Mindy Pereiraf30cc092011-12-29 14:02:40 -0800314 ConversationColumns.DATE_RECEIVED_MS,
Mindy Pereira4db59c52012-01-12 09:45:13 -0800315 ConversationColumns.HAS_ATTACHMENTS,
316 ConversationColumns.NUM_MESSAGES,
317 ConversationColumns.NUM_DRAFTS,
318 ConversationColumns.SENDING_STATE,
Marc Blankc8a99422012-01-19 14:27:47 -0800319 ConversationColumns.PRIORITY,
320 ConversationColumns.READ,
Mindy Pereira36b6c8b2012-02-03 14:16:07 -0800321 ConversationColumns.STARRED,
322 ConversationColumns.FOLDER_LIST
Mindy Pereiraa1406072011-12-22 10:54:06 -0800323 };
324
Mindy Pereirafdd984b2011-12-29 09:43:45 -0800325 // These column indexes only work when the caller uses the
326 // default CONVERSATION_PROJECTION defined above.
Mindy Pereirafa7ef6e2011-12-29 14:18:15 -0800327 public static final int CONVERSATION_ID_COLUMN = 0;
Mindy Pereira3263fa92012-01-04 10:15:32 -0800328 public static final int CONVERSATION_URI_COLUMN = 1;
329 public static final int CONVERSATION_MESSAGE_LIST_URI_COLUMN = 2;
330 public static final int CONVERSATION_SUBJECT_COLUMN = 3;
331 public static final int CONVERSATION_SNIPPET_COLUMN = 4;
332 public static final int CONVERSATION_SENDER_INFO_COLUMN = 5;
333 public static final int CONVERSATION_DATE_RECEIVED_MS_COLUMN = 6;
334 public static final int CONVERSATION_HAS_ATTACHMENTS_COLUMN = 7;
Mindy Pereira4db59c52012-01-12 09:45:13 -0800335 public static final int CONVERSATION_NUM_MESSAGES_COLUMN = 8;
336 public static final int CONVERSATION_NUM_DRAFTS_COLUMN = 9;
337 public static final int CONVERSATION_SENDING_STATE_COLUMN = 10;
338 public static final int CONVERSATION_PRIORITY_COLUMN = 11;
Marc Blankc8a99422012-01-19 14:27:47 -0800339 public static final int CONVERSATION_READ_COLUMN = 12;
340 public static final int CONVERSATION_STARRED_COLUMN = 13;
Mindy Pereira36b6c8b2012-02-03 14:16:07 -0800341 public static final int CONVERSATION_FOLDER_LIST_COLUMN = 14;
Mindy Pereira4db59c52012-01-12 09:45:13 -0800342
343 public static final class ConversationSendingState {
Mindy Pereiraa4571372012-01-12 14:04:21 -0800344 public static final int OTHER = 0;
345 public static final int SENDING = 1;
346 public static final int SENT = 2;
Mindy Pereira4db59c52012-01-12 09:45:13 -0800347 public static final int SEND_ERROR = -1;
Vikram Aggarwal859681b2012-02-03 10:02:24 -0800348 }
Mindy Pereira4db59c52012-01-12 09:45:13 -0800349
350 public static final class ConversationPriority {
351 public static final int LOW = 0;
352 public static final int HIGH = 1;
Vikram Aggarwal859681b2012-02-03 10:02:24 -0800353 }
Mindy Pereirafa7ef6e2011-12-29 14:18:15 -0800354
Marc Blankc8a99422012-01-19 14:27:47 -0800355 public static final class ConversationFlags {
356 public static final int READ = 1<<0;
357 public static final int STARRED = 1<<1;
358 public static final int REPLIED = 1<<2;
359 public static final int FORWARDED = 1<<3;
Vikram Aggarwal859681b2012-02-03 10:02:24 -0800360 }
Marc Blankc8a99422012-01-19 14:27:47 -0800361
Mindy Pereiraa1406072011-12-22 10:54:06 -0800362 public static final class ConversationColumns {
Mindy Pereira6349a042012-01-04 11:25:01 -0800363 public static final String URI = "conversationUri";
Mindy Pereiraa1406072011-12-22 10:54:06 -0800364 /**
Mindy Pereiraa1406072011-12-22 10:54:06 -0800365 * This string column contains the content provider uri to return the
366 * list of messages for this conversation.
367 */
368 public static final String MESSAGE_LIST_URI = "messageListUri";
Mindy Pereira27a0cf02011-12-22 13:16:32 -0800369 /**
370 * This string column contains the subject string for a conversation.
371 */
372 public static final String SUBJECT = "subject";
373 /**
374 * This string column contains the snippet string for a conversation.
375 */
376 public static final String SNIPPET = "snippet";
377 /**
378 * This string column contains the sender info string for a
379 * conversation.
380 */
381 public static final String SENDER_INFO = "senderInfo";
382 /**
383 * This long column contains the time in ms of the latest update to a
384 * conversation.
385 */
386 public static final String DATE_RECEIVED_MS = "dateReceivedMs";
387
Mindy Pereiraf30cc092011-12-29 14:02:40 -0800388 /**
389 * This boolean column contains whether any messages in this conversation
390 * have attachments.
391 */
392 public static final String HAS_ATTACHMENTS = "hasAttachments";
393
Mindy Pereira4db59c52012-01-12 09:45:13 -0800394 /**
395 * This int column contains the number of messages in this conversation.
396 * For unthreaded, this will always be 1.
397 */
398 public static String NUM_MESSAGES = "numMessages";
399
400 /**
401 * This int column contains the number of drafts associated with this
402 * conversation.
403 */
404 public static String NUM_DRAFTS = "numDrafts";
405
406 /**
407 * This int column contains the state of drafts and replies associated
408 * with this conversation. Use ConversationSendingState to interpret
409 * this field.
410 */
411 public static String SENDING_STATE = "sendingState";
412
413 /**
414 * This int column contains the priority of this conversation. Use
415 * ConversationPriority to interpret this field.
416 */
417 public static String PRIORITY = "priority";
418
Marc Blankc8a99422012-01-19 14:27:47 -0800419 /**
420 * This boolean column indicates whether the conversation has been read
421 */
422 public static String READ = "read";
423
424 /**
425 * This boolean column indicates whether the conversation has been read
426 */
427 public static String STARRED = "starred";
428
Mindy Pereira36b6c8b2012-02-03 14:16:07 -0800429 /**
430 * This string column contains a csv of all folders associated with this
431 * conversation
432 */
433 public static final String FOLDER_LIST = "folderList";
434
Mindy Pereira27a0cf02011-12-22 13:16:32 -0800435 public ConversationColumns() {
Andy Huang732600e2012-01-10 17:47:17 -0800436 }
Mindy Pereiraa1406072011-12-22 10:54:06 -0800437 }
438
Mindy Pereira6f92de62011-12-19 11:31:48 -0800439 /**
440 * Returns a uri that, when queried, will return a cursor with a list of information for the
441 * list of configured accounts.
442 * @return
443 */
Paul Westbrook82ea6da2011-12-15 11:03:51 -0800444 // TODO: create a static registry for the starting point for the UI provider.
445// public static Uri getAccountsUri() {
446// return Uri.parse(BASE_URI_STRING + "/");
447// }
448
449 public static final class DraftType {
Andy Huang97c25be2012-01-12 15:12:09 -0800450 public static final int NOT_A_DRAFT = 0;
451 public static final int COMPOSE = 1;
452 public static final int REPLY = 2;
453 public static final int REPLY_ALL = 3;
454 public static final int FORWARD = 4;
Paul Westbrook82ea6da2011-12-15 11:03:51 -0800455
456 private DraftType() {}
Mindy Pereira6f92de62011-12-19 11:31:48 -0800457 }
458
Mindy Pereiraa1406072011-12-22 10:54:06 -0800459 public static final String[] MESSAGE_PROJECTION = {
460 BaseColumns._ID,
Mindy Pereira326c6602012-01-04 15:32:42 -0800461 MessageColumns.SERVER_ID,
Mindy Pereiraa1406072011-12-22 10:54:06 -0800462 MessageColumns.URI,
Mindy Pereiraa1406072011-12-22 10:54:06 -0800463 MessageColumns.CONVERSATION_ID,
464 MessageColumns.SUBJECT,
465 MessageColumns.SNIPPET,
466 MessageColumns.FROM,
467 MessageColumns.TO,
468 MessageColumns.CC,
469 MessageColumns.BCC,
470 MessageColumns.REPLY_TO,
471 MessageColumns.DATE_RECEIVED_MS,
472 MessageColumns.BODY_HTML,
473 MessageColumns.BODY_TEXT,
474 MessageColumns.EMBEDS_EXTERNAL_RESOURCES,
475 MessageColumns.REF_MESSAGE_ID,
476 MessageColumns.DRAFT_TYPE,
Mindy Pereira3ce64e72012-01-13 14:29:45 -0800477 MessageColumns.APPEND_REF_MESSAGE_CONTENT,
Mindy Pereiraf30cc092011-12-29 14:02:40 -0800478 MessageColumns.HAS_ATTACHMENTS,
Mindy Pereira326c6602012-01-04 15:32:42 -0800479 MessageColumns.ATTACHMENT_LIST_URI,
Mindy Pereiraf944e962012-01-17 11:43:36 -0800480 MessageColumns.MESSAGE_FLAGS,
Mindy Pereira7ed1c112012-01-18 10:59:25 -0800481 MessageColumns.JOINED_ATTACHMENT_INFOS,
482 MessageColumns.SAVE_MESSAGE_URI,
483 MessageColumns.SEND_MESSAGE_URI
Mindy Pereiraa1406072011-12-22 10:54:06 -0800484 };
485
Mindy Pereiraf944e962012-01-17 11:43:36 -0800486 /** Separates attachment info parts in strings in a message. */
487 public static final String MESSAGE_ATTACHMENT_INFO_SEPARATOR = "\n";
Mindy Pereiraa1406072011-12-22 10:54:06 -0800488 public static final String MESSAGE_LIST_TYPE =
489 "vnd.android.cursor.dir/vnd.com.android.mail.message";
490 public static final String MESSAGE_TYPE =
491 "vnd.android.cursor.item/vnd.com.android.mail.message";
Mindy Pereira6f92de62011-12-19 11:31:48 -0800492
Mindy Pereira6349a042012-01-04 11:25:01 -0800493 public static final int MESSAGE_ID_COLUMN = 0;
Mindy Pereira326c6602012-01-04 15:32:42 -0800494 public static final int MESSAGE_SERVER_ID_COLUMN = 1;
495 public static final int MESSAGE_URI_COLUMN = 2;
496 public static final int MESSAGE_CONVERSATION_ID_COLUMN = 3;
497 public static final int MESSAGE_SUBJECT_COLUMN = 4;
498 public static final int MESSAGE_SNIPPET_COLUMN = 5;
499 public static final int MESSAGE_FROM_COLUMN = 6;
500 public static final int MESSAGE_TO_COLUMN = 7;
501 public static final int MESSAGE_CC_COLUMN = 8;
502 public static final int MESSAGE_BCC_COLUMN = 9;
503 public static final int MESSAGE_REPLY_TO_COLUMN = 10;
504 public static final int MESSAGE_DATE_RECEIVED_MS_COLUMN = 11;
Mindy Pereira16668162012-01-11 16:11:19 -0800505 public static final int MESSAGE_BODY_HTML_COLUMN = 12;
506 public static final int MESSAGE_BODY_TEXT_COLUMN = 13;
Mindy Pereira326c6602012-01-04 15:32:42 -0800507 public static final int MESSAGE_EMBEDS_EXTERNAL_RESOURCES_COLUMN = 14;
508 public static final int MESSAGE_REF_MESSAGE_ID_COLUMN = 15;
509 public static final int MESSAGE_DRAFT_TYPE_COLUMN = 16;
Mindy Pereira3ce64e72012-01-13 14:29:45 -0800510 public static final int MESSAGE_APPEND_REF_MESSAGE_CONTENT_COLUMN = 17;
511 public static final int MESSAGE_HAS_ATTACHMENTS_COLUMN = 18;
512 public static final int MESSAGE_ATTACHMENT_LIST_URI_COLUMN = 19;
513 public static final int MESSAGE_FLAGS_COLUMN = 20;
Mindy Pereiraf944e962012-01-17 11:43:36 -0800514 public static final int MESSAGE_JOINED_ATTACHMENT_INFOS_COLUMN = 21;
Mindy Pereira7ed1c112012-01-18 10:59:25 -0800515 public static final int MESSAGE_SAVE_URI_COLUMN = 22;
516 public static final int MESSAGE_SEND_URI_COLUMN = 23;
Mindy Pereira6349a042012-01-04 11:25:01 -0800517
Mindy Pereiraf30cc092011-12-29 14:02:40 -0800518 public static final class MessageFlags {
Andy Huangdb977472012-01-11 19:53:25 -0800519 public static final int STARRED = 1 << 0;
520 public static final int UNREAD = 1 << 1;
521 public static final int REPLIED = 1 << 2;
522 public static final int FORWARDED = 1 << 3;
Mindy Pereiraf30cc092011-12-29 14:02:40 -0800523 }
524
Mindy Pereira6f92de62011-12-19 11:31:48 -0800525 public static final class MessageColumns {
Andy Huangdb977472012-01-11 19:53:25 -0800526 /**
527 * This string column contains a content provider URI that points to this single message.
528 */
Mindy Pereira6349a042012-01-04 11:25:01 -0800529 public static final String URI = "messageUri";
Andy Huangdb977472012-01-11 19:53:25 -0800530 /**
531 * This string column contains a server-assigned ID for this message.
532 */
533 public static final String SERVER_ID = "serverMessageId";
Paul Westbrook82ea6da2011-12-15 11:03:51 -0800534 public static final String CONVERSATION_ID = "conversationId";
Andy Huangdb977472012-01-11 19:53:25 -0800535 /**
536 * This string column contains the subject of a message.
537 */
Mindy Pereira6f92de62011-12-19 11:31:48 -0800538 public static final String SUBJECT = "subject";
Andy Huangdb977472012-01-11 19:53:25 -0800539 /**
540 * This string column contains a snippet of the message body.
541 */
Mindy Pereira6f92de62011-12-19 11:31:48 -0800542 public static final String SNIPPET = "snippet";
Andy Huangdb977472012-01-11 19:53:25 -0800543 /**
544 * This string column contains the single email address (and optionally name) of the sender.
545 */
Mindy Pereira6f92de62011-12-19 11:31:48 -0800546 public static final String FROM = "fromAddress";
Andy Huangdb977472012-01-11 19:53:25 -0800547 /**
548 * This string column contains a comma-delimited list of "To:" recipient email addresses.
549 */
Mindy Pereira6f92de62011-12-19 11:31:48 -0800550 public static final String TO = "toAddresses";
Andy Huangdb977472012-01-11 19:53:25 -0800551 /**
552 * This string column contains a comma-delimited list of "CC:" recipient email addresses.
553 */
Mindy Pereira6f92de62011-12-19 11:31:48 -0800554 public static final String CC = "ccAddresses";
Andy Huangdb977472012-01-11 19:53:25 -0800555 /**
556 * This string column contains a comma-delimited list of "BCC:" recipient email addresses.
557 * This value will be null for incoming messages.
558 */
Mindy Pereira6f92de62011-12-19 11:31:48 -0800559 public static final String BCC = "bccAddresses";
Andy Huangdb977472012-01-11 19:53:25 -0800560 /**
561 * This string column contains the single email address (and optionally name) of the
562 * sender's reply-to address.
563 */
Paul Westbrook82ea6da2011-12-15 11:03:51 -0800564 public static final String REPLY_TO = "replyToAddress";
Andy Huangdb977472012-01-11 19:53:25 -0800565 /**
566 * This long column contains the timestamp (in millis) of receipt of the message.
567 */
Mindy Pereira6f92de62011-12-19 11:31:48 -0800568 public static final String DATE_RECEIVED_MS = "dateReceivedMs";
Andy Huangdb977472012-01-11 19:53:25 -0800569 /**
570 * This string column contains the HTML form of the message body, if available. If not,
571 * a provider must populate BODY_TEXT.
572 */
Paul Westbrook82ea6da2011-12-15 11:03:51 -0800573 public static final String BODY_HTML = "bodyHtml";
Andy Huangdb977472012-01-11 19:53:25 -0800574 /**
575 * This string column contains the plaintext form of the message body, if HTML is not
576 * otherwise available. If HTML is available, this value should be left empty (null).
577 */
Paul Westbrook82ea6da2011-12-15 11:03:51 -0800578 public static final String BODY_TEXT = "bodyText";
Mindy Pereira6f92de62011-12-19 11:31:48 -0800579 public static final String EMBEDS_EXTERNAL_RESOURCES = "bodyEmbedsExternalResources";
Mindy Pereira3ce64e72012-01-13 14:29:45 -0800580 /**
581 * This string column contains an opaque string used by the sendMessage api.
582 */
Mindy Pereira6f92de62011-12-19 11:31:48 -0800583 public static final String REF_MESSAGE_ID = "refMessageId";
Andy Huangdb977472012-01-11 19:53:25 -0800584 /**
Andy Huang97c25be2012-01-12 15:12:09 -0800585 * This integer column contains the type of this draft, or zero (0) if this message is not a
586 * draft. See {@link DraftType} for possible values.
Andy Huangdb977472012-01-11 19:53:25 -0800587 */
Paul Westbrook82ea6da2011-12-15 11:03:51 -0800588 public static final String DRAFT_TYPE = "draftType";
Andy Huangdb977472012-01-11 19:53:25 -0800589 /**
590 * This boolean column indicates whether an outgoing message should trigger special quoted
591 * text processing upon send. The value should default to zero (0) for protocols that do
592 * not support or require this flag, and for all incoming messages.
593 */
Mindy Pereira3ce64e72012-01-13 14:29:45 -0800594 public static final String APPEND_REF_MESSAGE_CONTENT = "appendRefMessageContent";
Andy Huangdb977472012-01-11 19:53:25 -0800595 /**
596 * This boolean column indicates whether a message has attachments. The list of attachments
597 * can be retrieved using the URI in {@link MessageColumns#ATTACHMENT_LIST_URI}.
598 */
Mindy Pereiraf30cc092011-12-29 14:02:40 -0800599 public static final String HAS_ATTACHMENTS = "hasAttachments";
Andy Huangdb977472012-01-11 19:53:25 -0800600 /**
Mindy Pereira7ed1c112012-01-18 10:59:25 -0800601 * This string column contains the content provider URI for the list of
602 * attachments associated with this message.
Andy Huangdb977472012-01-11 19:53:25 -0800603 */
Mindy Pereiraf30cc092011-12-29 14:02:40 -0800604 public static final String ATTACHMENT_LIST_URI = "attachmentListUri";
Andy Huangdb977472012-01-11 19:53:25 -0800605 /**
606 * This long column is a bit field of flags defined in {@link MessageFlags}.
607 */
Andy Huang732600e2012-01-10 17:47:17 -0800608 public static final String MESSAGE_FLAGS = "messageFlags";
Mindy Pereiraf944e962012-01-17 11:43:36 -0800609 /**
610 * This string column contains a specially formatted string representing all
611 * attachments that we added to a message that is being sent or saved.
612 */
Mindy Pereira84554ec2012-01-17 14:44:44 -0800613 public static final String JOINED_ATTACHMENT_INFOS = "joinedAttachmentInfos";
Mindy Pereira7ed1c112012-01-18 10:59:25 -0800614 /**
615 * This string column contains the content provider URI for saving this
616 * message.
617 */
618 public static final String SAVE_MESSAGE_URI = "saveMessageUri";
619 /**
620 * This string column contains content provider URI for sending this
621 * message.
622 */
623 public static final String SEND_MESSAGE_URI = "sendMessageUri";
Mindy Pereira6f92de62011-12-19 11:31:48 -0800624
625 private MessageColumns() {}
626 }
Mindy Pereiraf30cc092011-12-29 14:02:40 -0800627
628 // We define a "folder" as anything that contains a list of conversations.
629 public static final String ATTACHMENT_LIST_TYPE =
630 "vnd.android.cursor.dir/vnd.com.android.mail.attachment";
631 public static final String ATTACHMENT_TYPE =
632 "vnd.android.cursor.item/vnd.com.android.mail.attachment";
633
634 public static final String[] ATTACHMENT_PROJECTION = {
635 BaseColumns._ID,
636 AttachmentColumns.NAME,
637 AttachmentColumns.SIZE,
Mindy Pereira7a07fb42012-01-11 10:32:48 -0800638 AttachmentColumns.URI,
Mindy Pereiraf30cc092011-12-29 14:02:40 -0800639 AttachmentColumns.ORIGIN_EXTRAS,
640 AttachmentColumns.CONTENT_TYPE,
641 AttachmentColumns.SYNCED
642 };
Mindy Pereira82cc5662012-01-09 17:29:30 -0800643 private static final String EMAIL_SEPARATOR_PATTERN = "\n";
Mindy Pereira7a07fb42012-01-11 10:32:48 -0800644 public static final int ATTACHMENT_ID_COLUMN = 0;
645 public static final int ATTACHMENT_NAME_COLUMN = 1;
646 public static final int ATTACHMENT_SIZE_COLUMN = 2;
647 public static final int ATTACHMENT_URI_COLUMN = 3;
Mindy Pereiraf944e962012-01-17 11:43:36 -0800648 public static final int ATTACHMENT_ORIGIN_EXTRAS_COLUMN = 4;
649 public static final int ATTACHMENT_CONTENT_TYPE_COLUMN = 5;
650 public static final int ATTACHMENT_SYNCED_COLUMN = 6;
Mindy Pereiraf30cc092011-12-29 14:02:40 -0800651
652 public static final class AttachmentColumns {
653 public static final String NAME = "name";
654 public static final String SIZE = "size";
Mindy Pereira7a07fb42012-01-11 10:32:48 -0800655 public static final String URI = "uri";
Mindy Pereiraf30cc092011-12-29 14:02:40 -0800656 public static final String ORIGIN_EXTRAS = "originExtras";
657 public static final String CONTENT_TYPE = "contentType";
658 public static final String SYNCED = "synced";
659 }
Mindy Pereira013194c2012-01-06 15:09:33 -0800660
661 public static int getMailMaxAttachmentSize(String account) {
662 // TODO: query the account to see what the max attachment size is?
663 return 5 * 1024 * 1024;
664 }
665
666 public static String getAttachmentTypeSetting() {
667 // TODO: query the account to see what kinds of attachments it supports?
668 return "com.google.android.gm.allowAddAnyAttachment";
669 }
Mindy Pereira82cc5662012-01-09 17:29:30 -0800670
671 public static void incrementRecipientsTimesContacted(Context context, String addressString) {
672 DataUsageStatUpdater statsUpdater = new DataUsageStatUpdater(context);
673 ArrayList<String> recipients = new ArrayList<String>();
674 String[] addresses = TextUtils.split(addressString, EMAIL_SEPARATOR_PATTERN);
675 for (String address : addresses) {
676 recipients.add(address);
677 }
678 statsUpdater.updateWithAddress(recipients);
679 }
Marc Blankb31ab5a2012-02-01 12:28:29 -0800680
681 public static final String[] UNDO_PROJECTION = {
682 ConversationColumns.MESSAGE_LIST_URI
683 };
684 public static final int UNDO_MESSAGE_LIST_COLUMN = 0;
Marc Blankdd10bc82012-02-01 19:10:46 -0800685
686 // Parameter used to indicate the sequence number for an undoable operation
687 public static final String SEQUENCE_QUERY_PARAMETER = "seq";
Paul Westbrook82ea6da2011-12-15 11:03:51 -0800688}