* Replaced two confusing function names
[modest] / src / modest-defs.h
1 /* Copyright (c) 2006, Nokia Corporation
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
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.
16  *
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.
28  */
29
30
31 #ifndef __MODEST_DEFS_H__
32 #define __MODEST_DEFS_H__
33
34 #include <glib/gi18n.h>
35
36 /* some interesting dirs. NOTE, they should be prefixed
37  * with $HOME; also, except MODEST_DIR itself, they
38  * need to be prefixed with MODEST_DIR;
39  * why these seperate things? well, this is for crossplatform
40  * building of dirs from their components..
41  * g_build_dir is your friend
42  */
43 #define MODEST_DIR                        ".modest"
44 #define MODEST_CACHE_DIR                  "cache"
45
46 #define MODEST_LOCAL_FOLDERS_ACCOUNT_ID   "local_folders"
47 #define MODEST_LOCAL_FOLDERS_ACCOUNT_NAME MODEST_LOCAL_FOLDERS_ACCOUNT_ID
48 #define MODEST_LOCAL_FOLDERS_MAILDIR      MODEST_LOCAL_FOLDERS_ACCOUNT_ID
49
50 #define MODEST_MMC_ACCOUNT_ID             "mcc"
51 #define MODEST_MCC_ACCOUNT_MAILDIR        "/media/mmc1/.Maildir"
52
53 /* configuration key definitions for modest */
54 #define MODEST_CONF_NAMESPACE           "/apps/modest"
55
56 /* configuration key definitions for modest */
57 #define MODEST_ACCOUNT_NAMESPACE         MODEST_CONF_NAMESPACE "/accounts"
58 #define MODEST_CONF_DEFAULT_ACCOUNT      MODEST_CONF_NAMESPACE "/default_account"
59
60 #define MODEST_CONF_REPLY_TYPE           MODEST_CONF_NAMESPACE "/reply_type"        /*  int  */
61 #define MODEST_CONF_FORWARD_TYPE         MODEST_CONF_NAMESPACE "/forward_type"      /*  int  */
62
63 #define MODEST_CONF_PREFER_FORMATTED_TEXT MODEST_CONF_NAMESPACE "/prefer_formatted_text"
64
65 #define MODEST_CONF_CONNECT_AT_STARTUP   MODEST_CONF_NAMESPACE "/connect_at_startup"      
66
67 #define MODEST_CONF_SHOW_CC              MODEST_CONF_NAMESPACE "/show_cc"           
68 #define MODEST_CONF_SHOW_BCC             MODEST_CONF_NAMESPACE "/show_bcc"           
69 #define MODEST_CONF_SHOW_TOOLBAR         MODEST_CONF_NAMESPACE "/show_toolbar"
70 #define MODEST_CONF_SHOW_TOOLBAR_FULLSCREEN         MODEST_CONF_NAMESPACE "/show_toolbar_fullscreen"
71
72 /*
73  * in the maemo case, we try to replace this
74  * with the device name
75  */
76 #define MODEST_LOCAL_FOLDERS_DEFAULT_DISPLAY_NAME  N_("Local folders")
77
78 /* the name of the device; in case of maemo this is set and updated
79  * using dbus; see modest-maemo-utils.[ch]
80  */
81 #define MODEST_CONF_DEVICE_NAME       MODEST_CONF_NAMESPACE "/device_name"
82
83
84 /* place for widget settings */
85 #define MODEST_CONF_WIDGET_NAMESPACE     MODEST_CONF_NAMESPACE "/widgets"
86 #define MODEST_CONF_FOLDER_VIEW_KEY      "folder-view"
87 #define MODEST_CONF_HEADER_VIEW_KEY      "header-view"
88 #define MODEST_CONF_MAIN_PANED_KEY       "modest-main-paned"
89 #define MODEST_CONF_MSG_PANED_KEY        "modest-msg-paned"
90 #define MODEST_CONF_FOLDER_PANED_KEY     "modest-folder-paned"
91 #define MODEST_CONF_MAIN_WINDOW_KEY      "modest-main-window"
92 #define MODEST_CONF_EDIT_WINDOW_KEY      "modest-edit-msg-window"
93 #define MODEST_CONF_MSG_VIEW_WINDOW_KEY  "modest-msg-view-window"
94
95 #define MODEST_SERVER_ACCOUNT_NAMESPACE  MODEST_CONF_NAMESPACE "/" "server_accounts"
96
97
98 /* per-account data */
99 #define MODEST_ACCOUNT_DISPLAY_NAME      "display_name"      /* string */
100 #define MODEST_ACCOUNT_STORE_ACCOUNT     "store_account"     /* string */
101 #define MODEST_ACCOUNT_TRANSPORT_ACCOUNT "transport_account" /* string */
102 #define MODEST_ACCOUNT_FULLNAME          "fullname"          /* string */
103 #define MODEST_ACCOUNT_EMAIL             "email"             /* string */
104
105 /* This is a list of strings, with each strings, 
106  * alernating between a connection name, followed by a corresponding server account name.
107  * That's not pretty, but it's nicer than dealing with escaping of a = separator if 
108  * putting them both in one string. */
109 #define MODEST_ACCOUNT_CONNECTION_SPECIFIC_SMTP_LIST "specific_smtp"
110
111 /* server account keys */
112 #define MODEST_ACCOUNT_PASSWORD          "password"          /* string */
113 #define MODEST_ACCOUNT_REMEMBER_PWD      "remember_pwd"      /* boolean */
114 #define MODEST_ACCOUNT_HOSTNAME          "hostname"          /* string */
115 #define MODEST_ACCOUNT_USERNAME          "username"          /* string */
116 #define MODEST_ACCOUNT_USE_SIGNATURE         "use_signature"         /* boolean */
117 #define MODEST_ACCOUNT_SIGNATURE         "signature"         /* string */
118 #define MODEST_ACCOUNT_URI               "uri"               /* string */
119
120 #define MODEST_ACCOUNT_PROTO             "proto"             /* string */
121 #define MODEST_ACCOUNT_ENABLED           "enabled"           /* boolean */
122 #define MODEST_ACCOUNT_TYPE              "type"              /* string */
123 #define MODEST_ACCOUNT_LAST_UPDATED      "last_updated"      /* int */
124
125 #define MODEST_ACCOUNT_LEAVE_ON_SERVER   "leave_on_server"   /* boolean */
126 #define MODEST_ACCOUNT_PREFERRED_CNX     "preferred_cnx"     /* string */
127 #define MODEST_ACCOUNT_PORT                      "port"              /* int */
128 #define MODEST_ACCOUNT_OPTIONS           "options"           /* list */
129
130 #define MODEST_ACCOUNT_AUTH_MECH         "auth_mech"         /* string */
131 #define MODEST_ACCOUNT_AUTH_MECH_VALUE_NONE "none"
132 #define MODEST_ACCOUNT_AUTH_MECH_VALUE_PASSWORD "password"
133 #define MODEST_ACCOUNT_AUTH_MECH_VALUE_CRAMMD5 "cram-md5"
134
135 #define MODEST_ACCOUNT_RETRIEVE  "retrieve"          /* string */
136 #define MODEST_ACCOUNT_RETRIEVE_VALUE_HEADERS_ONLY "headers-only"
137 #define MODEST_ACCOUNT_RETRIEVE_VALUE_MESSAGES "messages"
138 #define MODEST_ACCOUNT_RETRIEVE_VALUE_MESSAGES_AND_ATTACHMENTS "messages-and-attachments"
139
140 #define MODEST_ACCOUNT_LIMIT_RETRIEVE    "limit-retrieve"            /* int */
141
142 #define MODEST_ACCOUNT_SECURITY "security"
143 #define MODEST_ACCOUNT_SECURITY_VALUE_NONE "none"
144 #define MODEST_ACCOUNT_SECURITY_VALUE_NORMAL "normal"
145 #define MODEST_ACCOUNT_SECURITY_VALUE_SSL "ssl"
146
147
148 /* Options keys that correspond directly to camel options.
149  * These probably should not be written to user configuration, 
150  * because they are specific API implementation details. */
151 /* Keys and values used in the text items in the options GSList: */
152 #define MODEST_ACCOUNT_OPTION_SSL "use_ssl"
153 #define MODEST_ACCOUNT_OPTION_SSL_NEVER "never"
154 #define MODEST_ACCOUNT_OPTION_SSL_ALWAYS "always"
155 #define MODEST_ACCOUNT_OPTION_SSL_WHEN_POSSIBLE "when-possible"
156
157 #define MODEST_ACCOUNT_OPTION_USE_LSUB "use_lsub"
158 #define MODEST_ACCOUNT_OPTION_CHECK_ALL "check_all"
159
160 /* Macros for different text formats in mail editor */
161 #define MODEST_FILE_FORMAT_PLAIN_TEXT 0
162 #define MODEST_FILE_FORMAT_FORMATTED_TEXT 1
163
164 #endif /*__MODEST_DEFS_H__*/