Mindy Pereira | 6f92de6 | 2011-12-19 11:31:48 -0800 | [diff] [blame] | 1 | /** |
| 2 | * Copyright (c) 2011, Google Inc. |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package com.android.email.providers; |
| 18 | |
Mindy Pereira | 6f92de6 | 2011-12-19 11:31:48 -0800 | [diff] [blame] | 19 | import android.provider.BaseColumns; |
| 20 | |
Paul Westbrook | 82ea6da | 2011-12-15 11:03:51 -0800 | [diff] [blame] | 21 | import java.lang.String; |
| 22 | |
Mindy Pereira | 6f92de6 | 2011-12-19 11:31:48 -0800 | [diff] [blame] | 23 | |
| 24 | public class UIProvider { |
Paul Westbrook | 82ea6da | 2011-12-15 11:03:51 -0800 | [diff] [blame] | 25 | // The actual content provider should define its own authority |
| 26 | //public static final String AUTHORITY = "com.android.email.providers"; |
Mindy Pereira | 6f92de6 | 2011-12-19 11:31:48 -0800 | [diff] [blame] | 27 | |
| 28 | public static final String ACCOUNT_LIST_TYPE = |
Paul Westbrook | 82ea6da | 2011-12-15 11:03:51 -0800 | [diff] [blame] | 29 | "vnd.android.cursor.dir/vnd.com.android.mail.account"; |
Mindy Pereira | 6f92de6 | 2011-12-19 11:31:48 -0800 | [diff] [blame] | 30 | public static final String ACCOUNT_TYPE = |
Paul Westbrook | 82ea6da | 2011-12-15 11:03:51 -0800 | [diff] [blame] | 31 | "vnd.android.cursor.item/vnd.com.android.mail.account"; |
Mindy Pereira | 6f92de6 | 2011-12-19 11:31:48 -0800 | [diff] [blame] | 32 | |
| 33 | public static final String[] ACCOUNTS_PROJECTION = { |
| 34 | BaseColumns._ID, |
| 35 | AccountColumns.NAME, |
| 36 | AccountColumns.PROVIDER_VERSION, |
| 37 | AccountColumns.URI, |
| 38 | AccountColumns.CAPABILITIES, |
| 39 | AccountColumns.FOLDER_LIST_URI, |
| 40 | AccountColumns.SEARCH_URI, |
| 41 | AccountColumns.ACCOUNT_FROM_ADDRESSES_URI, |
Paul Westbrook | 82ea6da | 2011-12-15 11:03:51 -0800 | [diff] [blame] | 42 | AccountColumns.SAVE_NEW_DRAFT_URI, |
Mindy Pereira | 3a565bf | 2011-12-21 11:26:21 -0800 | [diff] [blame] | 43 | AccountColumns.SEND_MESSAGE_URI |
Mindy Pereira | 6f92de6 | 2011-12-19 11:31:48 -0800 | [diff] [blame] | 44 | }; |
| 45 | |
| 46 | public static final class AccountCapabilities { |
Paul Westbrook | 82ea6da | 2011-12-15 11:03:51 -0800 | [diff] [blame] | 47 | public static final int SYNCABLE_FOLDERS = 0x0001; |
| 48 | public static final int REPORT_SPAM = 0x0002; |
| 49 | public static final int ARCHIVE = 0x0004; |
| 50 | public static final int MUTE = 0x0008; |
| 51 | public static final int SERVER_SEARCH = 0x0010; |
| 52 | public static final int FOLDER_SERVER_SEARCH = 0x0020; |
| 53 | public static final int SANITIZED_HTML = 0x0040; |
| 54 | public static final int DRAFT_SYNCHRONIZATION = 0x0080; |
| 55 | public static final int MULTIPLE_FROM_ADDRESSES = 0x0100; |
| 56 | public static final int SMART_REPLY = 0x0200; |
| 57 | public static final int LOCAL_SEARCH = 0x0400; |
| 58 | public static final int THREADED_CONVERSATIONS = 0x0800; |
Mindy Pereira | 6f92de6 | 2011-12-19 11:31:48 -0800 | [diff] [blame] | 59 | } |
| 60 | |
| 61 | public static final class AccountColumns { |
Paul Westbrook | 82ea6da | 2011-12-15 11:03:51 -0800 | [diff] [blame] | 62 | /** |
| 63 | * This string column contains the human visible name for the account. |
| 64 | */ |
Mindy Pereira | 6f92de6 | 2011-12-19 11:31:48 -0800 | [diff] [blame] | 65 | public static final String NAME = "name"; |
Paul Westbrook | 82ea6da | 2011-12-15 11:03:51 -0800 | [diff] [blame] | 66 | |
| 67 | /** |
| 68 | * This integer column returns the version of the UI provider schema from which this |
| 69 | * account provider will return results. |
| 70 | */ |
Mindy Pereira | 6f92de6 | 2011-12-19 11:31:48 -0800 | [diff] [blame] | 71 | public static final String PROVIDER_VERSION = "providerVersion"; |
Paul Westbrook | 82ea6da | 2011-12-15 11:03:51 -0800 | [diff] [blame] | 72 | |
| 73 | /** |
| 74 | * This string column contains the uri to directly access the information for this account. |
| 75 | */ |
Mindy Pereira | 6f92de6 | 2011-12-19 11:31:48 -0800 | [diff] [blame] | 76 | public static final String URI = "uri"; |
Paul Westbrook | 82ea6da | 2011-12-15 11:03:51 -0800 | [diff] [blame] | 77 | |
| 78 | /** |
| 79 | * This integer column contains a bit field of the possible cabibilities that this account |
| 80 | * supports. |
| 81 | */ |
Mindy Pereira | 6f92de6 | 2011-12-19 11:31:48 -0800 | [diff] [blame] | 82 | public static final String CAPABILITIES = "capabilities"; |
Paul Westbrook | 82ea6da | 2011-12-15 11:03:51 -0800 | [diff] [blame] | 83 | |
| 84 | /** |
Mindy Pereira | 750cc73 | 2011-12-21 13:32:29 -0800 | [diff] [blame] | 85 | * This string column contains the content provider uri to return the |
| 86 | * list of top level folders for this account. |
Paul Westbrook | 82ea6da | 2011-12-15 11:03:51 -0800 | [diff] [blame] | 87 | */ |
Mindy Pereira | 6f92de6 | 2011-12-19 11:31:48 -0800 | [diff] [blame] | 88 | public static final String FOLDER_LIST_URI = "folderListUri"; |
Paul Westbrook | 82ea6da | 2011-12-15 11:03:51 -0800 | [diff] [blame] | 89 | |
| 90 | /** |
| 91 | * This string column contains the content provider uri that can be queried for search |
| 92 | * results. |
| 93 | */ |
Mindy Pereira | 6f92de6 | 2011-12-19 11:31:48 -0800 | [diff] [blame] | 94 | public static final String SEARCH_URI = "searchUri"; |
Paul Westbrook | 82ea6da | 2011-12-15 11:03:51 -0800 | [diff] [blame] | 95 | |
| 96 | /** |
| 97 | * This string column contains the content provider uri that can be queried to access the |
| 98 | * from addresses for this account. |
| 99 | */ |
Mindy Pereira | 6f92de6 | 2011-12-19 11:31:48 -0800 | [diff] [blame] | 100 | public static final String ACCOUNT_FROM_ADDRESSES_URI = "accountFromAddressesUri"; |
Paul Westbrook | 82ea6da | 2011-12-15 11:03:51 -0800 | [diff] [blame] | 101 | |
| 102 | /** |
| 103 | * This string column contains the content provider uri that can be used to save (insert) |
| 104 | * new draft messages for this account. |
| 105 | */ |
Mindy Pereira | 6f92de6 | 2011-12-19 11:31:48 -0800 | [diff] [blame] | 106 | public static final String SAVE_NEW_DRAFT_URI = "saveNewDraftUri"; |
| 107 | |
Paul Westbrook | 82ea6da | 2011-12-15 11:03:51 -0800 | [diff] [blame] | 108 | /** |
| 109 | * This string column contains the content provider uri that can be used to send |
| 110 | * a message for this account. |
| 111 | * NOTE: This might be better to be an update operation on the messageUri. |
| 112 | */ |
| 113 | public static final String SEND_MESSAGE_URI = "sendMessageUri"; |
Mindy Pereira | 3a565bf | 2011-12-21 11:26:21 -0800 | [diff] [blame] | 114 | } |
Paul Westbrook | 82ea6da | 2011-12-15 11:03:51 -0800 | [diff] [blame] | 115 | |
Mindy Pereira | 3a565bf | 2011-12-21 11:26:21 -0800 | [diff] [blame] | 116 | // We define a "folder" as anything that contains a list of conversations. |
| 117 | public static final String FOLDER_LIST_TYPE = |
| 118 | "vnd.android.cursor.dir/vnd.com.android.mail.folder"; |
| 119 | public static final String FOLDER_TYPE = |
Mindy Pereira | 750cc73 | 2011-12-21 13:32:29 -0800 | [diff] [blame] | 120 | "vnd.android.cursor.item/vnd.com.android.mail.folder"; |
Mindy Pereira | 3a565bf | 2011-12-21 11:26:21 -0800 | [diff] [blame] | 121 | |
| 122 | public static final String[] FOLDERS_PROJECTION = { |
| 123 | BaseColumns._ID, |
| 124 | FolderColumns.NAME, |
Mindy Pereira | 750cc73 | 2011-12-21 13:32:29 -0800 | [diff] [blame] | 125 | FolderColumns.HAS_CHILDREN, |
Mindy Pereira | 0973b20 | 2011-12-21 15:48:12 -0800 | [diff] [blame] | 126 | FolderColumns.CAPABILITIES, |
| 127 | FolderColumns.SYNC_FREQUENCY, |
| 128 | FolderColumns.SYNC_WINDOW, |
Mindy Pereira | 750cc73 | 2011-12-21 13:32:29 -0800 | [diff] [blame] | 129 | FolderColumns.CONVERSATION_LIST_URI, |
| 130 | FolderColumns.CHILD_FOLDERS_LIST_URI |
Mindy Pereira | 3a565bf | 2011-12-21 11:26:21 -0800 | [diff] [blame] | 131 | }; |
| 132 | |
Mindy Pereira | 0973b20 | 2011-12-21 15:48:12 -0800 | [diff] [blame] | 133 | public static final class FolderCapabilities { |
| 134 | public static final int SYNCABLE = 0x0001; |
| 135 | public static final int PARENT = 0x0002; |
| 136 | public static final int CAN_HOLD_MAIL = 0x0004; |
| 137 | public static final int CAN_ACCEPT_MOVED_MESSAGES = 0x0008; |
| 138 | } |
| 139 | |
Mindy Pereira | 3a565bf | 2011-12-21 11:26:21 -0800 | [diff] [blame] | 140 | public static final class FolderColumns { |
| 141 | /** |
| 142 | * This string column contains the human visible name for the folder. |
| 143 | */ |
| 144 | public static final String NAME = "name"; |
| 145 | /** |
Mindy Pereira | 0973b20 | 2011-12-21 15:48:12 -0800 | [diff] [blame] | 146 | * This int column represents the capabilities of the folder specified by |
| 147 | * FolderCapabilities flags. |
| 148 | */ |
| 149 | public static String CAPABILITIES = "capabilities"; |
| 150 | /** |
Mindy Pereira | 750cc73 | 2011-12-21 13:32:29 -0800 | [diff] [blame] | 151 | * This boolean column represents whether or not this folder has any |
| 152 | * child folders. |
| 153 | */ |
| 154 | public static String HAS_CHILDREN = "hasChildren"; |
| 155 | /** |
Mindy Pereira | 0973b20 | 2011-12-21 15:48:12 -0800 | [diff] [blame] | 156 | * This int column represents how often the folder should be synced. |
| 157 | */ |
| 158 | public static String SYNC_FREQUENCY = "syncFrequency"; |
| 159 | /** |
| 160 | * This int column represents how large the sync window is. |
| 161 | */ |
| 162 | public static String SYNC_WINDOW = "syncWindow"; |
| 163 | /** |
Mindy Pereira | 750cc73 | 2011-12-21 13:32:29 -0800 | [diff] [blame] | 164 | * This string column contains the content provider uri to return the |
| 165 | * list of conversations for this folder. |
Mindy Pereira | 3a565bf | 2011-12-21 11:26:21 -0800 | [diff] [blame] | 166 | */ |
| 167 | public static final String CONVERSATION_LIST_URI = "conversationListUri"; |
Mindy Pereira | 750cc73 | 2011-12-21 13:32:29 -0800 | [diff] [blame] | 168 | /** |
| 169 | * This string column contains the content provider uri to return the |
| 170 | * list of child folders of this folder. |
| 171 | */ |
| 172 | public static String CHILD_FOLDERS_LIST_URI = "childFoldersListUri"; |
Mindy Pereira | 3a565bf | 2011-12-21 11:26:21 -0800 | [diff] [blame] | 173 | |
| 174 | public FolderColumns() {}; |
Mindy Pereira | 6f92de6 | 2011-12-19 11:31:48 -0800 | [diff] [blame] | 175 | } |
| 176 | |
Mindy Pereira | a140607 | 2011-12-22 10:54:06 -0800 | [diff] [blame] | 177 | // We define a "folder" as anything that contains a list of conversations. |
| 178 | public static final String CONVERSATION_LIST_TYPE = |
| 179 | "vnd.android.cursor.dir/vnd.com.android.mail.conversation"; |
| 180 | public static final String CONVERSATION_TYPE = |
| 181 | "vnd.android.cursor.item/vnd.com.android.mail.conversation"; |
| 182 | |
| 183 | public static final String[] CONVERSATION_PROJECTION = { |
| 184 | BaseColumns._ID, |
| 185 | ConversationColumns.SUBJECT, |
| 186 | ConversationColumns.MESSAGE_LIST_URI |
| 187 | }; |
| 188 | |
| 189 | public static final class ConversationColumns { |
| 190 | /** |
Mindy Pereira | a140607 | 2011-12-22 10:54:06 -0800 | [diff] [blame] | 191 | * This string column contains the content provider uri to return the |
| 192 | * list of messages for this conversation. |
| 193 | */ |
| 194 | public static final String MESSAGE_LIST_URI = "messageListUri"; |
Mindy Pereira | 27a0cf0 | 2011-12-22 13:16:32 -0800 | [diff] [blame^] | 195 | /** |
| 196 | * This string column contains the subject string for a conversation. |
| 197 | */ |
| 198 | public static final String SUBJECT = "subject"; |
| 199 | /** |
| 200 | * This string column contains the snippet string for a conversation. |
| 201 | */ |
| 202 | public static final String SNIPPET = "snippet"; |
| 203 | /** |
| 204 | * This string column contains the sender info string for a |
| 205 | * conversation. |
| 206 | */ |
| 207 | public static final String SENDER_INFO = "senderInfo"; |
| 208 | /** |
| 209 | * This long column contains the time in ms of the latest update to a |
| 210 | * conversation. |
| 211 | */ |
| 212 | public static final String DATE_RECEIVED_MS = "dateReceivedMs"; |
| 213 | |
| 214 | public ConversationColumns() { |
| 215 | }; |
Mindy Pereira | a140607 | 2011-12-22 10:54:06 -0800 | [diff] [blame] | 216 | } |
| 217 | |
Mindy Pereira | 6f92de6 | 2011-12-19 11:31:48 -0800 | [diff] [blame] | 218 | /** |
| 219 | * Returns a uri that, when queried, will return a cursor with a list of information for the |
| 220 | * list of configured accounts. |
| 221 | * @return |
| 222 | */ |
Paul Westbrook | 82ea6da | 2011-12-15 11:03:51 -0800 | [diff] [blame] | 223 | // TODO: create a static registry for the starting point for the UI provider. |
| 224 | // public static Uri getAccountsUri() { |
| 225 | // return Uri.parse(BASE_URI_STRING + "/"); |
| 226 | // } |
| 227 | |
| 228 | public static final class DraftType { |
| 229 | public static final String COMPOSE = "compose"; |
| 230 | public static final String REPLY = "reply"; |
| 231 | public static final String REPLY_ALL = "replyAll"; |
| 232 | public static final String FORWARD = "forward"; |
| 233 | |
| 234 | private DraftType() {} |
Mindy Pereira | 6f92de6 | 2011-12-19 11:31:48 -0800 | [diff] [blame] | 235 | } |
| 236 | |
Mindy Pereira | a140607 | 2011-12-22 10:54:06 -0800 | [diff] [blame] | 237 | public static final String[] MESSAGE_PROJECTION = { |
| 238 | BaseColumns._ID, |
| 239 | MessageColumns.URI, |
| 240 | MessageColumns.MESSAGE_ID, |
| 241 | MessageColumns.CONVERSATION_ID, |
| 242 | MessageColumns.SUBJECT, |
| 243 | MessageColumns.SNIPPET, |
| 244 | MessageColumns.FROM, |
| 245 | MessageColumns.TO, |
| 246 | MessageColumns.CC, |
| 247 | MessageColumns.BCC, |
| 248 | MessageColumns.REPLY_TO, |
| 249 | MessageColumns.DATE_RECEIVED_MS, |
| 250 | MessageColumns.BODY_HTML, |
| 251 | MessageColumns.BODY_TEXT, |
| 252 | MessageColumns.EMBEDS_EXTERNAL_RESOURCES, |
| 253 | MessageColumns.REF_MESSAGE_ID, |
| 254 | MessageColumns.DRAFT_TYPE, |
| 255 | MessageColumns.INCLUDE_QUOTED_TEXT, |
| 256 | MessageColumns.QUOTE_START_POS, |
| 257 | MessageColumns.CLIENT_CREATED, |
| 258 | MessageColumns.CUSTOM_FROM_ADDRESS |
| 259 | }; |
| 260 | |
| 261 | // We define a "folder" as anything that contains a list of conversations. |
| 262 | public static final String MESSAGE_LIST_TYPE = |
| 263 | "vnd.android.cursor.dir/vnd.com.android.mail.message"; |
| 264 | public static final String MESSAGE_TYPE = |
| 265 | "vnd.android.cursor.item/vnd.com.android.mail.message"; |
Mindy Pereira | 6f92de6 | 2011-12-19 11:31:48 -0800 | [diff] [blame] | 266 | |
| 267 | public static final class MessageColumns { |
| 268 | public static final String ID = "_id"; |
| 269 | public static final String URI = "uri"; |
| 270 | public static final String MESSAGE_ID = "messageId"; |
Paul Westbrook | 82ea6da | 2011-12-15 11:03:51 -0800 | [diff] [blame] | 271 | public static final String CONVERSATION_ID = "conversationId"; |
Mindy Pereira | 6f92de6 | 2011-12-19 11:31:48 -0800 | [diff] [blame] | 272 | public static final String SUBJECT = "subject"; |
| 273 | public static final String SNIPPET = "snippet"; |
| 274 | public static final String FROM = "fromAddress"; |
| 275 | public static final String TO = "toAddresses"; |
| 276 | public static final String CC = "ccAddresses"; |
| 277 | public static final String BCC = "bccAddresses"; |
Paul Westbrook | 82ea6da | 2011-12-15 11:03:51 -0800 | [diff] [blame] | 278 | public static final String REPLY_TO = "replyToAddress"; |
Mindy Pereira | 6f92de6 | 2011-12-19 11:31:48 -0800 | [diff] [blame] | 279 | public static final String DATE_RECEIVED_MS = "dateReceivedMs"; |
Paul Westbrook | 82ea6da | 2011-12-15 11:03:51 -0800 | [diff] [blame] | 280 | public static final String BODY_HTML = "bodyHtml"; |
| 281 | public static final String BODY_TEXT = "bodyText"; |
Mindy Pereira | 6f92de6 | 2011-12-19 11:31:48 -0800 | [diff] [blame] | 282 | public static final String EMBEDS_EXTERNAL_RESOURCES = "bodyEmbedsExternalResources"; |
| 283 | public static final String REF_MESSAGE_ID = "refMessageId"; |
Paul Westbrook | 82ea6da | 2011-12-15 11:03:51 -0800 | [diff] [blame] | 284 | public static final String DRAFT_TYPE = "draftType"; |
Mindy Pereira | 6f92de6 | 2011-12-19 11:31:48 -0800 | [diff] [blame] | 285 | public static final String INCLUDE_QUOTED_TEXT = "includeQuotedText"; |
| 286 | public static final String QUOTE_START_POS = "quoteStartPos"; |
| 287 | public static final String CLIENT_CREATED = "clientCreated"; |
| 288 | public static final String CUSTOM_FROM_ADDRESS = "customFromAddress"; |
| 289 | |
| 290 | // TODO: Add attachments, flags |
| 291 | |
| 292 | private MessageColumns() {} |
| 293 | } |
Paul Westbrook | 82ea6da | 2011-12-15 11:03:51 -0800 | [diff] [blame] | 294 | } |