folder.h

Go to the documentation of this file.

/*
 * XetPan: a libEtPan! based Mail User Agent
 * Copyright (C) 2002 Melvin Hadasht
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

#ifndef FOLDER_H
#define FOLDER_H

#include <clist.h>
#include <chash.h>

#include "cntree.h"
#include "libetpan.h"

#include "manager.h"

#include "folder-types.h"
#include "mailbox-types.h"

typedef clist XePFoldersList;

typedef void (*XePFolderListCopyCb)(void *user_data);

typedef enum 
  {
    XEP_FOLDER_TYPE_REAL,
    XEP_FOLDER_TYPE_VIRTUAL,
    XEP_FOLDER_TYPE_MAILBOX
  } XePFolderType;

struct XePFolder_s
{
  /* First member must be id, second must be path.
   * This is so the XePGtkUtilsTree can use a generic structure
   * wich two members are the first and second column of the tree
   */
  char *id;
  char *path;          
  XePFolderType type;
  long uid;            
  XePManagerThread thread;

  XePMailbox *mailbox; 
  clist *rule_refs;    
  struct mail_storage *ep_storage;     
  struct mail_folder  *ep_folder;      
  struct mail_envelopes_tree *ep_tree; 
  struct mail_envelopes_list *ep_list; 
  clist *folder_refs;    
  clist *condition_refs; 
  uint32_t total;
  uint32_t unseen;
  uint32_t recent;
};

clist *
a_Folder_list_new(void);

clist *
a_Folder_list_new_copy(clist *folders);

void
a_Folder_list_free(clist *folders);

void
a_Folder_list_free_copy(clist *folders);

void
a_Folder_list_copy(clist *source, 
                   clist *target,
                   XePMailbox *mailbox,
                   XePFolderListCopyCb user_cb,
                   void *user_data);

XePFolder *
a_Folder_new(XePFolderType type);

XePFolder *
a_Folder_new_copy(XePFolder *folder);

void
a_Folder_free(XePFolder *folder);

void
a_Folder_free_copy(XePFolder *folder);

void
a_Folder_copy(XePFolder *source, XePFolder *target);

XePFolder *
a_Folder_get_from_uid(long uid);

XePFolderType
a_Folder_get_type(XePFolder *folder);

void
a_Folder_update_id(XePFolder *folder);

const char *
a_Folder_get_id(XePFolder *folder);

void
a_Folder_set_path(XePFolder *folder, const char *path);

void
a_Folder_set_path_p(XePFolder *folder, char *path);

const char *
a_Folder_get_path(XePFolder *folder);

void
a_Folder_set_mailbox(XePFolder *folder, XePMailbox *mailbox);

XePMailbox *
a_Folder_get_mailbox(XePFolder *folder);

const char *
a_Folder_get_short_name(XePFolder *folder);

void
a_Folder_set_folder_refs(XePFolder *folder, clist *folder_refs);

const clist *
a_Folder_get_folder_refs(XePFolder *folder);

void
a_Folder_set_condition_refs(XePFolder *folder, clist *condition_refs);

const clist *
a_Folder_get_condition_refs(XePFolder *folder);


XePFolderRef *
a_Folder_ref_new(void);

XePFolderRef *
a_Folder_ref_new_copy(XePFolderRef *folder_ref);

void
a_Folder_ref_free(XePFolderRef *folder_ref);

void
a_Folder_ref_free_content(XePFolderRef *folder_ref);

clist *
a_Folder_ref_list_new(void);

void
a_Folder_ref_list_free(clist *folder_refs);

chash *
a_Folder_ref_hash_new(void);

void
a_Folder_ref_hash_free(void);

chash *
a_Folder_ref_hash_get(void);

int
a_Folder_register(XePFolder *folder);

int
a_Folder_unregister(XePFolder *folder);

int
a_Folder_register_list(clist *folders);

int
a_Folder_unregister_list(clist *folders);

XePFolder *
a_Folder_get_from_ref(const char *ref);

void
a_Folder_update_rules_links(XePFoldersList *folders);

int
a_Folder_ref_link_to_folder(XePFolderRef *folder_ref);

void
a_Folder_ref_relink_all(void);

XePManagerThreadState
a_Folder_get_thread_state(XePFolder *folder);

int
a_Folder_is_locked(XePFolder *folder);

int
a_Folder_connect(XePFolder *folder);

int
a_Folder_disconnect(XePFolder *folder);

int
a_Folder_noop(XePFolder *folder);

int
a_Folder_expunge(XePFolder *folder);

int
a_Folder_sync(XePFolder *folder);

int
a_Folder_check(XePFolder *folder);

int
a_Folder_append(XePFolder *folder, const char *data, size_t size);

int
a_Folder_mailbox_connect(XePFolder *folder);

int
a_Folder_mailbox_disconnect(XePFolder *folder);

int
a_Folder_mailbox_list(XePFolder *folder, struct mail_list **mb_list);

int
a_Folder_mailbox_lsub(XePFolder *folder, struct mail_list **mb_list);


void
a_Folder_append_file_async(XePFolder *folder, const char *filename,
                           XePManagerMsgCb user_cb, void *user_data);

void
a_Folder_disconnect_async(XePFolder *folder,
                          XePManagerMsgCb user_cb, void *user_data);

uint32_t
a_Folder_tree_get_total_count(XePFolder *folder);

void
a_Folder_messages_change_flags_async(XePFolder *folder, 
                                     carray *messages,
                                     XePManagerMsgCb user_cb,
                                     void *user_data);
#endif

---