2 * Copyright notice from original mutt:
3 * Copyright (C) 1996-2002 Michael R. Elkins <me@mutt.org>
4 * Copyright (C) 2004 g10 Code GmbH
6 * This file is part of mutt-ng, see http://www.muttng.org/.
7 * It's licensed under the GNU General Public License,
8 * please see the file GPL in the top level source directory.
19 # include <unistd.h> /* needed for SEEK_SET */
22 # include <unix.h> /* needed for snprintf on QNX. */
24 #include <sys/types.h>
33 #if defined(HAVE_WCTYPE_H) && defined(HAVE_WC_FUNCS)
37 #ifndef _POSIX_PATH_MAX
38 #include <posix1_lim.h>
54 # define MB_LEN_MAX 16
57 # define MUTT_VERSION (VERSION)
59 /* nifty trick I stole from ELM 2.5alpha. */
62 #define INITVAL(x) = x
68 /* flags for mutt_extract_token() */
69 #define M_TOKEN_EQUAL 1 /* treat '=' as a special */
70 #define M_TOKEN_CONDENSE (1<<1) /* ^(char) to control chars (macros) */
71 #define M_TOKEN_SPACE (1<<2) /* don't treat whitespace as a term */
72 #define M_TOKEN_QUOTE (1<<3) /* don't interpret quotes */
73 #define M_TOKEN_PATTERN (1<<4) /* !)|~ are terms (for patterns) */
74 #define M_TOKEN_COMMENT (1<<5) /* don't reap comments */
75 #define M_TOKEN_SEMICOLON (1<<6) /* don't treat ; as special */
78 char *data; /* pointer to data */
79 char *dptr; /* current read/write position */
80 size_t dsize; /* length of data */
81 int destroy; /* destroy `data' when done? */
85 int ch; /* raw key pressed */
86 int op; /* function op */
89 /* flags for _mutt_system() */
90 #define M_DETACH_PROCESS 1 /* detach subprocess from group */
92 /* flags for mutt_FormatString() */
94 M_FORMAT_FORCESUBJ = (1 << 0), /* print the subject even if unchanged */
95 M_FORMAT_TREE = (1 << 1), /* draw the thread tree */
96 M_FORMAT_MAKEPRINT = (1 << 2), /* make sure that all chars are printable */
97 M_FORMAT_OPTIONAL = (1 << 3),
98 M_FORMAT_STAT_FILE = (1 << 4), /* used by mutt_attach_fmt */
99 M_FORMAT_ARROWCURSOR = (1 << 5), /* reserve space for arrow_cursor */
100 M_FORMAT_INDEX = (1 << 6) /* this is a main index entry */
103 /* types for mutt_add_hook() */
104 #define M_FOLDERHOOK 1
105 #define M_MBOXHOOK (1<<1)
106 #define M_SENDHOOK (1<<2)
107 #define M_FCCHOOK (1<<3)
108 #define M_SAVEHOOK (1<<4)
109 #define M_CHARSETHOOK (1<<5)
110 #define M_ICONVHOOK (1<<6)
111 #define M_MESSAGEHOOK (1<<7)
112 #define M_CRYPTHOOK (1<<8)
113 #define M_ACCOUNTHOOK (1<<9)
114 #define M_REPLYHOOK (1<<10)
115 #define M_SEND2HOOK (1<<11)
117 #ifdef USE_COMPRESSED
118 #define M_OPENHOOK (1<<12)
119 #define M_APPENDHOOK (1<<13)
120 #define M_CLOSEHOOK (1<<14)
123 /* tree characters for linearize_tree and print_enriched_string */
124 #define M_TREE_LLCORNER 1
125 #define M_TREE_ULCORNER 2
126 #define M_TREE_LTEE 3
127 #define M_TREE_HLINE 4
128 #define M_TREE_VLINE 5
129 #define M_TREE_SPACE 6
130 #define M_TREE_RARROW 7
131 #define M_TREE_STAR 8
132 #define M_TREE_HIDDEN 9
133 #define M_TREE_EQUALS 10
134 #define M_TREE_TTEE 11
135 #define M_TREE_BTEE 12
136 #define M_TREE_MISSING 13
137 #define M_TREE_MAX 14
139 #define M_THREAD_COLLAPSE (1<<0)
140 #define M_THREAD_UNCOLLAPSE (1<<1)
141 #define M_THREAD_GET_HIDDEN (1<<2)
142 #define M_THREAD_UNREAD (1<<3)
143 #define M_THREAD_NEXT_UNREAD (1<<4)
146 /* modes for mutt_view_attachment() */
151 /* action codes used by mutt_set_flag() and mutt_pattern_function() */
172 /* actions for mutt_pattern_comp/mutt_pattern_exec */
208 /* Options for Mailcap lookup */
214 /* options for socket code */
220 /* Options for mutt_save_attachment */
225 /* possible arguments to set_quadoption() */
233 /* quad-option vars */
248 OPT_PGPMIMEAUTO, /* ask to revert to PGP/MIME when inline fails */
258 #if defined(USE_SSL) || defined(USE_GNUTLS)
262 OPT_VERIFYSIG, /* verify PGP signatures */
268 OPT_FOLLOWUPTOPOSTER,
269 #endif /* USE_NNTP */
271 /* THIS MUST BE THE LAST VALUE. */
275 /* flags to ci_send_message() */
276 #define SENDREPLY (1<<0)
277 #define SENDGROUPREPLY (1<<1)
278 #define SENDLISTREPLY (1<<2)
279 #define SENDFORWARD (1<<3)
280 #define SENDPOSTPONED (1<<4)
281 #define SENDBATCH (1<<5)
282 #define SENDMAILX (1<<6)
283 #define SENDKEY (1<<7)
284 #define SENDRESEND (1<<8)
285 #define SENDNEWS (1<<9)
287 /* flags to _mutt_select_file() */
288 #define M_SEL_BUFFY (1<<0)
289 #define M_SEL_MULTI (1<<1)
290 #define M_SEL_FOLDER (1<<2)
292 /* flags for parse_spam_list */
335 #endif /* HAVE_QDBM */
343 OPTHIDETHREADSUBJECT,
346 OPTIGNORELISTREPLYTO,
348 OPTIMAPCHECKSUBSCRIBED,
354 #if defined(USE_SSL) || defined(USE_GNUTLS)
358 # endif /* !USE_GNUTLS */
362 #endif /* USE_SSL || USE_GNUTLS */
371 OPTMENUSCROLL, /* scroll menu instead of implicit next-page */
373 OPTMETAKEY, /* interpret ALT-x as ESC-x */
378 OPTMIMESUBJECT, /* encode subject line with RFC2047 */
427 #ifdef HAVE_GETADDRINFO
434 OPTWRITEBCC, /* write out a bcc header? */
446 OPTCRYPTREPLYENCRYPT,
448 OPTCRYPTREPLYSIGNENCRYPTED,
452 OPTSDEFAULTDECRYPTKEY,
475 #endif /* USE_NNTP */
479 OPTAUXSORT, /* (pseudo) using auxillary sort function */
480 OPTFORCEREFRESH, /* (pseudo) refresh even during macros */
481 OPTLOCALES, /* (pseudo) set if user has valid locale definition */
482 OPTNOCURSES, /* (pseudo) when sending in batch mode */
483 OPTNEEDREDRAW, /* (pseudo) to notify caller of a submenu */
484 OPTSEARCHREVERSE, /* (pseudo) used by ci_search_command */
485 OPTMSGERR, /* (pseudo) used by mutt_error/mutt_message */
486 OPTSEARCHINVALID, /* (pseudo) used to invalidate the search pat */
487 OPTSIGNALSBLOCKED, /* (pseudo) using by mutt_block_signals () */
488 OPTSYSSIGNALSBLOCKED, /* (pseudo) using by mutt_block_signals_system () */
489 OPTNEEDRESORT, /* (pseudo) used to force a re-sort */
490 OPTRESORTINIT, /* (pseudo) used to force the next resort to be from scratch */
491 OPTVIEWATTACH, /* (pseudo) signals that we are viewing attachments */
492 OPTFORCEREDRAWINDEX, /* (pseudo) used to force a redraw in the main index */
493 OPTFORCEREDRAWPAGER, /* (pseudo) used to force a redraw in the pager */
494 OPTSORTSUBTHREADS, /* (pseudo) used when $sort_aux changes */
495 OPTNEEDRESCORE, /* (pseudo) set when the `score' command is used */
496 OPTATTACHMSG, /* (pseudo) used by attach-message */
497 OPTHIDEREAD, /* (pseudo) whether or not hide read messages */
498 OPTKEEPQUIET, /* (pseudo) shut up the message and refresh
499 * functions while we are executing an
502 OPTMENUCALLER, /* (pseudo) tell menu to give caller a take */
503 OPTREDRAWTREE, /* (pseudo) redraw the thread tree */
504 OPTPGPCHECKTRUST, /* (pseudo) used by pgp_select_key () */
505 OPTDONTHANDLEPGPKEYS, /* (pseudo) used to extract PGP keys */
506 OPTUNBUFFEREDINPUT, /* (pseudo) don't use key buffer */
509 OPTNEWS, /* (pseudo) used to change reader mode */
510 OPTNEWSSEND, /* (pseudo) used to change behavior when posting */
511 OPTNEWSCACHE, /* (pseudo) used to indicate if news cache exist */
513 OPTSHORTENHIERARCHY, /* set when to shorten "hierarchies" in the sidebar */
514 OPTSIDEBARNEWMAILONLY,
518 #define mutt_bit_alloc(n) calloc ((n + 7) / 8, sizeof (char))
519 #define mutt_bit_set(v,n) v[n/8] |= (1 << (n % 8))
520 #define mutt_bit_unset(v,n) v[n/8] &= ~(1 << (n % 8))
521 #define mutt_bit_toggle(v,n) v[n/8] ^= (1 << (n % 8))
522 #define mutt_bit_isset(v,n) (v[n/8] & (1 << (n % 8)))
524 #define set_option(x) mutt_bit_set(Options,x)
525 #define unset_option(x) mutt_bit_unset(Options,x)
526 #define toggle_option(x) mutt_bit_toggle(Options,x)
527 #define option(x) mutt_bit_isset(Options,x)
529 typedef struct spam_list_t {
533 struct spam_list_t *next;
537 #define mutt_new_spam_list() mem_calloc (1, sizeof (SPAM_LIST))
538 void mutt_free_spam_list (SPAM_LIST **);
540 int mutt_matches_ignore (const char *, LIST *);
542 void mutt_init (int, LIST *);
544 typedef struct envelope {
545 ADDRESS *return_path;
552 ADDRESS *mail_followup_to;
553 char *list_post; /* this stores a mailto URL, or nothing */
555 char *real_subj; /* offset of the real subject */
568 LIST *references; /* message references (in reverse order) */
569 LIST *in_reply_to; /* in-reply-to header content */
570 LIST *userhdrs; /* user defined headers */
571 unsigned int irt_changed:1; /* In-Reply-To changed to link/break threads */
572 unsigned int refs_changed:1; /* References changed to break thread */
575 typedef struct parameter {
578 struct parameter *next;
581 /* Information that helps in determing the Content-* of an attachment */
582 typedef struct content {
583 long hibin; /* 8-bit characters */
584 long lobin; /* unprintable 7-bit chars (eg., control chars) */
585 long crlf; /* '\r' and '\n' characters */
586 long ascii; /* number of ascii chars */
587 long linemax; /* length of the longest line in the file */
588 unsigned int space:1; /* whitespace at the end of lines? */
589 unsigned int binary:1; /* long lines, or CR not in CRLF pair */
590 unsigned int from:1; /* has a line beginning with "From "? */
591 unsigned int dot:1; /* has a line consisting of a single dot? */
592 unsigned int cr:1; /* has CR, even when in a CRLF pair */
595 typedef struct body {
596 char *xtype; /* content-type if x-unknown */
597 char *subtype; /* content-type subtype */
598 PARAMETER *parameter; /* parameters of the content-type */
599 char *description; /* content-description */
600 char *form_name; /* Content-Disposition form-data name param */
601 long hdr_offset; /* offset in stream where the headers begin.
602 * this info is used when invoking metamail,
603 * where we need to send the headers of the
606 long offset; /* offset where the actual data begins */
607 long length; /* length (in bytes) of attachment */
608 char *filename; /* when sending a message, this is the file
609 * to which this structure refers
611 char *d_filename; /* filename to be used for the
612 * content-disposition header.
613 * If NULL, filename is used
616 char *file_charset; /* charset of attached file */
617 CONTENT *content; /* structure used to store detailed info about
618 * the content of the attachment. this is used
619 * to determine what content-transfer-encoding
620 * is required when sending mail.
622 struct body *next; /* next attachment in the list */
623 struct body *parts; /* parts of a multipart or message/rfc822 */
624 struct header *hdr; /* header information for message/rfc822 */
626 struct attachptr *aptr; /* Menu information, used in recvattach.c */
628 time_t stamp; /* time stamp of last
632 unsigned int type:4; /* content-type primary type */
633 unsigned int encoding:3; /* content-transfer-encoding */
634 unsigned int disposition:2; /* content-disposition */
635 unsigned int use_disp:1; /* Content-Disposition uses filename= ? */
636 unsigned int unlink:1; /* flag to indicate the the file named by
637 * "filename" should be unlink()ed before
638 * free()ing this structure
640 unsigned int tagged:1;
641 unsigned int deleted:1; /* attachment marked for deletion */
643 unsigned int noconv:1; /* don't do character set conversion */
644 unsigned int force_charset:1;
645 /* send mode: don't adjust the character
646 * set when in send-mode.
648 unsigned int is_signed_data:1; /* A lot of MUAs don't indicate
649 S/MIME signed-data correctly,
650 e.g. they use foo.p7m even for
651 the name of signed data. This
652 flag is used to keep track of
653 the actual message type. It
654 gets set during the verification
655 (which is done if the encryption
656 try failed) and check by the
657 function to figure the type of
660 unsigned int goodsig:1; /* good cryptographic signature */
661 unsigned int warnsig:1; /* maybe good signature */
662 unsigned int badsig:1; /* bad cryptographic signature (needed to check encrypted s/mime-signatures) */
664 unsigned int collapsed:1; /* used by recvattach */
668 typedef struct header {
669 unsigned int security:11; /* bit 0-6: flags, bit 7,8: application.
670 see: crypt.h pgplib.h, smime.h */
672 unsigned int mime:1; /* has a Mime-Version header? */
673 unsigned int flagged:1; /* marked important? */
674 unsigned int tagged:1;
675 unsigned int appended:1; /* has been saved */
676 unsigned int purged:1; /* bypassing the trash folder */
677 unsigned int deleted:1;
678 unsigned int changed:1;
679 unsigned int attach_del:1; /* has an attachment marked for deletion */
682 unsigned int expired:1; /* already expired? */
683 unsigned int superseded:1; /* got superseded? */
684 unsigned int replied:1;
685 unsigned int subject_changed:1; /* used for threading */
686 unsigned int threaded:1; /* used for threading */
687 unsigned int display_subject:1; /* used for threading */
688 unsigned int recip_valid:1; /* is_recipient is valid */
689 unsigned int active:1; /* message is not to be removed */
690 unsigned int trash:1; /* message is marked as trashed on disk.
691 * This flag is used by the maildir_trash
695 /* timezone of the sender of this message */
696 unsigned int zhours:5;
697 unsigned int zminutes:6;
698 unsigned int zoccident:1;
700 /* bits used for caching when searching */
701 unsigned int searched:1;
702 unsigned int matched:1;
704 /* the following are used to support collapsing threads */
705 unsigned int collapsed:1; /* is this message part of a collapsed thread? */
706 unsigned int limited:1; /* is this message in a limited view? */
707 size_t num_hidden; /* number of hidden messages in this view */
709 short recipient; /* user_is_recipient()'s return value, cached */
711 int pair; /* color-pair to use when displaying in the index */
713 time_t date_sent; /* time when the message was sent (UTC) */
714 time_t received; /* time when the message was placed in the mailbox */
715 long offset; /* where in the stream does this message begin? */
716 int lines; /* how many lines in the body of this message? */
717 int index; /* the absolute (unsorted) message number */
718 int msgno; /* number displayed to the user */
719 int virtual; /* virtual message number */
721 ENVELOPE *env; /* envelope information */
722 BODY *content; /* list of MIME parts */
728 char *tree; /* character string to print thread tree */
729 struct thread *thread;
736 int refno; /* message number on server */
739 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
740 void *data; /* driver-specific data */
743 char *maildir_flags; /* unknown maildir flags */
746 typedef struct thread {
747 unsigned int fake_thread:1;
748 unsigned int duplicate_thread:1;
749 unsigned int sort_children:1;
750 unsigned int check_subject:1;
751 unsigned int visible:1;
753 unsigned int subtree_visible:2;
754 unsigned int next_subtree_visible:1;
755 struct thread *parent;
756 struct thread *child;
764 /* flag to mutt_pattern_comp() */
765 #define M_FULL_MSG 1 /* enable body and header matching */
768 M_MATCH_FULL_ADDRESS = 1
771 typedef struct pattern_t {
777 struct pattern_t *next;
778 struct pattern_t *child; /* arguments to logical op */
786 time_t mtime_cur; /* used with maildir folders */
789 char *pattern; /* limit pattern string */
790 pattern_t *limit_pattern; /* compiled limit pattern */
792 HEADER *last_tag; /* last tagged msg. used to link threads */
793 THREAD *tree; /* top of thread tree */
794 HASH *id_hash; /* hash table by msg id */
795 HASH *subj_hash; /* hash table by subject */
796 HASH *thread_hash; /* hash table for threading */
797 int *v2r; /* mapping from virtual to real msgno */
798 int hdrmax; /* number of pointers in hdrs */
799 int msgcount; /* number of messages in the mailbox */
800 int vcount; /* the number of virtual messages */
801 int tagged; /* how many messages are tagged? */
802 int new; /* how many new messages? */
803 int unread; /* how many unread messages? */
804 int deleted; /* how many deleted messages */
805 int appended; /* how many saved messages? */
806 int flagged; /* how many flagged messages */
807 int msgnotreadyet; /* which msg "new" in pager, -1 if none */
808 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
809 void *data; /* driver specific data */
810 #endif /* USE_IMAP */
812 short magic; /* mailbox type */
814 #ifdef USE_COMPRESSED
815 void *compressinfo; /* compressed mbox module private data */
816 char *realpath; /* path to compressed mailbox */
817 #endif /* USE_COMPRESSED */
819 unsigned int locked:1; /* is the mailbox locked? */
820 unsigned int changed:1; /* mailbox has been modified */
821 unsigned int readonly:1; /* don't allow changes to the mailbox */
822 unsigned int dontwrite:1; /* dont write the mailbox on close */
823 unsigned int append:1; /* mailbox is opened in append mode */
824 unsigned int quiet:1; /* inhibit status messages? */
825 unsigned int collapsed:1; /* are all threads collapsed? */
826 unsigned int closing:1; /* mailbox is being closed */
827 unsigned int counting:1; /* do we just want to cound? */
834 #endif /* !_MUTT_H */