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.
34 #ifndef __MODEST_TNY_FOLDER_H__
35 #define __MODEST_TNY_FOLDER_H__
37 #include <tny-folder.h>
38 #include <modest-local-folder-info.h>
43 MODEST_FOLDER_RULES_FOLDER_NON_WRITEABLE = 1 << 1,
44 MODEST_FOLDER_RULES_FOLDER_NON_DELETABLE = 1 << 2,
45 MODEST_FOLDER_RULES_FOLDER_NON_MOVEABLE = 1 << 3,
46 MODEST_FOLDER_RULES_FOLDER_NON_RENAMEABLE = 1 << 4,
47 } ModestTnyFolderRules;
49 /** Note: This is not a derived TnyFolder type. These are just convenience
50 * functions for working with a TnyFolder. tinymail does not seem to offer any
51 * easy way to cause derived TnyFolders to be instantiated.
54 /* TODO: These "const TnyFolder*" arguments will eventually need to
55 * be "TnyFolder*". C cannot support constness for complex objects like C++
56 * can, because it lacks the mutable keyword and doesn't allow both const
57 * and non-const get function overloads.
61 * modest_tny_folder_guess_type:
62 * @folder: a valid tnymail folder
64 * determine the type of the folder. first, we see if tinymail
65 * can give a specific type. if it cannot, we try to guess the
66 * type, using modest_tny_folder_guess_type_from_name
68 * Returns: the folder type, or TNY_FOLDER_TYPE_UNKNOWN
70 TnyFolderType modest_tny_folder_guess_folder_type (const TnyFolder *folder);
73 * modest_tny_folder_guess_type_from_name:
74 * @folder_name: a folder name
76 * determine the type of the folder. first, we see if tinymail
77 * can give a specific type. if it cannot, we try to guess the
78 * type, based on the name of the folder
80 * Note: this is a Class function, there does not require a tnyfolder instance
82 * Returns: the folder type, or TNY_FOLDER_TYPE_UNKNOWN
84 TnyFolderType modest_tny_folder_guess_folder_type_from_name (const gchar *folder_name);
88 * modest_tny_folder_is_remote_folder:
89 * @folder: a valid tnymail folder
91 * checks if the folder is part of the "remote" account
93 * Returns: TRUE if it's a remote folder, FALSE otherwise
96 modest_tny_folder_is_remote_folder (TnyFolder *folder);
99 * modest_tny_folder_is_local_folder:
100 * @folder: a valid tnymail folder
102 * checks if the folder is part of the "local folders" pseudo-account
104 * Returns: TRUE if it's a local folder, FALSE otherwise
106 gboolean modest_tny_folder_is_local_folder (TnyFolder *folder);
109 * modest_tny_folder_is_memory_card_folder:
110 * @folder: a valid tnymail folder
112 * checks if the folder is part of the memory card account.
114 * Returns: TRUE if it's a memory card folder, FALSE otherwise
117 modest_tny_folder_is_memory_card_folder (TnyFolder *folder);
120 * modest_tny_folder_get_local_folder_type:
121 * @folder: a valid tnymail folder
123 * checks if the folder is part of the "local folders" pseudo-account
125 * Returns: TRUE if it's a local folder, FALSE otherwise
127 TnyFolderType modest_tny_folder_get_local_or_mmc_folder_type (TnyFolder *folder);
131 * modest_tny_folder_get_rules:
132 * @folder: a valid tnymail folder
134 * get the rules for this folder; can messages be put in it,
135 * can the folder be deleted, etc.
137 * Returns: the ModestTnyFolderRules rules (bitwise-OR) for this
140 ModestTnyFolderRules modest_tny_folder_get_rules (TnyFolder *folder);
143 * modest_tny_folder_is_outbox_for_account:
144 * @folder: a valid tnymail folder
146 * Discover whether this folder is the per-account outbox for the specified
149 * Returns: TRUE if this folder is the per-account outbox for the account.
151 gboolean modest_tny_folder_is_outbox_for_account (TnyFolder *folder,
152 TnyAccount *account);
155 * modest_tny_folder_get_account:
158 * Get the parent account of the folder or, for TnyMergeFolder
159 * instances, get the local-folders account.
161 * Returns: the account. You should call g_object_unref() on this.
163 TnyAccount *modest_tny_folder_get_account (TnyFolder *folder);
166 * modest_tny_msg_get_header_unique_id:
167 * @header: a #TnyHeader
169 * This function returns a unique id for a message summary from
170 * a TnyHeader retrieved with tny_folder_get_headers. You can not use
171 * the TnyHeader returned by tny_msg_get_header because it has no uid.
173 * This uid is built from the folder URL string and the header uid,
174 * the caller of the function must free the unique id when no longer
177 * Returns: a unique identificator for a header object
179 gchar* modest_tny_folder_get_header_unique_id (TnyHeader *header);
183 #endif /* __MODEST_TNY_FOLDER_H__*/