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() */
171 /* actions for mutt_pattern_comp/mutt_pattern_exec */
211 /* Options for Mailcap lookup */
217 /* options for socket code */
223 /* Options for mutt_save_attachment */
228 /* possible arguments to set_quadoption() */
236 /* quad-option vars */
252 OPT_PGPMIMEAUTO, /* ask to revert to PGP/MIME when inline fails */
262 #if defined(USE_SSL) || defined(USE_GNUTLS)
266 OPT_VERIFYSIG, /* verify PGP signatures */
272 OPT_FOLLOWUPTOPOSTER,
273 #endif /* USE_NNTP */
275 /* THIS MUST BE THE LAST VALUE. */
279 /* flags to ci_send_message() */
280 #define SENDREPLY (1<<0)
281 #define SENDGROUPREPLY (1<<1)
282 #define SENDLISTREPLY (1<<2)
283 #define SENDFORWARD (1<<3)
284 #define SENDPOSTPONED (1<<4)
285 #define SENDBATCH (1<<5)
286 #define SENDMAILX (1<<6)
287 #define SENDKEY (1<<7)
288 #define SENDRESEND (1<<8)
289 #define SENDNEWS (1<<9)
291 /* flags to _mutt_select_file() */
292 #define M_SEL_BUFFY (1<<0)
293 #define M_SEL_MULTI (1<<1)
294 #define M_SEL_FOLDER (1<<2)
296 /* flags for parse_spam_list */
340 #endif /* HAVE_QDBM */
348 OPTHIDETHREADSUBJECT,
351 OPTIGNORELISTREPLYTO,
353 OPTIMAPCHECKSUBSCRIBED,
359 #if defined(USE_SSL) || defined(USE_GNUTLS)
363 # endif /* !USE_GNUTLS */
367 #endif /* USE_SSL || USE_GNUTLS */
376 OPTMENUSCROLL, /* scroll menu instead of implicit next-page */
378 OPTMETAKEY, /* interpret ALT-x as ESC-x */
383 OPTMIMESUBJECT, /* encode subject line with RFC2047 */
432 #ifdef HAVE_GETADDRINFO
439 OPTWRITEBCC, /* write out a bcc header? */
441 OPTXMAILTO, /* 1 if $edit_header is forcebly set */
452 OPTCRYPTREPLYENCRYPT,
454 OPTCRYPTREPLYSIGNENCRYPTED,
458 OPTSDEFAULTDECRYPTKEY,
481 #endif /* USE_NNTP */
485 OPTAUXSORT, /* (pseudo) using auxillary sort function */
486 OPTFORCEREFRESH, /* (pseudo) refresh even during macros */
487 OPTLOCALES, /* (pseudo) set if user has valid locale definition */
488 OPTNOCURSES, /* (pseudo) when sending in batch mode */
489 OPTNEEDREDRAW, /* (pseudo) to notify caller of a submenu */
490 OPTSEARCHREVERSE, /* (pseudo) used by ci_search_command */
491 OPTMSGERR, /* (pseudo) used by mutt_error/mutt_message */
492 OPTSEARCHINVALID, /* (pseudo) used to invalidate the search pat */
493 OPTSIGNALSBLOCKED, /* (pseudo) using by mutt_block_signals () */
494 OPTSYSSIGNALSBLOCKED, /* (pseudo) using by mutt_block_signals_system () */
495 OPTNEEDRESORT, /* (pseudo) used to force a re-sort */
496 OPTRESORTINIT, /* (pseudo) used to force the next resort to be from scratch */
497 OPTVIEWATTACH, /* (pseudo) signals that we are viewing attachments */
498 OPTFORCEREDRAWINDEX, /* (pseudo) used to force a redraw in the main index */
499 OPTFORCEREDRAWPAGER, /* (pseudo) used to force a redraw in the pager */
500 OPTSORTSUBTHREADS, /* (pseudo) used when $sort_aux changes */
501 OPTNEEDRESCORE, /* (pseudo) set when the `score' command is used */
502 OPTATTACHMSG, /* (pseudo) used by attach-message */
503 OPTHIDEREAD, /* (pseudo) whether or not hide read messages */
504 OPTKEEPQUIET, /* (pseudo) shut up the message and refresh
505 * functions while we are executing an
508 OPTMENUCALLER, /* (pseudo) tell menu to give caller a take */
509 OPTREDRAWTREE, /* (pseudo) redraw the thread tree */
510 OPTPGPCHECKTRUST, /* (pseudo) used by pgp_select_key () */
511 OPTDONTHANDLEPGPKEYS, /* (pseudo) used to extract PGP keys */
512 OPTUNBUFFEREDINPUT, /* (pseudo) don't use key buffer */
515 OPTNEWS, /* (pseudo) used to change reader mode */
516 OPTNEWSSEND, /* (pseudo) used to change behavior when posting */
517 OPTNEWSCACHE, /* (pseudo) used to indicate if news cache exist */
519 OPTSHORTENHIERARCHY, /* set when to shorten "hierarchies" in the sidebar */
520 OPTSIDEBARNEWMAILONLY,
524 #define mutt_bit_alloc(n) calloc ((n + 7) / 8, sizeof (char))
525 #define mutt_bit_set(v,n) v[n/8] |= (1 << (n % 8))
526 #define mutt_bit_unset(v,n) v[n/8] &= ~(1 << (n % 8))
527 #define mutt_bit_toggle(v,n) v[n/8] ^= (1 << (n % 8))
528 #define mutt_bit_isset(v,n) (v[n/8] & (1 << (n % 8)))
530 #define set_option(x) mutt_bit_set(Options,x)
531 #define unset_option(x) mutt_bit_unset(Options,x)
532 #define toggle_option(x) mutt_bit_toggle(Options,x)
533 #define option(x) mutt_bit_isset(Options,x)
535 typedef struct spam_list_t {
539 struct spam_list_t *next;
543 #define mutt_new_spam_list() mem_calloc (1, sizeof (SPAM_LIST))
544 void mutt_free_spam_list (SPAM_LIST **);
546 int mutt_matches_ignore (const char *, LIST *);
548 void mutt_init (int, LIST *);
550 typedef struct envelope {
551 ADDRESS *return_path;
558 ADDRESS *mail_followup_to;
559 char *list_post; /* this stores a mailto URL, or nothing */
561 char *real_subj; /* offset of the real subject */
574 LIST *references; /* message references (in reverse order) */
575 LIST *in_reply_to; /* in-reply-to header content */
576 LIST *userhdrs; /* user defined headers */
577 unsigned int irt_changed:1; /* In-Reply-To changed to link/break threads */
578 unsigned int refs_changed:1; /* References changed to break thread */
581 typedef struct parameter {
584 struct parameter *next;
587 /* Information that helps in determing the Content-* of an attachment */
588 typedef struct content {
589 long hibin; /* 8-bit characters */
590 long lobin; /* unprintable 7-bit chars (eg., control chars) */
591 long crlf; /* '\r' and '\n' characters */
592 long ascii; /* number of ascii chars */
593 long linemax; /* length of the longest line in the file */
594 unsigned int space:1; /* whitespace at the end of lines? */
595 unsigned int binary:1; /* long lines, or CR not in CRLF pair */
596 unsigned int from:1; /* has a line beginning with "From "? */
597 unsigned int dot:1; /* has a line consisting of a single dot? */
598 unsigned int cr:1; /* has CR, even when in a CRLF pair */
601 typedef struct body {
602 char *xtype; /* content-type if x-unknown */
603 char *subtype; /* content-type subtype */
604 PARAMETER *parameter; /* parameters of the content-type */
605 char *description; /* content-description */
606 char *form_name; /* Content-Disposition form-data name param */
607 long hdr_offset; /* offset in stream where the headers begin.
608 * this info is used when invoking metamail,
609 * where we need to send the headers of the
612 long offset; /* offset where the actual data begins */
613 LOFF_T length; /* length (in bytes) of attachment */
614 char *filename; /* when sending a message, this is the file
615 * to which this structure refers
617 char *d_filename; /* filename to be used for the
618 * content-disposition header.
619 * If NULL, filename is used
622 char *file_charset; /* charset of attached file */
623 CONTENT *content; /* structure used to store detailed info about
624 * the content of the attachment. this is used
625 * to determine what content-transfer-encoding
626 * is required when sending mail.
628 struct body *next; /* next attachment in the list */
629 struct body *parts; /* parts of a multipart or message/rfc822 */
630 struct header *hdr; /* header information for message/rfc822 */
632 struct attachptr *aptr; /* Menu information, used in recvattach.c */
634 signed short attach_count;
636 time_t stamp; /* time stamp of last
640 unsigned int type:4; /* content-type primary type */
641 unsigned int encoding:3; /* content-transfer-encoding */
642 unsigned int disposition:2; /* content-disposition */
643 unsigned int use_disp:1; /* Content-Disposition uses filename= ? */
644 unsigned int unlink:1; /* flag to indicate the the file named by
645 * "filename" should be unlink()ed before
646 * free()ing this structure
648 unsigned int tagged:1;
649 unsigned int deleted:1; /* attachment marked for deletion */
651 unsigned int noconv:1; /* don't do character set conversion */
652 unsigned int force_charset:1;
653 /* send mode: don't adjust the character
654 * set when in send-mode.
656 unsigned int is_signed_data:1; /* A lot of MUAs don't indicate
657 S/MIME signed-data correctly,
658 e.g. they use foo.p7m even for
659 the name of signed data. This
660 flag is used to keep track of
661 the actual message type. It
662 gets set during the verification
663 (which is done if the encryption
664 try failed) and check by the
665 function to figure the type of
668 unsigned int goodsig:1; /* good cryptographic signature */
669 unsigned int warnsig:1; /* maybe good signature */
670 unsigned int badsig:1; /* bad cryptographic signature (needed to check encrypted s/mime-signatures) */
672 unsigned int collapsed:1; /* used by recvattach */
673 unsigned int attach_qualifies:1;
677 typedef struct header {
678 unsigned int security:11; /* bit 0-6: flags, bit 7,8: application.
679 see: crypt.h pgplib.h, smime.h */
681 unsigned int mime:1; /* has a MIME-Version header? */
682 unsigned int flagged:1; /* marked important? */
683 unsigned int tagged:1;
684 unsigned int appended:1; /* has been saved */
685 unsigned int purged:1; /* bypassing the trash folder */
686 unsigned int deleted:1;
687 unsigned int changed:1;
688 unsigned int attach_del:1; /* has an attachment marked for deletion */
691 unsigned int expired:1; /* already expired? */
692 unsigned int superseded:1; /* got superseded? */
693 unsigned int replied:1;
694 unsigned int subject_changed:1; /* used for threading */
695 unsigned int threaded:1; /* used for threading */
696 unsigned int display_subject:1; /* used for threading */
697 unsigned int recip_valid:1; /* is_recipient is valid */
698 unsigned int active:1; /* message is not to be removed */
699 unsigned int trash:1; /* message is marked as trashed on disk.
700 * This flag is used by the maildir_trash
704 /* timezone of the sender of this message */
705 unsigned int zhours:5;
706 unsigned int zminutes:6;
707 unsigned int zoccident:1;
709 /* bits used for caching when searching */
710 unsigned int searched:1;
711 unsigned int matched:1;
713 /* tells whether the attach count is valid */
714 unsigned int attach_valid:1;
716 /* the following are used to support collapsing threads */
717 unsigned int collapsed:1; /* is this message part of a collapsed thread? */
718 unsigned int limited:1; /* is this message in a limited view? */
719 size_t num_hidden; /* number of hidden messages in this view */
721 short recipient; /* user_is_recipient()'s return value, cached */
723 int pair; /* color-pair to use when displaying in the index */
725 time_t date_sent; /* time when the message was sent (UTC) */
726 time_t received; /* time when the message was placed in the mailbox */
727 long offset; /* where in the stream does this message begin? */
728 int lines; /* how many lines in the body of this message? */
729 int index; /* the absolute (unsorted) message number */
730 int msgno; /* number displayed to the user */
731 int virtual; /* virtual message number */
733 ENVELOPE *env; /* envelope information */
734 BODY *content; /* list of MIME parts */
740 char *tree; /* character string to print thread tree */
741 struct thread *thread;
750 int refno; /* message number on server */
753 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
754 void *data; /* driver-specific data */
757 char *maildir_flags; /* unknown maildir flags */
760 typedef struct thread {
761 unsigned int fake_thread:1;
762 unsigned int duplicate_thread:1;
763 unsigned int sort_children:1;
764 unsigned int check_subject:1;
765 unsigned int visible:1;
767 unsigned int subtree_visible:2;
768 unsigned int next_subtree_visible:1;
769 struct thread *parent;
770 struct thread *child;
778 /* flag to mutt_pattern_comp() */
779 #define M_FULL_MSG (1<<0) /* enable body and header matching */
782 M_MATCH_FULL_ADDRESS = 1
785 typedef struct pattern_t {
787 unsigned int not : 1;
788 unsigned int alladdr : 1;
789 unsigned int stringmatch : 1;
792 struct pattern_t *next;
793 struct pattern_t *child; /* arguments to logical op */
802 time_t mtime_cur; /* used with maildir folders */
805 char *pattern; /* limit pattern string */
806 pattern_t *limit_pattern; /* compiled limit pattern */
808 HEADER *last_tag; /* last tagged msg. used to link threads */
809 THREAD *tree; /* top of thread tree */
810 HASH *id_hash; /* hash table by msg id */
811 HASH *subj_hash; /* hash table by subject */
812 HASH *thread_hash; /* hash table for threading */
813 int *v2r; /* mapping from virtual to real msgno */
814 int hdrmax; /* number of pointers in hdrs */
815 int msgcount; /* number of messages in the mailbox */
816 int vcount; /* the number of virtual messages */
817 int tagged; /* how many messages are tagged? */
818 int new; /* how many new messages? */
819 int unread; /* how many unread messages? */
820 int deleted; /* how many deleted messages */
821 int appended; /* how many saved messages? */
822 int flagged; /* how many flagged messages */
823 int msgnotreadyet; /* which msg "new" in pager, -1 if none */
824 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
825 void *data; /* driver specific data */
826 #endif /* USE_IMAP */
828 short magic; /* mailbox type */
830 #ifdef USE_COMPRESSED
831 void *compressinfo; /* compressed mbox module private data */
832 char *realpath; /* path to compressed mailbox */
833 #endif /* USE_COMPRESSED */
835 unsigned int locked:1; /* is the mailbox locked? */
836 unsigned int changed:1; /* mailbox has been modified */
837 unsigned int readonly:1; /* don't allow changes to the mailbox */
838 unsigned int dontwrite:1; /* dont write the mailbox on close */
839 unsigned int append:1; /* mailbox is opened in append mode */
840 unsigned int quiet:1; /* inhibit status messages? */
841 unsigned int collapsed:1; /* are all threads collapsed? */
842 unsigned int closing:1; /* mailbox is being closed */
843 unsigned int counting:1; /* do we just want to cound? */
846 /* for attachment counter */
854 /* Flags for mutt_count_body_parts() */
855 #define M_PARTS_TOPLEVEL (1<<0) /* is the top-level part */
856 #define M_PARTS_RECOUNT (1<<1) /* force recount */
862 #endif /* !_MUTT_H */