1 /* Copyright (c) 2006, Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
8 * * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * * Neither the name of the Nokia Corporation nor the names of its
14 * contributors may be used to endorse or promote products derived from
15 * this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
18 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
20 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
21 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 #ifndef __MODEST_DEFS_H__
32 #define __MODEST_DEFS_H__
35 #include <glib/gi18n.h>
37 /* Some interesting directories. NOTE, they should be prefixed
38 * with $HOME; Also, except for MODEST_DIR itself, they
39 * need to be prefixed with MODEST_DIR;
40 * The parts of the path are separate for crossplatform
41 * building of dirs from their components.
42 * g_build_dir is your friend
44 #define MODEST_DIR ".modest"
45 #define MODEST_CACHE_DIR "cache"
47 #define MODEST_LOCAL_FOLDERS_ACCOUNT_ID "local_folders"
48 #define MODEST_LOCAL_FOLDERS_ACCOUNT_NAME MODEST_LOCAL_FOLDERS_ACCOUNT_ID
50 /** Sent, Drafts, etc, are on-disk
51 * but not outbox, because outbox is a virtual folder merged from the
52 * various outboxes/<account-name>/outbox folders.
54 #define MODEST_LOCAL_FOLDERS_MAILDIR MODEST_LOCAL_FOLDERS_ACCOUNT_ID
56 /** There is an outboxes/<account-name>/outbox/ folder for each account,
57 * though we merge them so that the user sees only one outbox.
59 #define MODEST_PER_ACCOUNT_LOCAL_OUTBOX_FOLDER_ACCOUNT_ID_PREFIX "outboxes"
60 #define MODEST_PER_ACCOUNT_LOCAL_OUTBOX_FOLDERS_MAILDIR MODEST_PER_ACCOUNT_LOCAL_OUTBOX_FOLDER_ACCOUNT_ID_PREFIX
62 #define MODEST_MMC_ACCOUNT_ID "mcc"
64 /* FIXME: get these from the environment */
65 /* Without the trailing / because gnome-vfs reports mounted
66 * volume URIs without the trailing, and we want to match them: */
67 #define MODEST_MCC1_VOLUMEPATH "/media/mmc1"
68 #define MODEST_MCC1_VOLUMEPATH_URI "file://" MODEST_MCC1_VOLUMEPATH
70 /* configuration key definitions for modest */
71 #define MODEST_CONF_NAMESPACE "/apps/modest"
73 /* the mapping files, there are two possibilities; used in modest_maemo_open_mcc_mapping_file */
74 #define MODEST_MCC_MAPPING PREFIX "/share/modest/provider-data/mcc_mapping"
75 #define MODEST_OPERATOR_WIZARD_MCC_MAPPING "/usr/share/operator-wizard/mcc_mapping"
77 #define MODEST_PROVIDER_DATA_FILE PREFIX "/share/modest/provider-data/modest-provider-data.keyfile"
78 #define MODEST_MAEMO_PROVIDER_DATA_FILE PREFIX "/share/modest/provider-data/maemo-provider-data.keyfile"
80 /* configuration key definitions for modest */
81 #define MODEST_ACCOUNT_NAMESPACE MODEST_CONF_NAMESPACE "/accounts"
82 #define MODEST_CONF_DEFAULT_ACCOUNT MODEST_CONF_NAMESPACE "/default_account"
84 /* Not used: #define MODEST_CONF_CONNECT_AT_STARTUP MODEST_CONF_NAMESPACE "/connect_at_startup" */
86 #define MODEST_CONF_SHOW_CC MODEST_CONF_NAMESPACE "/show_cc"
87 #define MODEST_CONF_SHOW_BCC MODEST_CONF_NAMESPACE "/show_bcc"
89 /* This is the alarmd cookie, obtained from alarm_event_add(),
90 * which apparently remains valid between application instances.
91 * We store it so that we can remove it later.
93 #define MODEST_CONF_ALARM_ID MODEST_CONF_NAMESPACE "/alarm_id"
96 * in the maemo case, we try to replace this
97 * with the device name
99 #define MODEST_LOCAL_FOLDERS_DEFAULT_DISPLAY_NAME N_("Local folders")
101 /* the name of the device; in case of maemo this is set and updated
102 * using dbus; see modest-maemo-utils.[ch]
104 #define MODEST_CONF_DEVICE_NAME MODEST_CONF_NAMESPACE "/device_name"
107 /* place for widget settings */
108 #define MODEST_CONF_WIDGET_NAMESPACE MODEST_CONF_NAMESPACE "/widgets"
109 #define MODEST_CONF_FOLDER_VIEW_KEY "folder-view"
110 #define MODEST_CONF_HEADER_VIEW_KEY "header-view"
111 #define MODEST_CONF_MAIN_PANED_KEY "modest-main-paned"
112 #define MODEST_CONF_MSG_PANED_KEY "modest-msg-paned"
113 #define MODEST_CONF_FOLDER_PANED_KEY "modest-folder-paned"
114 #define MODEST_CONF_MAIN_WINDOW_KEY "modest-main-window"
115 #define MODEST_CONF_EDIT_WINDOW_KEY "modest-edit-msg-window"
116 #define MODEST_CONF_MSG_VIEW_WINDOW_KEY "modest-msg-view-window"
118 #define MODEST_SERVER_ACCOUNT_NAMESPACE MODEST_CONF_NAMESPACE "/" "server_accounts"
120 /* show toolbar settings */
121 #define MODEST_CONF_MAIN_WINDOW_SHOW_TOOLBAR MODEST_CONF_WIDGET_NAMESPACE "/" MODEST_CONF_MAIN_WINDOW_KEY "/show_toolbar"
122 #define MODEST_CONF_EDIT_WINDOW_SHOW_TOOLBAR MODEST_CONF_WIDGET_NAMESPACE "/" MODEST_CONF_EDIT_WINDOW_KEY "/show_toolbar"
123 #define MODEST_CONF_MSG_VIEW_WINDOW_SHOW_TOOLBAR MODEST_CONF_WIDGET_NAMESPACE "/" MODEST_CONF_MSG_VIEW_WINDOW_KEY "/show_toolbar"
124 #define MODEST_CONF_MAIN_WINDOW_SHOW_TOOLBAR_FULLSCREEN MODEST_CONF_WIDGET_NAMESPACE "/" MODEST_CONF_MAIN_WINDOW_KEY "/show_toolbar_fullscreen"
125 #define MODEST_CONF_EDIT_WINDOW_SHOW_TOOLBAR_FULLSCREEN MODEST_CONF_WIDGET_NAMESPACE "/" MODEST_CONF_EDIT_WINDOW_KEY "/show_toolbar_fullscreen"
126 #define MODEST_CONF_MSG_VIEW_WINDOW_SHOW_TOOLBAR_FULLSCREEN MODEST_CONF_WIDGET_NAMESPACE "/" MODEST_CONF_MSG_VIEW_WINDOW_KEY "/show_toolbar_fullscreen"
128 /* per-account data */
129 #define MODEST_ACCOUNT_DISPLAY_NAME "display_name" /* string */
130 #define MODEST_ACCOUNT_STORE_ACCOUNT "store_account" /* string */
131 #define MODEST_ACCOUNT_TRANSPORT_ACCOUNT "transport_account" /* string */
132 #define MODEST_ACCOUNT_FULLNAME "fullname" /* string */
133 #define MODEST_ACCOUNT_EMAIL "email" /* string */
135 /* This is a list of strings, with each strings,
136 * alernating between a connection name, followed by a corresponding server account name.
137 * That's not pretty, but it's nicer than dealing with escaping of a = separator if
138 * putting them both in one string. */
139 #define MODEST_CONF_CONNECTION_SPECIFIC_SMTP_LIST MODEST_CONF_NAMESPACE "/specific_smtp" /* one list used for all accounts. */
140 #define MODEST_ACCOUNT_USE_CONNECTION_SPECIFIC_SMTP "use_specific_smtp" /* boolean */
142 /* server account keys */
143 #define MODEST_ACCOUNT_PASSWORD "password" /* string */
144 #define MODEST_ACCOUNT_REMEMBER_PWD "remember_pwd" /* boolean */
145 #define MODEST_ACCOUNT_HOSTNAME "hostname" /* string */
146 #define MODEST_ACCOUNT_USERNAME "username" /* string */
147 #define MODEST_ACCOUNT_USERNAME_HAS_SUCCEEDED "username_succeeded" /* string */
148 #define MODEST_ACCOUNT_USE_SIGNATURE "use_signature" /* boolean */
149 #define MODEST_ACCOUNT_SIGNATURE "signature" /* string */
151 /* Only used for mbox and maildir accounts: */
152 #define MODEST_ACCOUNT_URI "uri" /* string */
154 #define MODEST_ACCOUNT_PROTO "proto" /* string */
155 #define MODEST_ACCOUNT_ENABLED "enabled" /* boolean */
156 #define MODEST_ACCOUNT_TYPE "type" /* string */
157 #define MODEST_ACCOUNT_LAST_UPDATED "last_updated" /* int */
159 #define MODEST_ACCOUNT_LEAVE_ON_SERVER "leave_on_server" /* boolean */
160 #define MODEST_ACCOUNT_PREFERRED_CNX "preferred_cnx" /* string */
161 #define MODEST_ACCOUNT_PORT "port" /* int */
163 #define MODEST_ACCOUNT_AUTH_MECH "auth_mech" /* string */
164 #define MODEST_ACCOUNT_AUTH_MECH_VALUE_NONE "none"
165 #define MODEST_ACCOUNT_AUTH_MECH_VALUE_PASSWORD "password"
166 #define MODEST_ACCOUNT_AUTH_MECH_VALUE_CRAMMD5 "cram-md5"
168 #define MODEST_ACCOUNT_RETRIEVE "retrieve" /* string */
169 #define MODEST_ACCOUNT_RETRIEVE_VALUE_HEADERS_ONLY "headers-only"
170 #define MODEST_ACCOUNT_RETRIEVE_VALUE_MESSAGES "messages"
171 #define MODEST_ACCOUNT_RETRIEVE_VALUE_MESSAGES_AND_ATTACHMENTS "messages-and-attachments"
173 #define MODEST_ACCOUNT_LIMIT_RETRIEVE "limit-retrieve" /* int */
175 #define MODEST_ACCOUNT_SECURITY "security"
176 #define MODEST_ACCOUNT_SECURITY_VALUE_NONE "none"
177 #define MODEST_ACCOUNT_SECURITY_VALUE_NORMAL "normal" /* Meaning "Normal (TLS)", as in our UI spec. */
178 #define MODEST_ACCOUNT_SECURITY_VALUE_SSL "ssl"
180 /* Macros for different text formats in mail editor */
181 #define MODEST_FILE_FORMAT_PLAIN_TEXT 0
182 #define MODEST_FILE_FORMAT_FORMATTED_TEXT 1
184 /* Global settings */
185 #define MODEST_CONF_AUTO_UPDATE MODEST_CONF_NAMESPACE "/auto_update" /* bool */
186 #define MODEST_CONF_UPDATE_WHEN_CONNECTED_BY MODEST_CONF_NAMESPACE "/update_when_connected_by" /* int */
187 #define MODEST_CONF_UPDATE_INTERVAL MODEST_CONF_NAMESPACE "/update_interval" /* int */
188 #define MODEST_CONF_MSG_SIZE_LIMIT MODEST_CONF_NAMESPACE "/msg_size_limit" /* int */
189 #define MODEST_CONF_PLAY_SOUND_MSG_ARRIVE MODEST_CONF_NAMESPACE "/play_sound_msg_arrive" /* bool */
190 #define MODEST_CONF_PREFER_FORMATTED_TEXT MODEST_CONF_NAMESPACE "/prefer_formatted_text" /* bool */
191 #define MODEST_CONF_REPLY_TYPE MODEST_CONF_NAMESPACE "/reply_type" /* int */
192 #define MODEST_CONF_FORWARD_TYPE MODEST_CONF_NAMESPACE "/forward_type" /* int */
194 /* Notification ids */
195 #define MODEST_CONF_NOTIFICATION_IDS MODEST_CONF_NAMESPACE "/notification_ids" /* list of ints */
198 #define MODEST_EXAMPLE_EMAIL_ADDRESS "first.last@example.com"
200 #endif /*__MODEST_DEFS_H__*/