1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
|
/* -*-mode:c; c-style:k&r; c-basic-offset:4; -*- */
/* Balsa E-Mail Client
*
* Copyright (C) 1997-2016 Stuart Parmenter and others,
* See the file AUTHORS for a list.
*
* 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, 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, see <https://www.gnu.org/licenses/>.
*/
#ifndef __LIBBALSA_MAILBOX_H__
#define __LIBBALSA_MAILBOX_H__
#ifndef BALSA_VERSION
# error "Include config.h before this file."
#endif
#include <gdk/gdk.h>
#include <gmime/gmime.h>
#define LIBBALSA_TYPE_MAILBOX (libbalsa_mailbox_get_type())
G_DECLARE_DERIVABLE_TYPE(LibBalsaMailbox,
libbalsa_mailbox,
LIBBALSA,
MAILBOX,
GObject)
#define MAILBOX_OPEN(mailbox) \
(libbalsa_mailbox_get_state(mailbox) != LB_MAILBOX_STATE_CLOSED)
#define MAILBOX_CLOSED(mailbox) \
(libbalsa_mailbox_get_state(mailbox) == LB_MAILBOX_STATE_CLOSED)
#define RETURN_IF_MAILBOX_CLOSED(mailbox)\
do {\
if (MAILBOX_CLOSED (mailbox))\
{\
g_print (_("*** ERROR: Mailbox Stream Closed: %s ***\n"), __PRETTY_FUNCTION__);\
libbalsa_unlock_mailbox (mailbox);\
return;\
}\
} while (0)
#define RETURN_VAL_IF_CONTEXT_CLOSED(mailbox, val)\
do {\
if (MAILBOX_CLOSED (mailbox))\
{\
g_print (_("*** ERROR: Mailbox Stream Closed: %s ***\n"), __PRETTY_FUNCTION__);\
libbalsa_unlock_mailbox (mailbox);\
return (val);\
}\
} while (0)
typedef enum {
LB_MAILBOX_SORT_NO, /* == NATURAL */
LB_MAILBOX_SORT_SUBJECT,
LB_MAILBOX_SORT_DATE,
LB_MAILBOX_SORT_SIZE,
LB_MAILBOX_SORT_SENDER,
LB_MAILBOX_SORT_THREAD /* this is not exactly sorting flag but
* a message index ordering flag. */
} LibBalsaMailboxSortFields;
typedef struct _SortTuple SortTuple;
/* Sorting */
struct _SortTuple {
guint offset;
GNode *node;
time_t thread_date;
};
typedef enum {
LB_MAILBOX_SORT_TYPE_ASC,
LB_MAILBOX_SORT_TYPE_DESC
} LibBalsaMailboxSortType;
typedef enum {
LIBBALSA_NTFY_INIT,
LIBBALSA_NTFY_UPDATE,
LIBBALSA_NTFY_FINISHED
} LibBalsaMailboxNotify;
/* MBG: If this enum is changed (even just the order) make sure to
* update pref-manager.c so the preferences work correctly */
typedef enum {
LB_MAILBOX_THREADING_FLAT,
LB_MAILBOX_THREADING_SIMPLE, /* JWZ without the subject-gather step */
LB_MAILBOX_THREADING_JWZ
} LibBalsaMailboxThreadingType;
typedef enum {
LB_MAILBOX_SHOW_UNSET = 0,
LB_MAILBOX_SHOW_FROM,
LB_MAILBOX_SHOW_TO
} LibBalsaMailboxShow;
typedef enum {
LB_MAILBOX_SUBSCRIBE_NO,
LB_MAILBOX_SUBSCRIBE_YES,
LB_MAILBOX_SUBSCRIBE_UNSET
} LibBalsaMailboxSubscribe;
typedef enum {
LB_FETCH_RFC822_HEADERS = 1<<0, /* prepare all rfc822 headers */
LB_FETCH_STRUCTURE = 1<<1 /* prepare message structure */
} LibBalsaFetchFlag;
typedef enum {
LB_MAILBOX_STATE_CLOSED,
LB_MAILBOX_STATE_OPENING,
LB_MAILBOX_STATE_OPEN,
LB_MAILBOX_STATE_CLOSING
} LibBalsaMailboxState;
typedef enum {
LB_MAILBOX_CHK_CRYPT_NEVER, /* never auto decrypt/signature check */
LB_MAILBOX_CHK_CRYPT_MAYBE, /* auto decrypt/signature check if possible */
LB_MAILBOX_CHK_CRYPT_ALWAYS /* always auto decrypt/signature check */
} LibBalsaChkCryptoMode;
enum LibBalsaMailboxCapability {
LIBBALSA_MAILBOX_CAN_SORT,
LIBBALSA_MAILBOX_CAN_THREAD
};
/*
* structures
*/
typedef struct _LibBalsaMailboxView LibBalsaMailboxView;
struct _LibBalsaMailboxView {
gchar *identity_name;
LibBalsaMailboxThreadingType threading_type;
gboolean subject_gather;
/** filter is a frontend-specific code determining used view
* filter. GUI usually allows to generate only a subset of all
* possible LibBalsaCondition's and mapping from arbitary
* LibBalsaCondition to a GUI configuration is not always
* possible. Therefore, we provide this variable for GUI's
* convinence. */
int filter;
LibBalsaMailboxSortType sort_type;
LibBalsaMailboxSortFields sort_field;
LibBalsaMailboxSortFields sort_field_prev;
LibBalsaMailboxShow show;
LibBalsaMailboxSubscribe subscribe;
gboolean exposed;
gboolean open;
gboolean in_sync; /* view is in sync with config */
gboolean used; /* keep track of usage */
LibBalsaChkCryptoMode gpg_chk_mode;
/* Display statistics:
* - total >= 0 both counts are valid;
* - total < 0 && unread == 0 unread is known to be zero;
* - total < 0 && unread > 0 unread is known to be > 0,
* but the count is not valid;
* - total < 0 && unread < 0 both are unknown.
*/
int unread;
int total;
time_t mtime; /* Mailbox mtime when counts were cached. */
int position; /* Position in the notebook */
};
/* Search iter */
struct _LibBalsaMailboxSearchIter {
gint ref_count;
gint stamp;
LibBalsaMailbox *mailbox;
LibBalsaCondition *condition;
gpointer user_data; /* private backend info */
};
/** Iterates over a list of messages, returning each time it is called
flags and the stream to a message. It is the responsibility of the
called to un-ref the stream after use. */
typedef gboolean (*LibBalsaAddMessageIterator)(LibBalsaMessageFlag *,
GMimeStream **stream,
void *);
struct _LibBalsaMailboxClass {
GObjectClass parent_class;
/* Signals */
void (*changed) (LibBalsaMailbox * mailbox);
void (*message_expunged) (LibBalsaMailbox * mailbox, guint seqno);
void (*progress_notify) (LibBalsaMailbox * mailbox, gint action, gdouble fraction, gchar *message);
/* Virtual Functions */
gboolean (*open_mailbox) (LibBalsaMailbox * mailbox, GError **err);
void (*close_mailbox) (LibBalsaMailbox * mailbox, gboolean expunge);
LibBalsaMessage *(*get_message) (LibBalsaMailbox * mailbox, guint msgno);
gboolean (*prepare_threading)(LibBalsaMailbox *mailbox, guint start);
gboolean (*fetch_message_structure)(LibBalsaMailbox *mailbox,
LibBalsaMessage * message,
LibBalsaFetchFlag flags);
void (*fetch_headers)(LibBalsaMailbox *mailbox,
LibBalsaMessage * message);
void (*release_message) (LibBalsaMailbox * mailbox,
LibBalsaMessage * message);
gboolean (*get_message_part) (LibBalsaMessage *message,
LibBalsaMessageBody *part,
GError **err);
GMimeStream *(*get_message_stream) (LibBalsaMailbox * mailbox,
guint msgno, gboolean peek);
void (*check) (LibBalsaMailbox * mailbox);
void (*search_iter_free) (LibBalsaMailboxSearchIter * iter);
gboolean (*message_match) (LibBalsaMailbox * mailbox,
guint msgno,
LibBalsaMailboxSearchIter *search_iter);
gboolean (*can_match) (LibBalsaMailbox * mailbox,
LibBalsaCondition *condition);
void (*save_config) (LibBalsaMailbox * mailbox, const gchar * prefix);
void (*load_config) (LibBalsaMailbox * mailbox, const gchar * prefix);
gboolean (*sync) (LibBalsaMailbox * mailbox, gboolean expunge);
guint (*add_messages) (LibBalsaMailbox * mailbox,
LibBalsaAddMessageIterator msg_iterator,
void *iter_arg, GError ** err);
gboolean (*messages_change_flags) (LibBalsaMailbox * mailbox,
GArray *msgnos,
LibBalsaMessageFlag set,
LibBalsaMessageFlag clear);
gboolean (*messages_copy) (LibBalsaMailbox * mailbox, GArray *msgnos,
LibBalsaMailbox * dest, GError **err);
/* Test message flags */
gboolean(*msgno_has_flags) (LibBalsaMailbox * mailbox, guint msgno,
LibBalsaMessageFlag set,
LibBalsaMessageFlag unset);
gboolean (*can_do) (LibBalsaMailbox *mailbox,
enum LibBalsaMailboxCapability cap);
void (*set_threading) (LibBalsaMailbox * mailbox,
LibBalsaMailboxThreadingType thread_type);
void (*update_view_filter) (LibBalsaMailbox * mailbox,
LibBalsaCondition *view_filter);
void (*sort) (LibBalsaMailbox * mailbox, GArray *sort_array);
gboolean (*close_backend)(LibBalsaMailbox * mailbox);
guint (*total_messages)(LibBalsaMailbox * mailbox);
GArray *(*duplicate_msgnos) (LibBalsaMailbox * mailbox);
void (*lock_store) (LibBalsaMailbox * mailbox, gboolean lock);
void (*test_can_reach) (LibBalsaMailbox * mailbox,
LibBalsaCanReachCallback * cb,
gpointer cb_data);
void (*cache_message) (LibBalsaMailbox *mailbox,
guint msgno,
LibBalsaMessage *message);
};
LibBalsaMailbox *libbalsa_mailbox_new_from_config(const gchar *prefix,
gboolean is_special);
/*
* open and close a mailbox
*/
/* XXX these need to return a value if they failed */
gboolean libbalsa_mailbox_open(LibBalsaMailbox * mailbox, GError **err);
gboolean libbalsa_mailbox_is_open(LibBalsaMailbox *mailbox);
void libbalsa_mailbox_close(LibBalsaMailbox * mailbox, gboolean expunge);
void libbalsa_mailbox_check(LibBalsaMailbox * mailbox);
void libbalsa_mailbox_changed(LibBalsaMailbox * mailbox);
void libbalsa_mailbox_set_unread_messages_flag(LibBalsaMailbox * mailbox,
gboolean has_unread);
void libbalsa_mailbox_progress_notify(LibBalsaMailbox *mailbox,
LibBalsaMailboxNotify action,
gdouble fraction,
const gchar *message,
...)
G_GNUC_PRINTF(4, 5);
/** Message access functions.
*/
/** libbalsa_mailbox_get_message() returns structure containing
changed, UTF-8 converted data of the message. LibBalsaMessage
will contain only basic information about the message sufficient to
produce message index unless more information was requested to be
prefetched.
*/
LibBalsaMessage *libbalsa_mailbox_get_message(LibBalsaMailbox * mailbox,
guint msgno);
/** libbalsa_mailbox_prepare_threading() requests prefetching of information
needed for client-side message threading.
msgnos are related to currently set view.
Returns TRUE if successful; FALSE may mean that the mailbox was
closed during the operation.
*/
gboolean libbalsa_mailbox_prepare_threading(LibBalsaMailbox * mailbox,
guint start);
/** libbalsa_mailbox_fetch_message_structure() fetches detailed
message structure for given message. It can also fetch all RFC822
headers of the message.
*/
gboolean libbalsa_mailbox_fetch_message_structure(LibBalsaMailbox *
mailbox,
LibBalsaMessage *
message,
LibBalsaFetchFlag flags);
/** libbalsa_mailbox_release_message() is called when the message
content and structure are no longer needed. It's passed to the
maildir and mh backends to unref the mime_message, but is a noop
for other backends.
*/
void libbalsa_mailbox_release_message(LibBalsaMailbox * mailbox,
LibBalsaMessage * message);
void libbalsa_mailbox_set_msg_headers(LibBalsaMailbox * mailbox,
LibBalsaMessage * message);
/** libbalsa_mailbox_get_message_part() ensures that a selected, single
part of the message is loaded.
*/
gboolean libbalsa_mailbox_get_message_part(LibBalsaMessage *message,
LibBalsaMessageBody *part,
GError **err);
/** libbalsa_mailbox_get_message_stream() returns a message stream associated
with full RFC822 text of the message.
*/
GMimeStream *libbalsa_mailbox_get_message_stream(LibBalsaMailbox * mailbox,
guint msgno, gboolean peek);
/** libbalsa_mailbox_sync_storage() asks the mailbox to synchronise
the memory information about messages with disk. Many drivers
update storage immediately and for them this operation may be
no-op. When expunge is set, driver is supposed to clean up the mailbox,
including physical removal of old deleted messages.
*/
gboolean libbalsa_mailbox_sync_storage(LibBalsaMailbox * mailbox,
gboolean expunge);
/* This function returns TRUE if the mailbox can be matched
against the given filters (eg : IMAP mailbox can't
use the SEARCH IMAP command for regex match, so the
match is done via default filtering funcs->can be slow)
*/
gboolean libbalsa_mailbox_can_match(LibBalsaMailbox *mailbox,
LibBalsaCondition *condition);
gboolean libbalsa_mailbox_message_match(LibBalsaMailbox *mailbox,
guint msgno,
LibBalsaMailboxSearchIter *search_iter);
/* Search iter */
LibBalsaMailboxSearchIter
*libbalsa_mailbox_search_iter_new(LibBalsaCondition * condition);
LibBalsaMailboxSearchIter
*libbalsa_mailbox_search_iter_view(LibBalsaMailbox * mailbox);
LibBalsaMailboxSearchIter
*libbalsa_mailbox_search_iter_ref(LibBalsaMailboxSearchIter * iter);
void libbalsa_mailbox_search_iter_unref(LibBalsaMailboxSearchIter * iter);
gboolean libbalsa_mailbox_search_iter_step(LibBalsaMailbox * mailbox,
LibBalsaMailboxSearchIter
* search_iter,
GtkTreeIter * iter,
gboolean forward,
guint stop_msgno);
/* Default filtering function (on reception)
It is ONLY FOR INTERNAL USE
*/
void libbalsa_mailbox_run_filters_on_reception(LibBalsaMailbox * mailbox);
void libbalsa_mailbox_save_config(LibBalsaMailbox * mailbox,
const gchar * prefix);
gboolean libbalsa_mailbox_add_message(LibBalsaMailbox * mailbox,
GMimeStream * stream,
LibBalsaMessageFlag flags,
GError ** err);
gboolean libbalsa_mailbox_close_backend(LibBalsaMailbox * mailbox);
/* Message number-list methods */
gboolean libbalsa_mailbox_messages_change_flags(LibBalsaMailbox * mailbox,
GArray * msgnos,
LibBalsaMessageFlag set,
LibBalsaMessageFlag clear);
gboolean libbalsa_mailbox_messages_copy(LibBalsaMailbox * mailbox,
GArray * msgnos,
LibBalsaMailbox * dest, GError **err);
gboolean libbalsa_mailbox_messages_move(LibBalsaMailbox * mailbox,
GArray * msgnos,
LibBalsaMailbox * dest, GError **err);
/*
* misc mailbox releated functions
*/
GType libbalsa_mailbox_type_from_path(const gchar * filename);
guint libbalsa_mailbox_total_messages(LibBalsaMailbox * mailbox);
gboolean libbalsa_mailbox_can_move_duplicates(LibBalsaMailbox * mailbox);
gint libbalsa_mailbox_move_duplicates(LibBalsaMailbox * mailbox,
LibBalsaMailbox * dest,
GError ** err);
/*
* Mailbox views-related functions.
*/
typedef struct LibBalsaMailboxIndexEntry_ LibBalsaMailboxIndexEntry;
void libbalsa_mailbox_index_entry_set_no(LibBalsaMailboxIndexEntry *entry,
unsigned no);
void libbalsa_mailbox_index_entry_clear(LibBalsaMailbox * mailbox,
guint msgno);
void libbalsa_mailbox_index_set_flags(LibBalsaMailbox *mailbox,
unsigned msgno, LibBalsaMessageFlag f);
gboolean libbalsa_mailbox_set_view_filter(LibBalsaMailbox * mailbox,
LibBalsaCondition *
filter_condition,
gboolean update_immediately);
void libbalsa_mailbox_make_view_filter_persistent(LibBalsaMailbox *
mailbox);
gboolean libbalsa_mailbox_can_do(LibBalsaMailbox *mailbox,
enum LibBalsaMailboxCapability cap);
/** libbalsa_mailbox_set_threading() uses backend-optimized threading mode
to produce a tree of messages. The tree is put in msg_tree and used
later by GtkTreeModel interface.
libbalsa_mailbox_set_threading() is the public method;
libbalsa_mailbox_set_msg_tree and libbalsa_mailbox_unlink_and_prepend
are helpers for the subclass methods.
*/
void libbalsa_mailbox_set_threading(LibBalsaMailbox *mailbox);
void libbalsa_mailbox_set_msg_tree(LibBalsaMailbox * mailbox,
GNode * msg_tree);
void libbalsa_mailbox_unlink_and_prepend(LibBalsaMailbox * mailbox,
GNode * node, GNode * parent);
/* Mailbox views. */
LibBalsaMailboxView *libbalsa_mailbox_view_new(void);
void libbalsa_mailbox_view_free(LibBalsaMailboxView * view);
gboolean libbalsa_mailbox_set_identity_name(LibBalsaMailbox * mailbox,
const gchar * identity_name);
void libbalsa_mailbox_set_threading_type(LibBalsaMailbox * mailbox,
LibBalsaMailboxThreadingType
threading_type);
void libbalsa_mailbox_set_subject_gather(LibBalsaMailbox * mailbox,
gboolean subject_gather);
void libbalsa_mailbox_set_sort_type(LibBalsaMailbox * mailbox,
LibBalsaMailboxSortType sort_type);
void libbalsa_mailbox_set_sort_field(LibBalsaMailbox * mailbox,
LibBalsaMailboxSortFields sort_field);
gboolean libbalsa_mailbox_set_show(LibBalsaMailbox * mailbox,
LibBalsaMailboxShow show);
gboolean libbalsa_mailbox_set_subscribe(LibBalsaMailbox * mailbox,
LibBalsaMailboxSubscribe
subscribe);
void libbalsa_mailbox_set_exposed(LibBalsaMailbox * mailbox,
gboolean exposed);
void libbalsa_mailbox_set_open(LibBalsaMailbox * mailbox, gboolean open);
void libbalsa_mailbox_set_filter(LibBalsaMailbox * mailbox, gint filter);
gboolean libbalsa_mailbox_set_crypto_mode(LibBalsaMailbox * mailbox,
LibBalsaChkCryptoMode gpg_chk_mode);
void libbalsa_mailbox_set_unread(LibBalsaMailbox * mailbox, gint unread);
void libbalsa_mailbox_set_total (LibBalsaMailbox * mailbox, gint total);
void libbalsa_mailbox_set_mtime (LibBalsaMailbox * mailbox, time_t mtime);
void libbalsa_mailbox_set_position(LibBalsaMailbox * mailbox, gint position);
const gchar *libbalsa_mailbox_get_identity_name(LibBalsaMailbox * mailbox);
LibBalsaMailboxThreadingType
libbalsa_mailbox_get_threading_type(LibBalsaMailbox * mailbox);
gboolean libbalsa_mailbox_get_subject_gather(LibBalsaMailbox * mailbox);
LibBalsaMailboxSortType libbalsa_mailbox_get_sort_type(LibBalsaMailbox *
mailbox);
LibBalsaMailboxSortFields libbalsa_mailbox_get_sort_field(LibBalsaMailbox *
mailbox);
LibBalsaMailboxShow libbalsa_mailbox_get_show(LibBalsaMailbox * mailbox);
LibBalsaMailboxSubscribe libbalsa_mailbox_get_subscribe(LibBalsaMailbox *
mailbox);
gboolean libbalsa_mailbox_get_exposed(LibBalsaMailbox * mailbox);
gboolean libbalsa_mailbox_get_open(LibBalsaMailbox * mailbox);
gint libbalsa_mailbox_get_filter(LibBalsaMailbox * mailbox);
LibBalsaChkCryptoMode libbalsa_mailbox_get_crypto_mode(LibBalsaMailbox * mailbox);
gint libbalsa_mailbox_get_unread(LibBalsaMailbox * mailbox);
gint libbalsa_mailbox_get_total (LibBalsaMailbox * mailbox);
time_t libbalsa_mailbox_get_mtime(LibBalsaMailbox * mailbox);
gint libbalsa_mailbox_get_position(LibBalsaMailbox * mailbox);
/** force update of given msgno */
void libbalsa_mailbox_msgno_changed(LibBalsaMailbox *mailbox, guint seqno);
void libbalsa_mailbox_msgno_inserted(LibBalsaMailbox * mailbox,
guint seqno, GNode * parent,
GNode ** sibling);
void libbalsa_mailbox_msgno_removed(LibBalsaMailbox *mailbox, guint seqno);
void libbalsa_mailbox_msgno_filt_check(LibBalsaMailbox * mailbox,
guint seqno,
LibBalsaMailboxSearchIter
* search_iter,
gboolean hold_selected);
/* Search */
gboolean libbalsa_mailbox_msgno_find(LibBalsaMailbox * mailbox,
guint seqno,
GtkTreePath ** path,
GtkTreeIter * iter);
/* Manage message flags */
gboolean libbalsa_mailbox_msgno_change_flags(LibBalsaMailbox * mailbox,
guint msgno,
LibBalsaMessageFlag set,
LibBalsaMessageFlag clear);
/* Test message flags */
gboolean libbalsa_mailbox_msgno_has_flags(LibBalsaMailbox * mailbox,
guint seqno,
LibBalsaMessageFlag set,
LibBalsaMessageFlag unset);
/* set icons */
void libbalsa_mailbox_set_unread_icon(const char *name);
void libbalsa_mailbox_set_trash_icon(const char *name);
void libbalsa_mailbox_set_flagged_icon(const char *name);
void libbalsa_mailbox_set_replied_icon(const char *name);
void libbalsa_mailbox_set_attach_icon(const char *name);
void libbalsa_mailbox_set_good_icon(const char *name);
void libbalsa_mailbox_set_notrust_icon(const char *name);
void libbalsa_mailbox_set_bad_icon(const char *name);
void libbalsa_mailbox_set_sign_icon(const char *name);
void libbalsa_mailbox_set_encr_icon(const char *name);
/* Partial messages */
void libbalsa_mailbox_try_reassemble(LibBalsaMailbox * mailbox,
const gchar * id);
/* Message numbers and arrays */
void libbalsa_mailbox_register_msgnos(LibBalsaMailbox * mailbox,
GArray * msgnos);
void libbalsa_mailbox_unregister_msgnos(LibBalsaMailbox * mailbox,
GArray * msgnos);
/* Accessors for LibBalsaMailboxIndexEntry */
LibBalsaMessageStatus libbalsa_mailbox_msgno_get_status(LibBalsaMailbox *
mailbox,
guint msgno);
const gchar *libbalsa_mailbox_msgno_get_subject(LibBalsaMailbox * mailbox,
guint msgno);
void libbalsa_mailbox_msgno_update_attach(LibBalsaMailbox * mailbox,
guint msgno,
LibBalsaMessage * message);
void libbalsa_mailbox_cache_message(LibBalsaMailbox * mailbox, guint msgno,
LibBalsaMessage * message);
/* Set the foreground and background colors of an array of messages */
void libbalsa_mailbox_set_foreground(LibBalsaMailbox * mailbox,
GArray * msgnos, const gchar * color);
void libbalsa_mailbox_set_background(LibBalsaMailbox * mailbox,
GArray * msgnos, const gchar * color);
/* Lock and unlock the mail store--currently, a no-op except for mbox.
*/
void libbalsa_mailbox_lock_store (LibBalsaMailbox * mailbox);
void libbalsa_mailbox_unlock_store(LibBalsaMailbox * mailbox);
/* Check whether a mailbox can be reached */
void libbalsa_mailbox_test_can_reach(LibBalsaMailbox * mailbox,
LibBalsaCanReachCallback * cb,
gpointer cb_data);
/* columns ids */
typedef enum {
LB_MBOX_MSGNO_COL,
LB_MBOX_MARKED_COL,
LB_MBOX_ATTACH_COL,
LB_MBOX_FROM_COL,
LB_MBOX_SUBJECT_COL,
LB_MBOX_DATE_COL,
LB_MBOX_SIZE_COL,
LB_MBOX_WEIGHT_COL,
LB_MBOX_STYLE_COL,
LB_MBOX_FOREGROUND_COL,
LB_MBOX_FOREGROUND_SET_COL,
LB_MBOX_BACKGROUND_COL,
LB_MBOX_BACKGROUND_SET_COL,
LB_MBOX_N_COLS
} LibBalsaMailboxColumn;
extern gchar **libbalsa_mailbox_date_format;
/*
* Getters
*/
GSList * libbalsa_mailbox_get_filters(LibBalsaMailbox * mailbox);
const gchar * libbalsa_mailbox_get_name(LibBalsaMailbox * mailbox);
const gchar * libbalsa_mailbox_get_url(LibBalsaMailbox * mailbox);
glong libbalsa_mailbox_get_unread_messages(LibBalsaMailbox * mailbox);
guint libbalsa_mailbox_get_first_unread(LibBalsaMailbox * mailbox);
LibBalsaCondition * libbalsa_mailbox_get_view_filter(LibBalsaMailbox * mailbox,
gboolean persistent);
GNode * libbalsa_mailbox_get_msg_tree(LibBalsaMailbox * mailbox);
gboolean libbalsa_mailbox_get_msg_tree_changed(LibBalsaMailbox * mailbox);
LibBalsaMailboxState libbalsa_mailbox_get_state(LibBalsaMailbox * mailbox);
LibBalsaMailboxIndexEntry *libbalsa_mailbox_get_index_entry(LibBalsaMailbox * mailbox,
guint msgno);
LibBalsaMailboxView * libbalsa_mailbox_get_view(LibBalsaMailbox * mailbox);
gint libbalsa_mailbox_get_stamp(LibBalsaMailbox * mailbox);
guint libbalsa_mailbox_get_open_ref(LibBalsaMailbox * mailbox);
gboolean libbalsa_mailbox_get_readonly(LibBalsaMailbox * mailbox);
const gchar * libbalsa_mailbox_get_config_prefix(LibBalsaMailbox * mailbox);
gboolean libbalsa_mailbox_get_has_unread_messages(LibBalsaMailbox * mailbox);
gboolean libbalsa_mailbox_get_messages_threaded(LibBalsaMailbox * mailbox);
gboolean libbalsa_mailbox_has_sort_pending(LibBalsaMailbox * mailbox);
/*
* Setters
*/
void libbalsa_mailbox_clear_unread_messages(LibBalsaMailbox * mailbox);
void libbalsa_mailbox_set_filters(LibBalsaMailbox * mailbox, GSList * filters);
void libbalsa_mailbox_set_url(LibBalsaMailbox * mailbox, const gchar * url);
void libbalsa_mailbox_set_first_unread(LibBalsaMailbox * mailbox, guint first);
void libbalsa_mailbox_set_msg_tree_changed(LibBalsaMailbox * mailbox, gboolean changed);
void libbalsa_mailbox_set_readonly(LibBalsaMailbox * mailbox, gboolean readonly);
void libbalsa_mailbox_set_no_reassemble(LibBalsaMailbox * mailbox,
gboolean no_reassemble);
void libbalsa_mailbox_set_name(LibBalsaMailbox * mailbox, const gchar * name);
void libbalsa_mailbox_set_view(LibBalsaMailbox * mailbox, LibBalsaMailboxView * view);
void libbalsa_mailbox_set_has_unread_messages(LibBalsaMailbox * mailbox,
gboolean has_unread_messages);
void libbalsa_mailbox_set_messages_threaded(LibBalsaMailbox * mailbox,
gboolean messages_threaded);
void libbalsa_mailbox_set_config_prefix(LibBalsaMailbox * mailbox,
const gchar * config_prefix);
/*
* Incrementers
*/
void libbalsa_mailbox_add_to_unread_messages(LibBalsaMailbox * mailbox, glong count);
#endif /* __LIBBALSA_MAILBOX_H__ */
|
