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.
30 #ifndef __MODEST_LOCAL_FOLDER_INFO_H__
31 #define __MODEST_LOCAL_FOLDER_INFO_H__
36 #include <tny-folder.h>
39 * modest_local_folder_info_get_type
40 * @name: the name of the local folder (ie. "trash", "inbox" etc.,
41 * these name can be found with modest_local_folder_get_name)
43 * get the type of some local folder
45 * Returns: the local folder type, or MODEST_LOCAL_FOLDER_TYPE_UNKNOWN
49 TnyFolderType modest_local_folder_info_get_type (const gchar *name);
52 * modest_local_folder_get_type_name
53 * @type: the type of the local folder
55 * get the name of some local folder
57 * Returns: the local folder name, or NULL in case of error
58 * the returned name should NOT be freed or modified
61 const gchar* modest_local_folder_info_get_type_name (TnyFolderType type);
64 * modest_local_folder_info_get_type_display_name
65 * @type: the type of the local folder
67 * get the localized display name for some local folder
69 * Returns: the local folder display name, or NULL in case of error
70 * the returned name should NOT be freed or modified
73 const gchar* modest_local_folder_info_get_type_display_name (TnyFolderType type);
77 * modest_local_folder_info_get_maildir_path
78 * @location_filepath: The path at which the local-folders directory exists,
79 * or NULL to specify $HOME
81 * Get the path to the Maildir where the local folders are stored.
83 * Returns: the local_folders Maildir path as a newly allocated
84 * string, which must be freed by the caller.
87 gchar *modest_local_folder_info_get_maildir_path (const gchar* location_filepath);
90 * modest_per_account_local_outbox_folder_info_get_maildir_path
92 * Get the path to the Maildir where the per-account local outbox folder is stored.
94 * Returns: the local outbox account Maildir path as a newly allocated
95 * string, which must be freed by the caller.
98 gchar *modest_per_account_local_outbox_folder_info_get_maildir_path (const gchar* account_name);
101 * modest_per_account_local_outbox_folder_info_get_maildir_path_to_outbox_folder
103 * Get the path to the "outbox" folder directory under the local outbox account MailDir directory.
105 * Returns: the local outbox folder Maildir path as a newly allocated
106 * string, which must be freed by the caller.
109 gchar *modest_per_account_local_outbox_folder_info_get_maildir_path_to_outbox_folder (const gchar* account_name);
112 #endif /* __MODEST_LOCAL_FOLDER_INFO_H__ */