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_READ_ONLY = 0 << 1,
44 MODEST_FOLDER_RULES_FOLDER_DELETABLE
45 } ModestTnyFolderRules;
48 * modest_tny_folder_guess_type:
49 * @folder: a valid tnymail folder
51 * determine the type of the folder. first, we see if tinymail
52 * can give a specific type. if it cannot, we try to guess the
53 * type, using modest_tny_folder_guess_type_from_name
55 * Returns: the folder type, or TNY_FOLDER_TYPE_UNKNOWN
57 TnyFolderType modest_tny_folder_guess_folder_type (const TnyFolder *folder);
60 * modest_tny_folder_guess_type_from_name:
61 * @folder_name: a folder name
63 * determine the type of the folder. first, we see if tinymail
64 * can give a specific type. if it cannot, we try to guess the
65 * type, based on the name of the folder
67 * Note: this is a Class function, there does not require a tnyfolder instance
69 * Returns: the folder type, or TNY_FOLDER_TYPE_UNKNOWN
71 TnyFolderType modest_tny_folder_guess_folder_type_from_name (const gchar *folder_name);
76 * modest_tny_folder_is_local_folder:
77 * @folder: a valid tnymail folder
79 * checks if the folder is part of the "local folders" pseudo-account
81 * Returns: TRUE if it's a local folder, FALSE otherwise
83 gboolean modest_tny_folder_is_local_folder (const TnyFolder *folder);
86 * modest_tny_folder_get_local_folder_type:
87 * @folder: a valid tnymail folder
89 * checks if the folder is part of the "local folders" pseudo-account
91 * Returns: TRUE if it's a local folder, FALSE otherwise
93 TnyFolderType modest_tny_folder_get_local_folder_type (const TnyFolder *folder);
98 * modest_tny_folder_get_rules:
99 * @folder: a valid tnymail folder
101 * get the rules for this folder; can messages be put in it,
102 * can the folder be deleted, etc.
104 * Returns: the ModestTnyFolderRules rules (bitwise-OR) for this
107 ModestTnyFolderRules modest_tny_folder_get_rules (const TnyFolder *folder);
116 #endif /* __MODEST_TNY_FOLDER_H__*/