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 */
249 OPT_PGPMIMEAUTO, /* ask to revert to PGP/MIME when inline fails */
259 #if defined(USE_SSL) || defined(USE_GNUTLS)
263 OPT_VERIFYSIG, /* verify PGP signatures */
269 OPT_FOLLOWUPTOPOSTER,
270 #endif /* USE_NNTP */
272 /* THIS MUST BE THE LAST VALUE. */
276 /* flags to ci_send_message() */
277 #define SENDREPLY (1<<0)
278 #define SENDGROUPREPLY (1<<1)
279 #define SENDLISTREPLY (1<<2)
280 #define SENDFORWARD (1<<3)
281 #define SENDPOSTPONED (1<<4)
282 #define SENDBATCH (1<<5)
283 #define SENDMAILX (1<<6)
284 #define SENDKEY (1<<7)
285 #define SENDRESEND (1<<8)
286 #define SENDNEWS (1<<9)
288 /* flags to _mutt_select_file() */
289 #define M_SEL_BUFFY (1<<0)
290 #define M_SEL_MULTI (1<<1)
291 #define M_SEL_FOLDER (1<<2)
293 /* flags for parse_spam_list */
337 #endif /* HAVE_QDBM */
345 OPTHIDETHREADSUBJECT,
348 OPTIGNORELISTREPLYTO,
350 OPTIMAPCHECKSUBSCRIBED,
356 #if defined(USE_SSL) || defined(USE_GNUTLS)
360 # endif /* !USE_GNUTLS */
364 #endif /* USE_SSL || USE_GNUTLS */
373 OPTMENUSCROLL, /* scroll menu instead of implicit next-page */
375 OPTMETAKEY, /* interpret ALT-x as ESC-x */
380 OPTMIMESUBJECT, /* encode subject line with RFC2047 */
429 #ifdef HAVE_GETADDRINFO
436 OPTWRITEBCC, /* write out a bcc header? */
438 OPTXMAILTO, /* 1 if $edit_header is forcebly set */
449 OPTCRYPTREPLYENCRYPT,
451 OPTCRYPTREPLYSIGNENCRYPTED,
455 OPTSDEFAULTDECRYPTKEY,
478 #endif /* USE_NNTP */
482 OPTAUXSORT, /* (pseudo) using auxillary sort function */
483 OPTFORCEREFRESH, /* (pseudo) refresh even during macros */
484 OPTLOCALES, /* (pseudo) set if user has valid locale definition */
485 OPTNOCURSES, /* (pseudo) when sending in batch mode */
486 OPTNEEDREDRAW, /* (pseudo) to notify caller of a submenu */
487 OPTSEARCHREVERSE, /* (pseudo) used by ci_search_command */
488 OPTMSGERR, /* (pseudo) used by mutt_error/mutt_message */
489 OPTSEARCHINVALID, /* (pseudo) used to invalidate the search pat */
490 OPTSIGNALSBLOCKED, /* (pseudo) using by mutt_block_signals () */
491 OPTSYSSIGNALSBLOCKED, /* (pseudo) using by mutt_block_signals_system () */
492 OPTNEEDRESORT, /* (pseudo) used to force a re-sort */
493 OPTRESORTINIT, /* (pseudo) used to force the next resort to be from scratch */
494 OPTVIEWATTACH, /* (pseudo) signals that we are viewing attachments */
495 OPTFORCEREDRAWINDEX, /* (pseudo) used to force a redraw in the main index */
496 OPTFORCEREDRAWPAGER, /* (pseudo) used to force a redraw in the pager */
497 OPTSORTSUBTHREADS, /* (pseudo) used when $sort_aux changes */
498 OPTNEEDRESCORE, /* (pseudo) set when the `score' command is used */
499 OPTATTACHMSG, /* (pseudo) used by attach-message */
500 OPTHIDEREAD, /* (pseudo) whether or not hide read messages */
501 OPTKEEPQUIET, /* (pseudo) shut up the message and refresh
502 * functions while we are executing an
505 OPTMENUCALLER, /* (pseudo) tell menu to give caller a take */
506 OPTREDRAWTREE, /* (pseudo) redraw the thread tree */
507 OPTPGPCHECKTRUST, /* (pseudo) used by pgp_select_key () */
508 OPTDONTHANDLEPGPKEYS, /* (pseudo) used to extract PGP keys */
509 OPTUNBUFFEREDINPUT, /* (pseudo) don't use key buffer */
512 OPTNEWS, /* (pseudo) used to change reader mode */
513 OPTNEWSSEND, /* (pseudo) used to change behavior when posting */
514 OPTNEWSCACHE, /* (pseudo) used to indicate if news cache exist */
516 OPTSHORTENHIERARCHY, /* set when to shorten "hierarchies" in the sidebar */
517 OPTSIDEBARNEWMAILONLY,
521 #define mutt_bit_alloc(n) calloc ((n + 7) / 8, sizeof (char))
522 #define mutt_bit_set(v,n) v[n/8] |= (1 << (n % 8))
523 #define mutt_bit_unset(v,n) v[n/8] &= ~(1 << (n % 8))
524 #define mutt_bit_toggle(v,n) v[n/8] ^= (1 << (n % 8))
525 #define mutt_bit_isset(v,n) (v[n/8] & (1 << (n % 8)))
527 #define set_option(x) mutt_bit_set(Options,x)
528 #define unset_option(x) mutt_bit_unset(Options,x)
529 #define toggle_option(x) mutt_bit_toggle(Options,x)
530 #define option(x) mutt_bit_isset(Options,x)
532 typedef struct spam_list_t {
536 struct spam_list_t *next;
540 #define mutt_new_spam_list() mem_calloc (1, sizeof (SPAM_LIST))
541 void mutt_free_spam_list (SPAM_LIST **);
543 int mutt_matches_ignore (const char *, LIST *);
545 void mutt_init (int, LIST *);
547 typedef struct envelope {
548 ADDRESS *return_path;
555 ADDRESS *mail_followup_to;
556 char *list_post; /* this stores a mailto URL, or nothing */
558 char *real_subj; /* offset of the real subject */
571 LIST *references; /* message references (in reverse order) */
572 LIST *in_reply_to; /* in-reply-to header content */
573 LIST *userhdrs; /* user defined headers */
574 unsigned int irt_changed:1; /* In-Reply-To changed to link/break threads */
575 unsigned int refs_changed:1; /* References changed to break thread */
578 typedef struct parameter {
581 struct parameter *next;
584 /* Information that helps in determing the Content-* of an attachment */
585 typedef struct content {
586 long hibin; /* 8-bit characters */
587 long lobin; /* unprintable 7-bit chars (eg., control chars) */
588 long crlf; /* '\r' and '\n' characters */
589 long ascii; /* number of ascii chars */
590 long linemax; /* length of the longest line in the file */
591 unsigned int space:1; /* whitespace at the end of lines? */
592 unsigned int binary:1; /* long lines, or CR not in CRLF pair */
593 unsigned int from:1; /* has a line beginning with "From "? */
594 unsigned int dot:1; /* has a line consisting of a single dot? */
595 unsigned int cr:1; /* has CR, even when in a CRLF pair */
598 typedef struct body {
599 char *xtype; /* content-type if x-unknown */
600 char *subtype; /* content-type subtype */
601 PARAMETER *parameter; /* parameters of the content-type */
602 char *description; /* content-description */
603 char *form_name; /* Content-Disposition form-data name param */
604 long hdr_offset; /* offset in stream where the headers begin.
605 * this info is used when invoking metamail,
606 * where we need to send the headers of the
609 long offset; /* offset where the actual data begins */
610 long length; /* length (in bytes) of attachment */
611 char *filename; /* when sending a message, this is the file
612 * to which this structure refers
614 char *d_filename; /* filename to be used for the
615 * content-disposition header.
616 * If NULL, filename is used
619 char *file_charset; /* charset of attached file */
620 CONTENT *content; /* structure used to store detailed info about
621 * the content of the attachment. this is used
622 * to determine what content-transfer-encoding
623 * is required when sending mail.
625 struct body *next; /* next attachment in the list */
626 struct body *parts; /* parts of a multipart or message/rfc822 */
627 struct header *hdr; /* header information for message/rfc822 */
629 struct attachptr *aptr; /* Menu information, used in recvattach.c */
631 time_t stamp; /* time stamp of last
635 unsigned int type:4; /* content-type primary type */
636 unsigned int encoding:3; /* content-transfer-encoding */
637 unsigned int disposition:2; /* content-disposition */
638 unsigned int use_disp:1; /* Content-Disposition uses filename= ? */
639 unsigned int unlink:1; /* flag to indicate the the file named by
640 * "filename" should be unlink()ed before
641 * free()ing this structure
643 unsigned int tagged:1;
644 unsigned int deleted:1; /* attachment marked for deletion */
646 unsigned int noconv:1; /* don't do character set conversion */
647 unsigned int force_charset:1;
648 /* send mode: don't adjust the character
649 * set when in send-mode.
651 unsigned int is_signed_data:1; /* A lot of MUAs don't indicate
652 S/MIME signed-data correctly,
653 e.g. they use foo.p7m even for
654 the name of signed data. This
655 flag is used to keep track of
656 the actual message type. It
657 gets set during the verification
658 (which is done if the encryption
659 try failed) and check by the
660 function to figure the type of
663 unsigned int goodsig:1; /* good cryptographic signature */
664 unsigned int warnsig:1; /* maybe good signature */
665 unsigned int badsig:1; /* bad cryptographic signature (needed to check encrypted s/mime-signatures) */
667 unsigned int collapsed:1; /* used by recvattach */
671 typedef struct header {
672 unsigned int security:11; /* bit 0-6: flags, bit 7,8: application.
673 see: crypt.h pgplib.h, smime.h */
675 unsigned int mime:1; /* has a Mime-Version header? */
676 unsigned int flagged:1; /* marked important? */
677 unsigned int tagged:1;
678 unsigned int appended:1; /* has been saved */
679 unsigned int purged:1; /* bypassing the trash folder */
680 unsigned int deleted:1;
681 unsigned int changed:1;
682 unsigned int attach_del:1; /* has an attachment marked for deletion */
685 unsigned int expired:1; /* already expired? */
686 unsigned int superseded:1; /* got superseded? */
687 unsigned int replied:1;
688 unsigned int subject_changed:1; /* used for threading */
689 unsigned int threaded:1; /* used for threading */
690 unsigned int display_subject:1; /* used for threading */
691 unsigned int recip_valid:1; /* is_recipient is valid */
692 unsigned int active:1; /* message is not to be removed */
693 unsigned int trash:1; /* message is marked as trashed on disk.
694 * This flag is used by the maildir_trash
698 /* timezone of the sender of this message */
699 unsigned int zhours:5;
700 unsigned int zminutes:6;
701 unsigned int zoccident:1;
703 /* bits used for caching when searching */
704 unsigned int searched:1;
705 unsigned int matched:1;
707 /* the following are used to support collapsing threads */
708 unsigned int collapsed:1; /* is this message part of a collapsed thread? */
709 unsigned int limited:1; /* is this message in a limited view? */
710 size_t num_hidden; /* number of hidden messages in this view */
712 short recipient; /* user_is_recipient()'s return value, cached */
714 int pair; /* color-pair to use when displaying in the index */
716 time_t date_sent; /* time when the message was sent (UTC) */
717 time_t received; /* time when the message was placed in the mailbox */
718 long offset; /* where in the stream does this message begin? */
719 int lines; /* how many lines in the body of this message? */
720 int index; /* the absolute (unsorted) message number */
721 int msgno; /* number displayed to the user */
722 int virtual; /* virtual message number */
724 ENVELOPE *env; /* envelope information */
725 BODY *content; /* list of MIME parts */
731 char *tree; /* character string to print thread tree */
732 struct thread *thread;
739 int refno; /* message number on server */
742 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
743 void *data; /* driver-specific data */
746 char *maildir_flags; /* unknown maildir flags */
749 typedef struct thread {
750 unsigned int fake_thread:1;
751 unsigned int duplicate_thread:1;
752 unsigned int sort_children:1;
753 unsigned int check_subject:1;
754 unsigned int visible:1;
756 unsigned int subtree_visible:2;
757 unsigned int next_subtree_visible:1;
758 struct thread *parent;
759 struct thread *child;
767 /* flag to mutt_pattern_comp() */
768 #define M_FULL_MSG 1 /* enable body and header matching */
771 M_MATCH_FULL_ADDRESS = 1
774 typedef struct pattern_t {
780 struct pattern_t *next;
781 struct pattern_t *child; /* arguments to logical op */
789 time_t mtime_cur; /* used with maildir folders */
792 char *pattern; /* limit pattern string */
793 pattern_t *limit_pattern; /* compiled limit pattern */
795 HEADER *last_tag; /* last tagged msg. used to link threads */
796 THREAD *tree; /* top of thread tree */
797 HASH *id_hash; /* hash table by msg id */
798 HASH *subj_hash; /* hash table by subject */
799 HASH *thread_hash; /* hash table for threading */
800 int *v2r; /* mapping from virtual to real msgno */
801 int hdrmax; /* number of pointers in hdrs */
802 int msgcount; /* number of messages in the mailbox */
803 int vcount; /* the number of virtual messages */
804 int tagged; /* how many messages are tagged? */
805 int new; /* how many new messages? */
806 int unread; /* how many unread messages? */
807 int deleted; /* how many deleted messages */
808 int appended; /* how many saved messages? */
809 int flagged; /* how many flagged messages */
810 int msgnotreadyet; /* which msg "new" in pager, -1 if none */
811 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
812 void *data; /* driver specific data */
813 #endif /* USE_IMAP */
815 short magic; /* mailbox type */
817 #ifdef USE_COMPRESSED
818 void *compressinfo; /* compressed mbox module private data */
819 char *realpath; /* path to compressed mailbox */
820 #endif /* USE_COMPRESSED */
822 unsigned int locked:1; /* is the mailbox locked? */
823 unsigned int changed:1; /* mailbox has been modified */
824 unsigned int readonly:1; /* don't allow changes to the mailbox */
825 unsigned int dontwrite:1; /* dont write the mailbox on close */
826 unsigned int append:1; /* mailbox is opened in append mode */
827 unsigned int quiet:1; /* inhibit status messages? */
828 unsigned int collapsed:1; /* are all threads collapsed? */
829 unsigned int closing:1; /* mailbox is being closed */
830 unsigned int counting:1; /* do we just want to cound? */
837 #endif /* !_MUTT_H */