git.maemo.org Git - modest/blob - 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
  37 typedef enum {
  38         MODEST_LOCAL_FOLDER_TYPE_UNKNOWN,
  39         MODEST_LOCAL_FOLDER_TYPE_DRAFTS,
  40         MODEST_LOCAL_FOLDER_TYPE_SENT,
  41         MODEST_LOCAL_FOLDER_TYPE_OUTBOX,
  42         MODEST_LOCAL_FOLDER_TYPE_ARCHIVE,
  43         MODEST_LOCAL_FOLDER_TYPE_JUNK,
  44         MODEST_LOCAL_FOLDER_TYPE_TRASH,
  45         MODEST_LOCAL_FOLDER_TYPE_NUM
  46 } ModestLocalFolderType;
  47
  48
  49 /**
  50  * modest_local_folder_info_get_type
  51  * @name: the name of the local folder (ie. "trash", "inbox" etc.,
  52  * these name can be found with modest_local_folder_get_name)
  53  *
  54  * get the type of some local folder
  55  *
  56  * Returns: the local folder type, or MODEST_LOCAL_FOLDER_TYPE_UNKNOWN
  57  * in case of error
  58  *
  59  */
  60 ModestLocalFolderType modest_local_folder_info_get_type (const gchar *name);
  61
  62 /**
  63  * modest_local_folder_get_type_name
  64  * @type: the type of the local folder
  65  *
  66  * get the name of some local folder
  67  *
  68  * Returns: the local folder name, or NULL in case of error
  69  * the returned name should NOT be freed or modified
  70  *
  71  */
  72 const gchar* modest_local_folder_info_get_type_name (ModestLocalFolderType type);
  73
  74 /**
  75  * modest_local_folder_info_get_type_display_name
  76  * @type: the type of the local folder
  77  *
  78  * get the localized display name for some local folder
  79  *
  80  * Returns: the local folder display name, or NULL in case of error
  81  * the returned name should NOT be freed or modified
  82  *
  83  */
  84 const gchar* modest_local_folder_info_get_type_display_name (ModestLocalFolderType type);
  85
  86
  87 /**
  88  * modest_local_folder_info_get_maildir_path
  89  * @type: the type of the local folder
  90  *
  91  * get the path to the Maildir where the local folders are stored
  92  *
  93  * Returns: the local_folders Maildir path as a newly allocated
  94  * string, which must be freed by the caller.
  95  *
  96  */
  97 gchar *modest_local_folder_info_get_maildir_path (void);
  98
  99
 100 G_END_DECLS
 101 #endif /* __MODEST_LOCAL_FOLDER_INFO_H__ */
 102