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