git.maemo.org Git - modest/blob - src/modest-tny-folder.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 /*
  31  * TnyFolder Decorator
  32  */
  33
  34 #ifndef __MODEST_TNY_FOLDER_H__
  35 #define __MODEST_TNY_FOLDER_H__
  36
  37 #include <tny-folder.h>
  38 #include <modest-local-folder-info.h>
  39
  40 G_BEGIN_DECLS
  41
  42 typedef enum {
  43         MODEST_FOLDER_RULES_FOLDER_NON_WRITEABLE  = 1 << 1,
  44         MODEST_FOLDER_RULES_FOLDER_NON_DELETABLE  = 1 << 2,
  45         MODEST_FOLDER_RULES_FOLDER_NON_MOVEABLE   = 1 << 3,
  46         MODEST_FOLDER_RULES_FOLDER_NON_RENAMEABLE = 1 << 4,
  47 } ModestTnyFolderRules;
  48
  49 /** Note: This is not a derived TnyFolder type. These are just convenience
  50  * functions for working with a TnyFolder. tinymail does not seem to offer any
  51  * easy way to cause derived TnyFolders to be instantiated.
  52  */
  53
  54 /* TODO: These "const TnyFolder*" arguments will eventually need to
  55  * be "TnyFolder*". C cannot support constness for complex objects like C++
  56  * can, because it lacks the mutable keyword and doesn't allow both const
  57  * and non-const get function overloads.
  58  */
  59
  60 /**
  61  * modest_tny_folder_guess_type:
  62  * @folder: a valid tnymail folder
  63  *
  64  * determine the type of the folder. first, we see if tinymail
  65  * can give a specific type. if it cannot, we try to guess the
  66  * type, using modest_tny_folder_guess_type_from_name
  67  *
  68  * Returns: the folder type, or TNY_FOLDER_TYPE_UNKNOWN
  69  */
  70 TnyFolderType  modest_tny_folder_guess_folder_type   (const TnyFolder *folder);
  71
  72
  73
  74 /**
  75  * modest_tny_folder_is_remote_folder:
  76  * @folder: a valid tnymail folder
  77  *
  78  * checks if the folder is part of the "remote" account
  79  *
  80  * Returns: TRUE if it's a remote folder, FALSE otherwise
  81  */
  82 gboolean
  83 modest_tny_folder_is_remote_folder   (TnyFolder *folder);
  84
  85 /**
  86  * modest_tny_folder_is_local_folder:
  87  * @folder: a valid tnymail folder
  88  *
  89  * checks if the folder is part of the "local folders" pseudo-account
  90  *
  91  * Returns: TRUE if it's a local folder, FALSE otherwise
  92  */
  93 gboolean modest_tny_folder_is_local_folder   (TnyFolder *folder);
  94
  95 /**
  96  * modest_tny_folder_is_memory_card_folder:
  97  * @folder: a valid tnymail folder
  98  *
  99  * checks if the folder is part of the memory card account.
 100  *
 101  * Returns: TRUE if it's a memory card folder, FALSE otherwise
 102  */
 103 gboolean
 104 modest_tny_folder_is_memory_card_folder   (TnyFolder *folder);
 105
 106 /**
 107  * modest_tny_folder_get_local_folder_type:
 108  * @folder: a valid tnymail folder
 109  *
 110  * checks if the folder is part of the "local folders" pseudo-account
 111  *
 112  * Returns: TRUE if it's a local folder, FALSE otherwise
 113  */
 114 TnyFolderType modest_tny_folder_get_local_or_mmc_folder_type  (TnyFolder *folder);
 115
 116
 117 /**
 118  * modest_tny_folder_get_rules:
 119  * @folder: a valid tnymail folder
 120  *
 121  * get the rules for this folder; can messages be put in it,
 122  * can the folder be deleted, etc.
 123  *
 124  * Returns: the ModestTnyFolderRules rules (bitwise-OR) for this
 125  * folder
 126  */
 127 ModestTnyFolderRules  modest_tny_folder_get_rules   (TnyFolder *folder);
 128
 129 /**
 130  * modest_tny_folder_is_outbox_for_account:
 131  * @folder: a valid tnymail folder
 132  *
 133  * Discover whether this folder is the per-account outbox for the specified
 134  * account.
 135  *
 136  * Returns: TRUE if this folder is the per-account outbox for the account.
 137  */
 138 gboolean modest_tny_folder_is_outbox_for_account (TnyFolder *folder,
 139                                                   TnyAccount *account);
 140
 141 /**
 142  * modest_tny_folder_get_account:
 143  * @folder: a folder
 144  *
 145  * Get the parent account of the folder or, for TnyMergeFolder
 146  * instances, get the local-folders account.
 147  *
 148  * Returns: the account. You should call g_object_unref() on this.
 149  */
 150 TnyAccount *modest_tny_folder_get_account (TnyFolder *folder);
 151
 152 /**
 153  * modest_tny_msg_get_header_unique_id:
 154  * @header: a #TnyHeader
 155  *
 156  * This function returns a unique id for a message summary from
 157  * a TnyHeader retrieved with tny_folder_get_headers. You can not use
 158  * the TnyHeader returned by tny_msg_get_header because it has no uid.
 159  *
 160  * This uid is built from the folder URL string and the header uid,
 161  * the caller of the function must free the unique id when no longer
 162  * needed
 163  *
 164  * Returns: a unique identificator for a header object
 165  **/
 166 gchar* modest_tny_folder_get_header_unique_id (TnyHeader *header);
 167
 168 /**
 169  * modest_tny_folder_has_subfolder_with_name:
 170  * @folder: a #TnyFolderStore
 171  * @name: the name to check into subfolders.
 172  *
 173  * This function check if subfolders of @folder has the same
 174  * name as @name.
 175  *
 176  * Returns: TRUE if some subfolder has the name @name.
 177  **/
 178 gboolean modest_tny_folder_has_subfolder_with_name (TnyFolderStore *folder,
 179                                                     const gchar *name);
 180
 181 /**
 182  * modest_tny_folder_is_ancestor:
 183  * @folder: a #TnyFolder
 184  * @ancestor: a #TnyFolderStore
 185  *
 186  * This function checks if @ancestor is an ancestor of @folder
 187  *
 188  * Returns: TRUE if @ancestor is an ancestor of @folder, FALSE
 189  * otherwise
 190  **/
 191 gboolean modest_tny_folder_is_ancestor (TnyFolder *folder,
 192                                         TnyFolderStore *ancestor);
 193
 194 G_END_DECLS
 195
 196 #endif /* __MODEST_TNY_FOLDER_H__*/