/usr/include/libetpan/maildriver_types.h is in libetpan-dev 1.6-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 | /*
* libEtPan! -- a mail stuff library
*
* Copyright (C) 2001, 2005 - DINH Viet Hoa
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the libEtPan! project nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
/*
* $Id: maildriver_types.h,v 1.49 2008/04/19 09:25:40 hoa Exp $
*/
#ifndef MAILDRIVER_TYPES_H
#define MAILDRIVER_TYPES_H
#ifndef _MSC_VER
# ifdef HAVE_INTTYPES_H
# include <inttypes.h>
# endif
# include <sys/types.h>
#endif
#include <libetpan/mailstream.h>
#include <libetpan/mailimf.h>
#include <libetpan/mailmime.h>
#include <libetpan/carray.h>
#include <libetpan/mailthread_types.h>
#include <libetpan/maildriver_errors.h>
#ifdef __cplusplus
extern "C" {
#endif
typedef struct mailsession_driver mailsession_driver;
typedef struct mailsession mailsession;
typedef struct mailmessage_driver mailmessage_driver;
typedef struct mailmessage mailmessage;
/*
mailmessage_list is a list of mailmessage
- tab is an array of mailmessage structures
*/
struct mailmessage_list {
carray * msg_tab; /* elements are (mailmessage *) */
};
LIBETPAN_EXPORT
struct mailmessage_list * mailmessage_list_new(carray * msg_tab);
LIBETPAN_EXPORT
void mailmessage_list_free(struct mailmessage_list * env_list);
/*
mail_list is a list of mailbox names
- list is a list of mailbox names
*/
struct mail_list {
clist * mb_list; /* elements are (char *) */
};
LIBETPAN_EXPORT
struct mail_list * mail_list_new(clist * mb_list);
LIBETPAN_EXPORT
void mail_list_free(struct mail_list * resp);
/*
This is a flag value.
Flags can be combined with OR operation
*/
enum {
MAIL_FLAG_NEW = 1 << 0,
MAIL_FLAG_SEEN = 1 << 1,
MAIL_FLAG_FLAGGED = 1 << 2,
MAIL_FLAG_DELETED = 1 << 3,
MAIL_FLAG_ANSWERED = 1 << 4,
MAIL_FLAG_FORWARDED = 1 << 5,
MAIL_FLAG_CANCELLED = 1 << 6
};
/*
mail_flags is the value of a flag related to a message.
- flags is the standard flags value
- extension is a list of unknown flags for libEtPan!
*/
struct mail_flags {
uint32_t fl_flags;
clist * fl_extension; /* elements are (char *) */
};
LIBETPAN_EXPORT
struct mail_flags * mail_flags_new(uint32_t fl_flags, clist * fl_ext);
LIBETPAN_EXPORT
void mail_flags_free(struct mail_flags * flags);
/*
This function creates a flag for a new message
*/
LIBETPAN_EXPORT
struct mail_flags * mail_flags_new_empty(void);
/*
mailimf_date_time_comp compares two dates
*/
LIBETPAN_EXPORT
int32_t mailimf_date_time_comp(struct mailimf_date_time * date1,
struct mailimf_date_time * date2);
/*
this is type type of the search criteria
*/
enum {
MAIL_SEARCH_KEY_ALL, /* all messages correspond */
MAIL_SEARCH_KEY_ANSWERED, /* messages with flag \Answered */
MAIL_SEARCH_KEY_BCC, /* messages which Bcc field contains
a given string */
MAIL_SEARCH_KEY_BEFORE, /* messages which internal date is earlier
than the specified date */
MAIL_SEARCH_KEY_BODY, /* message that contains the given string
(in header and text parts) */
MAIL_SEARCH_KEY_CC, /* messages whose Cc field contains the
given string */
MAIL_SEARCH_KEY_DELETED, /* messages with the flag \Deleted */
MAIL_SEARCH_KEY_FLAGGED, /* messages with the flag \Flagged */
MAIL_SEARCH_KEY_FROM, /* messages whose From field contains the
given string */
MAIL_SEARCH_KEY_NEW, /* messages with the flag \Recent and not
the \Seen flag */
MAIL_SEARCH_KEY_OLD, /* messages that do not have the
\Recent flag set */
MAIL_SEARCH_KEY_ON, /* messages whose internal date is the
specified date */
MAIL_SEARCH_KEY_RECENT, /* messages with the flag \Recent */
MAIL_SEARCH_KEY_SEEN, /* messages with the flag \Seen */
MAIL_SEARCH_KEY_SINCE, /* messages whose internal date is later
than specified date */
MAIL_SEARCH_KEY_SUBJECT, /* messages whose Subject field contains the
given string */
MAIL_SEARCH_KEY_TEXT, /* messages whose text part contains the
given string */
MAIL_SEARCH_KEY_TO, /* messages whose To field contains the
given string */
MAIL_SEARCH_KEY_UNANSWERED, /* messages with no flag \Answered */
MAIL_SEARCH_KEY_UNDELETED, /* messages with no flag \Deleted */
MAIL_SEARCH_KEY_UNFLAGGED, /* messages with no flag \Flagged */
MAIL_SEARCH_KEY_UNSEEN, /* messages with no flag \Seen */
MAIL_SEARCH_KEY_HEADER, /* messages whose given field
contains the given string */
MAIL_SEARCH_KEY_LARGER, /* messages whose size is larger then
the given size */
MAIL_SEARCH_KEY_NOT, /* not operation of the condition */
MAIL_SEARCH_KEY_OR, /* or operation between two conditions */
MAIL_SEARCH_KEY_SMALLER, /* messages whose size is smaller than
the given size */
MAIL_SEARCH_KEY_MULTIPLE /* the boolean operator between the
conditions is AND */
};
/*
mail_search_key is the condition on the messages to return
- type is the type of the condition
- bcc is the text to search in the Bcc field when type is
MAIL_SEARCH_KEY_BCC, should be allocated with malloc()
- before is a date when type is MAIL_SEARCH_KEY_BEFORE
- body is the text to search in the message when type is
MAIL_SEARCH_KEY_BODY, should be allocated with malloc()
- cc is the text to search in the Cc field when type is
MAIL_SEARCH_KEY_CC, should be allocated with malloc()
- from is the text to search in the From field when type is
MAIL_SEARCH_KEY_FROM, should be allocated with malloc()
- on is a date when type is MAIL_SEARCH_KEY_ON
- since is a date when type is MAIL_SEARCH_KEY_SINCE
- subject is the text to search in the Subject field when type is
MAILIMAP_SEARCH_KEY_SUBJECT, should be allocated with malloc()
- text is the text to search in the text part of the message when
type is MAILIMAP_SEARCH_KEY_TEXT, should be allocated with malloc()
- to is the text to search in the To field when type is
MAILIMAP_SEARCH_KEY_TO, should be allocated with malloc()
- header_name is the header name when type is MAILIMAP_SEARCH_KEY_HEADER,
should be allocated with malloc()
- header_value is the text to search in the given header when type is
MAILIMAP_SEARCH_KEY_HEADER, should be allocated with malloc()
- larger is a size when type is MAILIMAP_SEARCH_KEY_LARGER
- not is a condition when type is MAILIMAP_SEARCH_KEY_NOT
- or1 is a condition when type is MAILIMAP_SEARCH_KEY_OR
- or2 is a condition when type is MAILIMAP_SEARCH_KEY_OR
- sentbefore is a date when type is MAILIMAP_SEARCH_KEY_SENTBEFORE
- senton is a date when type is MAILIMAP_SEARCH_KEY_SENTON
- sentsince is a date when type is MAILIMAP_SEARCH_KEY_SENTSINCE
- smaller is a size when type is MAILIMAP_SEARCH_KEY_SMALLER
- multiple is a set of message when type is MAILIMAP_SEARCH_KEY_MULTIPLE
*/
#if 0
struct mail_search_key {
int sk_type;
union {
char * sk_bcc;
struct mailimf_date_time * sk_before;
char * sk_body;
char * sk_cc;
char * sk_from;
struct mailimf_date_time * sk_on;
struct mailimf_date_time * sk_since;
char * sk_subject;
char * sk_text;
char * sk_to;
char * sk_header_name;
char * sk_header_value;
size_t sk_larger;
struct mail_search_key * sk_not;
struct mail_search_key * sk_or1;
struct mail_search_key * sk_or2;
size_t sk_smaller;
clist * sk_multiple; /* list of (struct mailimap_search_key *) */
} sk_data;
};
struct mail_search_key *
mail_search_key_new(int sk_type,
char * sk_bcc, struct mailimf_date_time * sk_before,
char * sk_body, char * sk_cc, char * sk_from,
struct mailimf_date_time * sk_on, struct mailimf_date_time * sk_since,
char * sk_subject, char * sk_text, char * sk_to,
char * sk_header_name, char * sk_header_value, size_t sk_larger,
struct mail_search_key * sk_not, struct mail_search_key * sk_or1,
struct mail_search_key * sk_or2, size_t sk_smaller,
clist * sk_multiple);
void mail_search_key_free(struct mail_search_key * key);
#endif
/*
mail_search_result is a list of message numbers that is returned
by the mailsession_search_messages function()
*/
#if 0
struct mail_search_result {
clist * sr_list; /* list of (uint32_t *) */
};
struct mail_search_result * mail_search_result_new(clist * sr_list);
void mail_search_result_free(struct mail_search_result * search_result);
#endif
/*
There is three kinds of identities :
- storage
- folders
- session
A storage (struct mailstorage) represents whether a server or
a main path,
A storage can be an IMAP server, the root path of a MH or a mbox file.
Folders (struct mailfolder) are the mailboxes we can
choose in the server or as sub-folder of the main path.
Folders for IMAP are the IMAP mailboxes, for MH this is one of the
folder of the MH storage, for mbox, there is only one folder, the
mbox file content;
A mail session (struct mailsession) is whether a connection to a server
or a path that is open. It is the abstraction lower folders and storage.
It allow us to send commands.
We have a session driver for mail session for each kind of storage.
From a session, we can get a message (struct mailmessage) to read.
We have a message driver for each kind of storage.
*/
/*
maildriver is the driver structure for mail sessions
- name is the name of the driver
- initialize() is the function that will initializes a data structure
specific to the driver, it returns a value that will be stored
in the field data of the session.
The field data of the session is the state of the session,
the internal data structure used by the driver.
It is called when creating the mailsession structure with
mailsession_new().
- uninitialize() frees the structure created with initialize()
- parameters() implements functions specific to the given mail access
- connect_stream() connects a stream to the session
- connect_path() notify a main path to the session
- starttls() changes the current stream to a TLS stream
- login() notifies the user and the password to authenticate to the
session
- logout() exits the session and closes the stream
- noop() does no operation on the session, but it can be
used to poll for the status of the connection.
- build_folder_name() will return an allocated string with
that contains the complete path of the folder to create
- create_folder() creates the folder that corresponds to the
given name
- delete_folder() deletes the folder that corresponds to the
given name
- rename_folder() change the name of the folder
- check_folder() makes a checkpoint of the session
- examine_folder() selects a mailbox as readonly
- select_folder() selects a mailbox
- expunge_folder() deletes all messages marked \Deleted
- status_folder() queries the status of the folder
(number of messages, number of recent messages, number of
unseen messages)
- messages_number() queries the number of messages in the folder
- recent_number() queries the number of recent messages in the folder
- unseen_number() queries the number of unseen messages in the folder
- list_folders() returns the list of all sub-mailboxes
of the given mailbox
- lsub_folders() returns the list of subscribed
sub-mailboxes of the given mailbox
- subscribe_folder() subscribes to the given mailbox
- unsubscribe_folder() unsubscribes to the given mailbox
- append_message() adds a RFC 2822 message to the current
given mailbox
- copy_message() copies a message whose number is given to
a given mailbox. The mailbox must be accessible from
the same session.
- move_message() copies a message whose number is given to
a given mailbox. The mailbox must be accessible from the
same session.
- get_messages_list() returns the list of message numbers
of the current mailbox.
- get_envelopes_list() fills the parsed fields in the
mailmessage structures of the mailmessage_list.
- remove_message() removes the given message from the mailbox.
The message is permanently deleted.
- search_message() returns a list of message numbers that
corresponds to the given criteria.
- get_message returns a mailmessage structure that corresponds
to the given message number.
- get_message_by_uid returns a mailmessage structure that corresponds
to the given message unique identifier.
* mandatory functions are the following :
- connect_stream() of connect_path()
- logout()
- get_messages_list()
- get_envelopes_list()
* we advise you to implement these functions :
- select_folder() (in case a session can access several folders)
- noop() (to check if the server is responding)
- check_folder() (to make a checkpoint of the session)
- status_folder(), messages_number(), recent_number(), unseen_number()
(to get stat of the folder)
- append_message() (but can't be done in the case of POP3 at least)
- login() in a case of an authenticated driver.
- starttls() in a case of a stream driver, if the procotol supports
STARTTLS.
- get_message_by_uid() so that the application can remember the message
by UID and build its own list of messages.
- login_sasl() notifies the SASL information to authenticate to the
session.
* drivers' specific :
Everything that is specific to the driver will be implemented in this
function :
- parameters()
*/
struct mailsession_driver {
char * sess_name;
int (* sess_initialize)(mailsession * session);
void (* sess_uninitialize)(mailsession * session);
int (* sess_parameters)(mailsession * session,
int id, void * value);
int (* sess_connect_stream)(mailsession * session, mailstream * s);
int (* sess_connect_path)(mailsession * session, const char * path);
int (* sess_starttls)(mailsession * session);
int (* sess_login)(mailsession * session, const char * userid, const char * password);
int (* sess_logout)(mailsession * session);
int (* sess_noop)(mailsession * session);
/* folders operations */
int (* sess_build_folder_name)(mailsession * session, const char * mb,
const char * name, char ** result);
int (* sess_create_folder)(mailsession * session, const char * mb);
int (* sess_delete_folder)(mailsession * session, const char * mb);
int (* sess_rename_folder)(mailsession * session, const char * mb,
const char * new_name);
int (* sess_check_folder)(mailsession * session);
int (* sess_examine_folder)(mailsession * session, const char * mb);
int (* sess_select_folder)(mailsession * session, const char * mb);
int (* sess_expunge_folder)(mailsession * session);
int (* sess_status_folder)(mailsession * session, const char * mb,
uint32_t * result_num, uint32_t * result_recent,
uint32_t * result_unseen);
int (* sess_messages_number)(mailsession * session, const char * mb,
uint32_t * result);
int (* sess_recent_number)(mailsession * session, const char * mb,
uint32_t * result);
int (* sess_unseen_number)(mailsession * session, const char * mb,
uint32_t * result);
int (* sess_list_folders)(mailsession * session, const char * mb,
struct mail_list ** result);
int (* sess_lsub_folders)(mailsession * session, const char * mb,
struct mail_list ** result);
int (* sess_subscribe_folder)(mailsession * session, const char * mb);
int (* sess_unsubscribe_folder)(mailsession * session, const char * mb);
/* messages operations */
int (* sess_append_message)(mailsession * session,
const char * message, size_t size);
int (* sess_append_message_flags)(mailsession * session,
const char * message, size_t size, struct mail_flags * flags);
int (* sess_copy_message)(mailsession * session,
uint32_t num, const char * mb);
int (* sess_move_message)(mailsession * session,
uint32_t num, const char * mb);
int (* sess_get_message)(mailsession * session,
uint32_t num, mailmessage ** result);
int (* sess_get_message_by_uid)(mailsession * session,
const char * uid, mailmessage ** result);
int (* sess_get_messages_list)(mailsession * session,
struct mailmessage_list ** result);
int (* sess_get_envelopes_list)(mailsession * session,
struct mailmessage_list * env_list);
int (* sess_remove_message)(mailsession * session, uint32_t num);
int (* sess_login_sasl)(mailsession * session, const char * auth_type,
const char * server_fqdn,
const char * local_ip_port,
const char * remote_ip_port,
const char * login, const char * auth_name,
const char * password, const char * realm);
};
/*
session is the data structure for a mail session.
- data is the internal data structure used by the driver
It is called when initializing the mailsession structure.
- driver is the driver used for the session
*/
struct mailsession {
void * sess_data;
mailsession_driver * sess_driver;
};
/*
mailmessage_driver is the driver structure to get information from messages.
- name is the name of the driver
- initialize() is the function that will initializes a data structure
specific to the driver, it returns a value that will be stored
in the field data of the mailsession.
The field data of the session is the state of the session,
the internal data structure used by the driver.
It is called when initializing the mailmessage structure with
mailmessage_init().
- uninitialize() frees the structure created with initialize().
It will be called by mailmessage_free().
- flush() will free from memory all temporary structures of the message
(for example, the MIME structure of the message).
- fetch_result_free() will free all strings resulted by fetch() or
any fetch_xxx() functions that returns a string.
- fetch() returns the content of the message (headers and text).
- fetch_header() returns the content of the headers.
- fetch_body() returns the message text (message content without headers)
- fetch_size() returns the size of the message content.
- get_bodystructure() returns the MIME structure of the message.
- fetch_section() returns the content of a given MIME part
- fetch_section_header() returns the header of the message
contained by the given MIME part.
- fetch_section_mime() returns the MIME headers of the
given MIME part.
- fetch_section_body() returns the text (if this is a message, this is the
message content without headers) of the given MIME part.
- fetch_envelope() returns a mailimf_fields structure, with a list of
fields chosen by the driver.
- get_flags() returns a the flags related to the message.
When you want to get flags of a message, you have to make sure to
call get_flags() at least once before using directly message->flags.
*/
#define LIBETPAN_MAIL_MESSAGE_CHECK
struct mailmessage_driver {
char * msg_name;
int (* msg_initialize)(mailmessage * msg_info);
void (* msg_uninitialize)(mailmessage * msg_info);
void (* msg_flush)(mailmessage * msg_info);
void (* msg_check)(mailmessage * msg_info);
void (* msg_fetch_result_free)(mailmessage * msg_info,
char * msg);
int (* msg_fetch)(mailmessage * msg_info,
char ** result,
size_t * result_len);
int (* msg_fetch_header)(mailmessage * msg_info,
char ** result,
size_t * result_len);
int (* msg_fetch_body)(mailmessage * msg_info,
char ** result, size_t * result_len);
int (* msg_fetch_size)(mailmessage * msg_info,
size_t * result);
int (* msg_get_bodystructure)(mailmessage * msg_info,
struct mailmime ** result);
int (* msg_fetch_section)(mailmessage * msg_info,
struct mailmime * mime,
char ** result, size_t * result_len);
int (* msg_fetch_section_header)(mailmessage * msg_info,
struct mailmime * mime,
char ** result,
size_t * result_len);
int (* msg_fetch_section_mime)(mailmessage * msg_info,
struct mailmime * mime,
char ** result,
size_t * result_len);
int (* msg_fetch_section_body)(mailmessage * msg_info,
struct mailmime * mime,
char ** result,
size_t * result_len);
int (* msg_fetch_envelope)(mailmessage * msg_info,
struct mailimf_fields ** result);
int (* msg_get_flags)(mailmessage * msg_info,
struct mail_flags ** result);
};
/*
mailmessage is a data structure to get information from messages
- session is the session linked to the given message, it can be NULL
- driver is the message driver
- index is the message number
- uid, when it is not NULL, it means that the folder
the folder has persistant message numbers, the string is
the unique message number in the folder.
uid should be implemented if possible.
for drivers where we cannot generate real uid,
a suggestion is "AAAA-IIII" where AAAA is some
random session number and IIII the content of index field.
- size, when it is not 0, is the size of the message content.
- fields, when it is not NULL, are the header fields of the message.
- flags, when it is not NULL, are the flags related to the message.
- single_fields, when resolved != 0, is filled with the data of fields.
- mime, when it is not NULL
- cached is != 0 when the header fields were read from the cache.
- data is data specific to the driver, this is internal data structure,
some state of the message.
*/
struct mailmessage {
mailsession * msg_session;
mailmessage_driver * msg_driver;
uint32_t msg_index;
char * msg_uid;
size_t msg_size;
struct mailimf_fields * msg_fields;
struct mail_flags * msg_flags;
int msg_resolved;
struct mailimf_single_fields msg_single_fields;
struct mailmime * msg_mime;
/* internal data */
int msg_cached;
void * msg_data;
/*
msg_folder field :
used to reference the mailfolder, this is a workaround due
to the problem with initial conception, where folder notion
did not exist.
*/
void * msg_folder;
/* user data */
void * msg_user_data;
};
/*
mailmessage_tree is a node in the messages tree (thread)
- node_parent is the parent of the message, it is NULL if the message
is the root of the message tree.
- node_msgid is the message ID of this node.
- node_date is the date of the message in number of second elapsed
since 00:00:00 on January 1, 1970, Coordinated Universal Time (UTC).
- node_msg is the message structure that is stored referenced by the node.
is msg is NULL, this is a dummy node.
- node_children is an array that contains all the children of the node.
children are mailmessage_tree structures.
- node_is_reply is != 0 when the message is a reply or a forward
- node_base_subject is the extracted subject of the message.
*/
struct mailmessage_tree {
struct mailmessage_tree * node_parent;
char * node_msgid;
time_t node_date;
mailmessage * node_msg;
carray * node_children; /* array of (struct mailmessage_tree *) */
/* private, used for threading */
int node_is_reply;
char * node_base_subject;
};
LIBETPAN_EXPORT
struct mailmessage_tree *
mailmessage_tree_new(char * node_msgid, time_t node_date,
mailmessage * node_msg);
LIBETPAN_EXPORT
void mailmessage_tree_free(struct mailmessage_tree * tree);
/*
mailmessage_tree_free_recursive
if you want to release memory of the given tree and all the sub-trees,
you can use this function.
*/
LIBETPAN_EXPORT
void mailmessage_tree_free_recursive(struct mailmessage_tree * tree);
struct generic_message_t {
int (* msg_prefetch)(mailmessage * msg_info);
void (* msg_prefetch_free)(struct generic_message_t * msg);
int msg_fetched;
char * msg_message;
size_t msg_length;
void * msg_data;
};
LIBETPAN_EXPORT
const char * maildriver_strerror(int err);
/* basic malloc / free functions to be compliant with the library allocations */
LIBETPAN_EXPORT
void *libetpan_malloc(size_t length);
LIBETPAN_EXPORT
void libetpan_free(void* data);
#ifdef __cplusplus
}
#endif
#endif
|