Modified webpage: now tinymail repository is in gitorious.
[modest] / src / modest-local-folder-info.h
index 4b5ea10..39da254 100644 (file)
 G_BEGIN_DECLS
 
 #include <glib.h>
-
-typedef enum {
-       MODEST_LOCAL_FOLDER_TYPE_UNKNOWN,
-       MODEST_LOCAL_FOLDER_TYPE_DRAFTS,
-       MODEST_LOCAL_FOLDER_TYPE_SENT,
-       MODEST_LOCAL_FOLDER_TYPE_OUTBOX,
-       MODEST_LOCAL_FOLDER_TYPE_ARCHIVE,
-       MODEST_LOCAL_FOLDER_TYPE_JUNK,
-       MODEST_LOCAL_FOLDER_TYPE_TRASH, 
-       MODEST_LOCAL_FOLDER_TYPE_NUM    
-} ModestLocalFolderType;
-
+#include <tny-folder.h>
 
 /**
  * modest_local_folder_info_get_type
@@ -57,7 +46,7 @@ typedef enum {
  * in case of error
  *
  */
-ModestLocalFolderType modest_local_folder_info_get_type (const gchar *name);
+TnyFolderType modest_local_folder_info_get_type (const gchar *name);
 
 /**
  * modest_local_folder_get_type_name
@@ -69,10 +58,10 @@ ModestLocalFolderType modest_local_folder_info_get_type (const gchar *name);
  * the returned name should NOT be freed or modified
  *
  */
-const gchar* modest_local_folder_info_get_type_name (ModestLocalFolderType type);
+const gchar* modest_local_folder_info_get_type_name (TnyFolderType type);
 
 /**
- * modest_local_folder_get_type_display_name
+ * modest_local_folder_info_get_type_display_name
  * @type: the type of the local folder
  * 
  * get the localized display name for some local folder
@@ -81,8 +70,43 @@ const gchar* modest_local_folder_info_get_type_name (ModestLocalFolderType type)
  * the returned name should NOT be freed or modified
  *
  */
-const gchar* modest_local_folder_info_get_type_display_name (ModestLocalFolderType type);
+const gchar* modest_local_folder_info_get_type_display_name (TnyFolderType type);
+
+
+/**
+ * modest_local_folder_info_get_maildir_path
+ * @location_filepath: The path at which the local-folders directory exists, 
+ * or NULL to specify $HOME
+ * 
+ * Get the path to the Maildir where the local folders are stored.
+ *  
+ * Returns: the local_folders Maildir path as a newly allocated
+ * string, which must be freed by the caller.
+ *
+ */
+gchar *modest_local_folder_info_get_maildir_path (const gchar* location_filepath);
+
+/**
+ * modest_per_account_local_outbox_folder_info_get_maildir_path
+ * 
+ * Get the path to the Maildir where the per-account local outbox folder is stored.
+ *  
+ * Returns: the local outbox account Maildir path as a newly allocated
+ * string, which must be freed by the caller.
+ *
+ */
+gchar *modest_per_account_local_outbox_folder_info_get_maildir_path (const gchar* account_name);
 
+/**
+ * modest_per_account_local_outbox_folder_info_get_maildir_path_to_outbox_folder
+ * 
+ * Get the path to the "outbox" folder directory under the local outbox account MailDir directory.
+ *  
+ * Returns: the local outbox folder Maildir path as a newly allocated
+ * string, which must be freed by the caller.
+ *
+ */
+gchar *modest_per_account_local_outbox_folder_info_get_maildir_path_to_outbox_folder (const gchar* account_name);
 
 G_END_DECLS
 #endif /* __MODEST_LOCAL_FOLDER_INFO_H__ */