* check for a valid foldername
[modest] / src / modest-local-folder-info.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 #ifndef __MODEST_LOCAL_FOLDER_INFO_H__
31 #define __MODEST_LOCAL_FOLDER_INFO_H__
32
33 G_BEGIN_DECLS
34
35 #include <glib.h>
36 #include <modest-defs.h>
37 #include <tny-folder.h>
38
39 /**
40  * modest_local_folder_info_get_type
41  * @name: the name of the local folder (ie. "trash", "inbox" etc.,
42  * these name can be found with modest_local_folder_get_name)
43  *
44  * get the type of some local folder
45  *  
46  * Returns: the local folder type, or MODEST_LOCAL_FOLDER_TYPE_UNKNOWN
47  * in case of error
48  *
49  */
50 TnyFolderType modest_local_folder_info_get_type (const gchar *name);
51
52 /**
53  * modest_local_folder_get_type_name
54  * @type: the type of the local folder
55  * 
56  * get the name of some local folder
57  *  
58  * Returns: the local folder name, or NULL in case of error
59  * the returned name should NOT be freed or modified
60  *
61  */
62 const gchar* modest_local_folder_info_get_type_name (TnyFolderType type);
63
64 /**
65  * modest_local_folder_info_get_type_display_name
66  * @type: the type of the local folder
67  * 
68  * get the localized display name for some local folder
69  *  
70  * Returns: the local folder display name, or NULL in case of error
71  * the returned name should NOT be freed or modified
72  *
73  */
74 const gchar* modest_local_folder_info_get_type_display_name (TnyFolderType type);
75
76
77 /**
78  * modest_local_folder_info_get_maildir_path
79  * @location_filepath: The path at which the local-folders directory exists, 
80  * or NULL to specify $HOME
81  * 
82  * Get the path to the Maildir where the local folders are stored.
83  *  
84  * Returns: the local_folders Maildir path as a newly allocated
85  * string, which must be freed by the caller.
86  *
87  */
88 gchar *modest_local_folder_info_get_maildir_path (const gchar* location_filepath);
89
90 /**
91  * modest_per_account_local_outbox_folder_info_get_maildir_path
92  * 
93  * Get the path to the Maildir where the per-account local outbox folder is stored.
94  *  
95  * Returns: the local outbox account Maildir path as a newly allocated
96  * string, which must be freed by the caller.
97  *
98  */
99 gchar *modest_per_account_local_outbox_folder_info_get_maildir_path (const gchar* account_name);
100
101 /**
102  * modest_per_account_local_outbox_folder_info_get_maildir_path_to_outbox_folder
103  * 
104  * Get the path to the "outbox" folder directory under the local outbox account MailDir directory.
105  *  
106  * Returns: the local outbox folder Maildir path as a newly allocated
107  * string, which must be freed by the caller.
108  *
109  */
110 gchar *modest_per_account_local_outbox_folder_info_get_maildir_path_to_outbox_folder (const gchar* account_name);
111
112 G_END_DECLS
113 #endif /* __MODEST_LOCAL_FOLDER_INFO_H__ */
114