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
  39 G_BEGIN_DECLS
  40
  41 typedef enum {
  42         MODEST_FOLDER_RULES_FOLDER_READ_ONLY = 0 << 1,
  43         MODEST_FOLDER_RULES_FOLDER_DELETABLE
  44 } ModestTnyFolderRules;
  45
  46 /**
  47  * modest_tny_folder_guess_type:
  48  * @folder: a valid tnymail folder
  49  *
  50  * determine the type of the folder. first, we see if tinymail
  51  * can give a specific type. if it cannot, we try to guess the
  52  * type, using modest_tny_folder_guess_type_from_name
  53  *
  54  * Returns: the folder type, or TNY_FOLDER_TYPE_UNKNOWN
  55  */
  56 TnyFolderType  modest_tny_folder_guess_folder_type   (const TnyFolder *folder);
  57
  58 /**
  59  * modest_tny_folder_guess_type_from_name:
  60  * @folder_name: a folder name
  61  *
  62  * determine the type of the folder. first, we see if tinymail
  63  * can give a specific type. if it cannot, we try to guess the
  64  * type, based on the name of the folder
  65  *
  66  * Note: this is a Class function, there does not require a tnyfolder instance
  67  *
  68  * Returns: the folder type, or TNY_FOLDER_TYPE_UNKNOWN
  69  */
  70 TnyFolderType  modest_tny_folder_guess_folder_type_from_name   (const gchar *folder_name);
  71
  72
  73 /**
  74  * modest_tny_folder_get_rules:
  75  * @folder: a valid tnymail folder
  76  *
  77  * get the rules for this folder; can messages be put in it,
  78  * can the folder be deleted, etc.
  79  *
  80  * Returns: the ModestTnyFolderRules rules (bitwise-OR) for this
  81  * folder
  82  */
  83 ModestTnyFolderRules  modest_tny_folder_get_rules   (const TnyFolder *folder);
  84
  85 G_END_DECLS
  86
  87 #endif /* __MODEST_TNY_FOLDER_H__*/