mutt.h

   1 /*
   2  * Copyright notice from original mutt:
   3  * Copyright (C) 1996-2002 Michael R. Elkins <me@mutt.org>
   4  * Copyright (C) 2004 g10 Code GmbH
   5  *
   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.
   9  */
  10
  11 #ifndef _MUTT_H
  12 #define _MUTT_H
  13
  14 #include "config.h"
  15
  16 #include <stdio.h>
  17 #include <stdlib.h>
  18 #ifdef HAVE_UNISTD_H
  19 # include <unistd.h>            /* needed for SEEK_SET */
  20 #endif
  21 #ifdef HAVE_UNIX_H
  22 # include <unix.h>              /* needed for snprintf on QNX. */
  23 #endif
  24 #include <sys/types.h>
  25 #include <sys/stat.h>
  26 #include <time.h>
  27 #include <limits.h>
  28 #include <stdarg.h>
  29 #include <signal.h>
  30 #ifdef HAVE_WCHAR_H
  31 # include <wchar.h>
  32 #endif
  33 #if defined(HAVE_WCTYPE_H) && defined(HAVE_WC_FUNCS)
  34 # include <wctype.h>
  35 #endif
  36
  37 #ifndef _POSIX_PATH_MAX
  38 #include <posix1_lim.h>
  39 #endif
  40
  41 #include <pwd.h>
  42 #include <grp.h>
  43
  44 #include <lib-lib/buffer.h>
  45 #include <lib-lib/hash.h>
  46 #include <lib-lib/list.h>
  47
  48 #include "rfc822.h"
  49 #include "charset.h"
  50 #include "lib/rx.h"
  51
  52 #ifndef HAVE_WC_FUNCS
  53 # ifdef MB_LEN_MAX
  54 #  undef MB_LEN_MAX
  55 # endif
  56 # define MB_LEN_MAX 16
  57 #endif
  58
  59 # define MUTT_VERSION (VERSION)
  60
  61 /* nifty trick I stole from ELM 2.5alpha. */
  62 #ifdef MAIN_C
  63 #define WHERE
  64 #define INITVAL(x) = x
  65 #else
  66 #define WHERE extern
  67 #define INITVAL(x)
  68 #endif
  69
  70 /* flags for mutt_extract_token() */
  71 #define M_TOKEN_EQUAL           1       /* treat '=' as a special */
  72 #define M_TOKEN_CONDENSE        (1<<1)  /* ^(char) to control chars (macros) */
  73 #define M_TOKEN_SPACE           (1<<2)  /* don't treat whitespace as a term */
  74 #define M_TOKEN_QUOTE           (1<<3)  /* don't interpret quotes */
  75 #define M_TOKEN_PATTERN         (1<<4)  /* !)|~ are terms (for patterns) */
  76 #define M_TOKEN_COMMENT         (1<<5)  /* don't reap comments */
  77 #define M_TOKEN_SEMICOLON       (1<<6)  /* don't treat ; as special */
  78
  79 typedef struct {
  80   int ch;                       /* raw key pressed */
  81   int op;                       /* function op */
  82 } event_t;
  83
  84 /* flags for _mutt_system() */
  85 #define M_DETACH_PROCESS        1       /* detach subprocess from group */
  86
  87 /* flags for mutt_FormatString() */
  88 typedef enum {
  89   M_FORMAT_FORCESUBJ = (1 << 0),        /* print the subject even if unchanged */
  90   M_FORMAT_TREE = (1 << 1),     /* draw the thread tree */
  91   M_FORMAT_MAKEPRINT = (1 << 2),        /* make sure that all chars are printable */
  92   M_FORMAT_OPTIONAL = (1 << 3),
  93   M_FORMAT_STAT_FILE = (1 << 4),        /* used by mutt_attach_fmt */
  94   M_FORMAT_ARROWCURSOR = (1 << 5),      /* reserve space for arrow_cursor */
  95   M_FORMAT_INDEX = (1 << 6)     /* this is a main index entry */
  96 } format_flag;
  97
  98 /* types for mutt_add_hook() */
  99 #define M_FOLDERHOOK    1
 100 #define M_MBOXHOOK      (1<<1)
 101 #define M_SENDHOOK      (1<<2)
 102 #define M_FCCHOOK       (1<<3)
 103 #define M_SAVEHOOK      (1<<4)
 104 #define M_CHARSETHOOK   (1<<5)
 105 #define M_ICONVHOOK     (1<<6)
 106 #define M_MESSAGEHOOK   (1<<7)
 107 #define M_CRYPTHOOK     (1<<8)
 108 #define M_ACCOUNTHOOK   (1<<9)
 109 #define M_REPLYHOOK     (1<<10)
 110 #define M_SEND2HOOK     (1<<11)
 111
 112 #ifdef USE_COMPRESSED
 113 #define M_OPENHOOK      (1<<12)
 114 #define M_APPENDHOOK    (1<<13)
 115 #define M_CLOSEHOOK     (1<<14)
 116 #endif
 117
 118 /* tree characters for linearize_tree and print_enriched_string */
 119 #define M_TREE_LLCORNER         1
 120 #define M_TREE_ULCORNER         2
 121 #define M_TREE_LTEE             3
 122 #define M_TREE_HLINE            4
 123 #define M_TREE_VLINE            5
 124 #define M_TREE_SPACE            6
 125 #define M_TREE_RARROW           7
 126 #define M_TREE_STAR             8
 127 #define M_TREE_HIDDEN           9
 128 #define M_TREE_EQUALS           10
 129 #define M_TREE_TTEE             11
 130 #define M_TREE_BTEE             12
 131 #define M_TREE_MISSING          13
 132 #define M_TREE_MAX              14
 133
 134 #define M_THREAD_COLLAPSE       (1<<0)
 135 #define M_THREAD_UNCOLLAPSE     (1<<1)
 136 #define M_THREAD_GET_HIDDEN     (1<<2)
 137 #define M_THREAD_UNREAD         (1<<3)
 138 #define M_THREAD_NEXT_UNREAD    (1<<4)
 139
 140 enum {
 141   /* modes for mutt_view_attachment() */
 142   M_REGULAR = 1,
 143   M_MAILCAP,
 144   M_AS_TEXT,
 145
 146   /* action codes used by mutt_set_flag() and mutt_pattern_function() */
 147   M_ALL,
 148   M_NONE,
 149   M_NEW,
 150   M_OLD,
 151   M_REPLIED,
 152   M_READ,
 153   M_UNREAD,
 154   M_DELETE,
 155   M_UNDELETE,
 156   M_DELETED,
 157   M_APPENDED,
 158   M_PURGED,
 159   M_FLAG,
 160   M_TAG,
 161   M_UNTAG,
 162   M_LIMIT,
 163   M_EXPIRED,
 164   M_SUPERSEDED,
 165
 166   /* actions for mutt_pattern_comp/mutt_pattern_exec */
 167   M_AND,
 168   M_OR,
 169   M_TO,
 170   M_CC,
 171   M_COLLAPSED,
 172   M_SUBJECT,
 173   M_FROM,
 174   M_DATE,
 175   M_DATE_RECEIVED,
 176   M_DUPLICATED,
 177   M_UNREFERENCED,
 178   M_ID,
 179   M_BODY,
 180   M_HEADER,
 181   M_HORMEL,
 182   M_WHOLE_MSG,
 183   M_SENDER,
 184   M_MESSAGE,
 185   M_SCORE,
 186   M_SIZE,
 187   M_REFERENCE,
 188   M_RECIPIENT,
 189   M_LIST,
 190   M_SUBSCRIBED_LIST,
 191   M_PERSONAL_RECIP,
 192   M_PERSONAL_FROM,
 193   M_ADDRESS,
 194   M_CRYPT_SIGN,
 195   M_CRYPT_VERIFIED,
 196   M_CRYPT_ENCRYPT,
 197   M_PGP_KEY,
 198   M_XLABEL,
 199   M_MIMEATTACH,
 200 #ifdef USE_NNTP
 201   M_NEWSGROUPS,
 202 #endif
 203   M_REALNAME,
 204   M_MULTIPART,
 205
 206   /* Options for Mailcap lookup */
 207   M_EDIT,
 208   M_COMPOSE,
 209   M_PRINT,
 210   M_AUTOVIEW,
 211
 212   /* options for socket code */
 213   M_NEW_SOCKET,
 214 #ifdef USE_SSL
 215   M_NEW_SSL_SOCKET,
 216 #endif
 217
 218   /* Options for mutt_save_attachment */
 219   M_SAVE_APPEND,
 220   M_SAVE_OVERWRITE
 221 };
 222
 223 /* possible arguments to set_quadoption() */
 224 enum {
 225   M_NO,
 226   M_YES,
 227   M_ASKNO,
 228   M_ASKYES
 229 };
 230
 231 /* quad-option vars */
 232 enum {
 233   OPT_ABORT,
 234   OPT_ATTACH,
 235   OPT_BOUNCE,
 236   OPT_COPY,
 237   OPT_DELETE,
 238   OPT_FORWEDIT,
 239   OPT_INCLUDE,
 240 #ifdef USE_IMAP
 241   OPT_IMAPRECONNECT,
 242 #endif
 243   OPT_MFUPTO,
 244   OPT_MIMEFWD,
 245   OPT_MIMEFWDREST,
 246   OPT_MOVE,
 247   OPT_PGPMIMEAUTO,              /* ask to revert to PGP/MIME when inline fails */
 248 #ifdef USE_POP
 249   OPT_POPDELETE,
 250   OPT_POPRECONNECT,
 251 #endif
 252   OPT_POSTPONE,
 253   OPT_PRINT,
 254   OPT_QUIT,
 255   OPT_REPLYTO,
 256   OPT_RECALL,
 257 #if defined(USE_SSL) || defined(USE_GNUTLS)
 258   OPT_SSLSTARTTLS,
 259 #endif
 260   OPT_SUBJECT,
 261   OPT_VERIFYSIG,                /* verify PGP signatures */
 262   OPT_LISTREPLY,
 263 #ifdef USE_NNTP
 264   OPT_TOMODERATED,
 265   OPT_NNTPRECONNECT,
 266   OPT_CATCHUP,
 267   OPT_FOLLOWUPTOPOSTER,
 268 #endif                          /* USE_NNTP */
 269
 270   /* THIS MUST BE THE LAST VALUE. */
 271   OPT_MAX
 272 };
 273
 274 /* flags to ci_send_message() */
 275 #define SENDREPLY       (1<<0)
 276 #define SENDGROUPREPLY  (1<<1)
 277 #define SENDLISTREPLY   (1<<2)
 278 #define SENDFORWARD     (1<<3)
 279 #define SENDPOSTPONED   (1<<4)
 280 #define SENDBATCH       (1<<5)
 281 #define SENDMAILX       (1<<6)
 282 #define SENDKEY         (1<<7)
 283 #define SENDRESEND      (1<<8)
 284 #define SENDNEWS        (1<<9)
 285
 286 /* flags to _mutt_select_file() */
 287 #define M_SEL_BUFFY     (1<<0)
 288 #define M_SEL_MULTI     (1<<1)
 289 #define M_SEL_FOLDER    (1<<2)
 290
 291 /* flags for parse_spam_list */
 292 #define M_SPAM          1
 293 #define M_NOSPAM        2
 294
 295 /* boolean vars */
 296 enum {
 297   OPTALLOW8BIT,
 298   OPTALLOWANSI,
 299   OPTARROWCURSOR,
 300   OPTASCIICHARS,
 301   OPTASKBCC,
 302   OPTASKCC,
 303   OPTASKFOLLOWUP,
 304   OPTASKXCOMMENTTO,
 305   OPTATTACHSPLIT,
 306   OPTAUTOEDIT,
 307   OPTAUTOTAG,
 308   OPTBEEP,
 309   OPTBEEPNEW,
 310   OPTBOUNCEDELIVERED,
 311   OPTBRAILLEFRIENDLY,
 312   OPTCHECKNEW,
 313   OPTCOLLAPSEUNREAD,
 314   OPTCONFIRMAPPEND,
 315   OPTCONFIRMCREATE,
 316   OPTCOUNTATTACH,
 317   OPTDELETEUNTAG,
 318   OPTDELSP,
 319   OPTDIGESTCOLLAPSE,
 320   OPTDUPTHREADS,
 321   OPTEDITHDRS,
 322   OPTENCODEFROM,
 323   OPTENVFROM,
 324   OPTFASTREPLY,
 325   OPTFCCATTACH,
 326   OPTFCCCLEAR,
 327   OPTFOLLOWUPTO,
 328   OPTFORCEBUFFYCHECK,
 329   OPTFORCENAME,
 330   OPTFORWDECODE,
 331   OPTFORWQUOTE,
 332 #ifdef USE_HCACHE
 333   OPTHCACHEVERIFY,
 334 #if HAVE_QDBM
 335   OPTHCACHECOMPRESS,
 336 #endif /* HAVE_QDBM */
 337 #endif
 338   OPTHDRS,
 339   OPTHEADER,
 340   OPTHELP,
 341   OPTHIDDENHOST,
 342   OPTHIDELIMITED,
 343   OPTHIDEMISSING,
 344   OPTHIDETHREADSUBJECT,
 345   OPTHIDETOPLIMITED,
 346   OPTHIDETOPMISSING,
 347   OPTIGNORELISTREPLYTO,
 348 #ifdef USE_IMAP
 349   OPTIMAPCHECKSUBSCRIBED,
 350   OPTIMAPLSUB,
 351   OPTIMAPPASSIVE,
 352   OPTIMAPPEEK,
 353   OPTIMAPSERVERNOISE,
 354 #endif
 355 #if defined(USE_SSL) || defined(USE_GNUTLS)
 356 # ifndef USE_GNUTLS
 357   OPTSSLSYSTEMCERTS,
 358   OPTSSLV2,
 359 # endif /* !USE_GNUTLS */
 360   OPTSSLV3,
 361   OPTTLSV1,
 362   OPTSSLFORCETLS,
 363 #endif /* USE_SSL || USE_GNUTLS */
 364   OPTIMPLICITAUTOVIEW,
 365   OPTINCLUDEONLYFIRST,
 366   OPTKEEPFLAGGED,
 367   OPTMAILCAPSANITIZE,
 368   OPTMAILDIRTRASH,
 369   OPTMARKERS,
 370   OPTMARKOLD,
 371   OPTMBOXPANE,
 372   OPTMENUSCROLL,                /* scroll menu instead of implicit next-page */
 373   OPTMENUMOVEOFF,
 374   OPTMETAKEY,                   /* interpret ALT-x as ESC-x */
 375   OPTMETOO,
 376   OPTMHPURGE,
 377   OPTMIMEFORWDECODE,
 378 #ifdef USE_NNTP
 379   OPTMIMESUBJECT,               /* encode subject line with RFC2047 */
 380 #endif
 381   OPTNARROWTREE,
 382   OPTPAGERSTOP,
 383   OPTPIPEDECODE,
 384   OPTPIPESPLIT,
 385 #ifdef USE_POP
 386   OPTPOPAUTHTRYALL,
 387   OPTPOPLAST,
 388 #endif
 389   OPTPRINTDECODE,
 390   OPTPRINTSPLIT,
 391   OPTPROMPTAFTER,
 392   OPTQUOTEEMPTY,
 393   OPTQUOTEQUOTED,
 394   OPTREADONLY,
 395   OPTREPLYSELF,
 396   OPTRESOLVE,
 397   OPTREVALIAS,
 398   OPTREVNAME,
 399   OPTREVREAL,
 400   OPTRFC2047PARAMS,
 401   OPTSAVEADDRESS,
 402   OPTSAVEEMPTY,
 403   OPTSAVENAME,
 404   OPTSCORE,
 405   OPTSIGDASHES,
 406   OPTSIGONTOP,
 407   OPTSORTRE,
 408   OPTSPAMSEP,
 409   OPTSTATUSONTOP,
 410   OPTSTRICTMAILTO,
 411   OPTSTRICTMIME,
 412   OPTSTRICTTHREADS,
 413   OPTSTRIPWAS,
 414   OPTSTUFFQUOTED,
 415   OPTSUSPEND,
 416   OPTTEXTFLOWED,
 417   OPTTHOROUGHSRC,
 418   OPTTHREADRECEIVED,
 419   OPTTILDE,
 420   OPTUNCOLLAPSEJUMP,
 421   OPTUSE8BITMIME,
 422   OPTUSEDOMAIN,
 423   OPTUSEFROM,
 424   OPTUSEGPGAGENT,
 425 #ifdef HAVE_LIBIDN
 426   OPTUSEIDN,
 427 #endif
 428 #ifdef HAVE_GETADDRINFO
 429   OPTUSEIPV6,
 430 #endif
 431   OPTWAITKEY,
 432   OPTWEED,
 433   OPTWRAP,
 434   OPTWRAPSEARCH,
 435   OPTWRITEBCC,                  /* write out a bcc header? */
 436   OPTXMAILER,
 437   OPTXMAILTO,                   /* 1 if $edit_header is forcebly set */
 438   OPTXTERMSETTITLES,
 439
 440   OPTCRYPTUSEGPGME,
 441
 442   /* PGP options */
 443
 444   OPTCRYPTAUTOSIGN,
 445   OPTCRYPTAUTOENCRYPT,
 446   OPTCRYPTAUTOPGP,
 447   OPTCRYPTAUTOSMIME,
 448   OPTCRYPTREPLYENCRYPT,
 449   OPTCRYPTREPLYSIGN,
 450   OPTCRYPTREPLYSIGNENCRYPTED,
 451   OPTCRYPTTIMESTAMP,
 452   OPTSMIMEISDEFAULT,
 453   OPTASKCERTLABEL,
 454   OPTSDEFAULTDECRYPTKEY,
 455   OPTPGPIGNORESUB,
 456   OPTPGPCHECKEXIT,
 457   OPTPGPLONGIDS,
 458   OPTPGPAUTODEC,
 459 #if 0
 460   OPTPGPENCRYPTSELF,
 461 #endif
 462   OPTPGPRETAINABLESIG,
 463   OPTPGPSTRICTENC,
 464   OPTFORWDECRYPT,
 465   OPTPGPSHOWUNUSABLE,
 466   OPTPGPAUTOINLINE,
 467   OPTPGPREPLYINLINE,
 468
 469   /* news options */
 470
 471 #ifdef USE_NNTP
 472   OPTSHOWNEWNEWS,
 473   OPTSHOWONLYUNREAD,
 474   OPTSAVEUNSUB,
 475   OPTLOADDESC,
 476   OPTXCOMMENTTO,
 477 #endif                          /* USE_NNTP */
 478
 479   /* pseudo options */
 480
 481   OPTAUXSORT,                   /* (pseudo) using auxillary sort function */
 482   OPTFORCEREFRESH,              /* (pseudo) refresh even during macros */
 483   OPTLOCALES,                   /* (pseudo) set if user has valid locale definition */
 484   OPTNOCURSES,                  /* (pseudo) when sending in batch mode */
 485   OPTNEEDREDRAW,                /* (pseudo) to notify caller of a submenu */
 486   OPTSEARCHREVERSE,             /* (pseudo) used by ci_search_command */
 487   OPTMSGERR,                    /* (pseudo) used by mutt_error/mutt_message */
 488   OPTSEARCHINVALID,             /* (pseudo) used to invalidate the search pat */
 489   OPTSIGNALSBLOCKED,            /* (pseudo) using by mutt_block_signals () */
 490   OPTSYSSIGNALSBLOCKED,         /* (pseudo) using by mutt_block_signals_system () */
 491   OPTNEEDRESORT,                /* (pseudo) used to force a re-sort */
 492   OPTRESORTINIT,                /* (pseudo) used to force the next resort to be from scratch */
 493   OPTVIEWATTACH,                /* (pseudo) signals that we are viewing attachments */
 494   OPTFORCEREDRAWINDEX,          /* (pseudo) used to force a redraw in the main index */
 495   OPTFORCEREDRAWPAGER,          /* (pseudo) used to force a redraw in the pager */
 496   OPTSORTSUBTHREADS,            /* (pseudo) used when $sort_aux changes */
 497   OPTNEEDRESCORE,               /* (pseudo) set when the `score' command is used */
 498   OPTATTACHMSG,                 /* (pseudo) used by attach-message */
 499   OPTHIDEREAD,                  /* (pseudo) whether or not hide read messages */
 500   OPTKEEPQUIET,                 /* (pseudo) shut up the message and refresh
 501                                  *          functions while we are executing an
 502                                  *          external program.
 503                                  */
 504   OPTMENUCALLER,                /* (pseudo) tell menu to give caller a take */
 505   OPTREDRAWTREE,                /* (pseudo) redraw the thread tree */
 506   OPTPGPCHECKTRUST,             /* (pseudo) used by pgp_select_key () */
 507   OPTDONTHANDLEPGPKEYS,         /* (pseudo) used to extract PGP keys */
 508   OPTUNBUFFEREDINPUT,           /* (pseudo) don't use key buffer */
 509
 510 #ifdef USE_NNTP
 511   OPTNEWS,                      /* (pseudo) used to change reader mode */
 512   OPTNEWSSEND,                  /* (pseudo) used to change behavior when posting */
 513   OPTNEWSCACHE,                 /* (pseudo) used to indicate if news cache exist */
 514 #endif
 515   OPTSHORTENHIERARCHY,          /* set when to shorten "hierarchies" in the sidebar */
 516   OPTSIDEBARNEWMAILONLY,
 517   OPTMAX
 518 };
 519
 520 #define mutt_bit_alloc(n) calloc ((n + 7) / 8, sizeof (char))
 521 #define mutt_bit_set(v,n) v[n/8] |= (1 << (n % 8))
 522 #define mutt_bit_unset(v,n) v[n/8] &= ~(1 << (n % 8))
 523 #define mutt_bit_toggle(v,n) v[n/8] ^= (1 << (n % 8))
 524 #define mutt_bit_isset(v,n) (v[n/8] & (1 << (n % 8)))
 525
 526 #define set_option(x) mutt_bit_set(Options,x)
 527 #define unset_option(x) mutt_bit_unset(Options,x)
 528 #define toggle_option(x) mutt_bit_toggle(Options,x)
 529 #define option(x) mutt_bit_isset(Options,x)
 530
 531 typedef struct spam_list_t {
 532   rx_t *rx;
 533   int nmatch;
 534   char *template;
 535   struct spam_list_t *next;
 536 } SPAM_LIST;
 537
 538
 539 #define mutt_new_spam_list() p_new(SPAM_LIST, 1)
 540 void mutt_free_spam_list (SPAM_LIST **);
 541
 542 int mutt_matches_ignore (const char *, LIST *);
 543
 544 void mutt_init (int, LIST *);
 545
 546 typedef struct envelope {
 547   ADDRESS *return_path;
 548   ADDRESS *from;
 549   ADDRESS *to;
 550   ADDRESS *cc;
 551   ADDRESS *bcc;
 552   ADDRESS *sender;
 553   ADDRESS *reply_to;
 554   ADDRESS *mail_followup_to;
 555   char *list_post;              /* this stores a mailto URL, or nothing */
 556   char *subject;
 557   char *real_subj;              /* offset of the real subject */
 558   char *message_id;
 559   char *supersedes;
 560   char *date;
 561   char *x_label;
 562   char *organization;
 563 #ifdef USE_NNTP
 564   char *newsgroups;
 565   char *xref;
 566   char *followup_to;
 567   char *x_comment_to;
 568 #endif
 569   BUFFER *spam;
 570   LIST *references;             /* message references (in reverse order) */
 571   LIST *in_reply_to;            /* in-reply-to header content */
 572   LIST *userhdrs;               /* user defined headers */
 573   unsigned int irt_changed:1;   /* In-Reply-To changed to link/break threads */
 574   unsigned int refs_changed:1;  /* References changed to break thread */
 575 } ENVELOPE;
 576
 577 typedef struct parameter {
 578   char *attribute;
 579   char *value;
 580   struct parameter *next;
 581 } PARAMETER;
 582
 583 /* Information that helps in determing the Content-* of an attachment */
 584 typedef struct content {
 585   long hibin;                   /* 8-bit characters */
 586   long lobin;                   /* unprintable 7-bit chars (eg., control chars) */
 587   long crlf;                    /* '\r' and '\n' characters */
 588   long ascii;                   /* number of ascii chars */
 589   long linemax;                 /* length of the longest line in the file */
 590   unsigned int space:1;         /* whitespace at the end of lines? */
 591   unsigned int binary:1;        /* long lines, or CR not in CRLF pair */
 592   unsigned int from:1;          /* has a line beginning with "From "? */
 593   unsigned int dot:1;           /* has a line consisting of a single dot? */
 594   unsigned int cr:1;            /* has CR, even when in a CRLF pair */
 595 } CONTENT;
 596
 597 typedef struct body {
 598   char *xtype;                  /* content-type if x-unknown */
 599   char *subtype;                /* content-type subtype */
 600   PARAMETER *parameter;         /* parameters of the content-type */
 601   char *description;            /* content-description */
 602   char *form_name;              /* Content-Disposition form-data name param */
 603   off_t hdr_offset;             /* offset in stream where the headers begin.
 604                                  * this info is used when invoking metamail,
 605                                  * where we need to send the headers of the
 606                                  * attachment
 607                                  */
 608   off_t offset;                 /* offset where the actual data begins */
 609   off_t length;                 /* length (in bytes) of attachment */
 610   char *filename;               /* when sending a message, this is the file
 611                                  * to which this structure refers
 612                                  */
 613   char *d_filename;             /* filename to be used for the
 614                                  * content-disposition header.
 615                                  * If NULL, filename is used
 616                                  * instead.
 617                                  */
 618   char *file_charset;           /* charset of attached file */
 619   CONTENT *content;             /* structure used to store detailed info about
 620                                  * the content of the attachment.  this is used
 621                                  * to determine what content-transfer-encoding
 622                                  * is required when sending mail.
 623                                  */
 624   struct body *next;            /* next attachment in the list */
 625   struct body *parts;           /* parts of a multipart or message/rfc822 */
 626   struct header *hdr;           /* header information for message/rfc822 */
 627
 628   struct attachptr *aptr;       /* Menu information, used in recvattach.c */
 629
 630   signed short attach_count;
 631
 632   time_t stamp;                 /* time stamp of last
 633                                  * encoding update.
 634                                  */
 635
 636   unsigned int type:4;          /* content-type primary type */
 637   unsigned int encoding:3;      /* content-transfer-encoding */
 638   unsigned int disposition:2;   /* content-disposition */
 639   unsigned int use_disp:1;      /* Content-Disposition uses filename= ? */
 640   unsigned int unlink:1;        /* flag to indicate the the file named by
 641                                  * "filename" should be unlink()ed before
 642                                  * free()ing this structure
 643                                  */
 644   unsigned int tagged:1;
 645   unsigned int deleted:1;       /* attachment marked for deletion */
 646
 647   unsigned int noconv:1;        /* don't do character set conversion */
 648   unsigned int force_charset:1;
 649   /* send mode: don't adjust the character
 650    * set when in send-mode.
 651    */
 652   unsigned int is_signed_data:1;        /* A lot of MUAs don't indicate
 653                                            S/MIME signed-data correctly,
 654                                            e.g. they use foo.p7m even for
 655                                            the name of signed data.  This
 656                                            flag is used to keep track of
 657                                            the actual message type.  It
 658                                            gets set during the verification
 659                                            (which is done if the encryption
 660                                            try failed) and check by the
 661                                            function to figure the type of
 662                                            the message. */
 663
 664   unsigned int goodsig:1;       /* good cryptographic signature */
 665   unsigned int warnsig:1;       /* maybe good signature */
 666   unsigned int badsig:1;        /* bad cryptographic signature (needed to check encrypted s/mime-signatures) */
 667
 668   unsigned int collapsed:1;     /* used by recvattach */
 669   unsigned int attach_qualifies:1;
 670
 671 } BODY;
 672
 673 typedef struct header {
 674   unsigned int security:11;     /* bit 0-6: flags, bit 7,8: application.
 675                                    see: crypt.h pgplib.h, smime.h */
 676
 677   unsigned int mime:1;          /* has a MIME-Version header? */
 678   unsigned int flagged:1;       /* marked important? */
 679   unsigned int tagged:1;
 680   unsigned int appended:1;      /* has been saved */
 681   unsigned int purged:1;        /* bypassing the trash folder */
 682   unsigned int deleted:1;
 683   unsigned int changed:1;
 684   unsigned int attach_del:1;    /* has an attachment marked for deletion */
 685   unsigned int old:1;
 686   unsigned int read:1;
 687   unsigned int expired:1;       /* already expired? */
 688   unsigned int superseded:1;    /* got superseded? */
 689   unsigned int replied:1;
 690   unsigned int subject_changed:1;       /* used for threading */
 691   unsigned int threaded:1;      /* used for threading */
 692   unsigned int display_subject:1;       /* used for threading */
 693   unsigned int recip_valid:1;   /* is_recipient is valid */
 694   unsigned int active:1;        /* message is not to be removed */
 695   unsigned int trash:1;         /* message is marked as trashed on disk.
 696                                  * This flag is used by the maildir_trash
 697                                  * option.
 698                                  */
 699
 700   /* timezone of the sender of this message */
 701   unsigned int zhours:5;
 702   unsigned int zminutes:6;
 703   unsigned int zoccident:1;
 704
 705   /* bits used for caching when searching */
 706   unsigned int searched:1;
 707   unsigned int matched:1;
 708
 709   /* tells whether the attach count is valid */
 710   unsigned int attach_valid:1;
 711
 712   /* the following are used to support collapsing threads  */
 713   unsigned int collapsed:1;     /* is this message part of a collapsed thread? */
 714   unsigned int limited:1;       /* is this message in a limited view?  */
 715   size_t num_hidden;            /* number of hidden messages in this view */
 716
 717   short recipient;              /* user_is_recipient()'s return value, cached */
 718
 719   int pair;                     /* color-pair to use when displaying in the index */
 720
 721   time_t date_sent;             /* time when the message was sent (UTC) */
 722   time_t received;              /* time when the message was placed in the mailbox */
 723   off_t offset;                 /* where in the stream does this message begin? */
 724   int lines;                    /* how many lines in the body of this message? */
 725   int index;                    /* the absolute (unsorted) message number */
 726   int msgno;                    /* number displayed to the user */
 727   int virtual;                  /* virtual message number */
 728   int score;
 729   ENVELOPE *env;                /* envelope information */
 730   BODY *content;                /* list of MIME parts */
 731   char *path;
 732 #ifdef USE_NNTP
 733   int article_num;
 734 #endif
 735
 736   char *tree;                   /* character string to print thread tree */
 737   struct thread *thread;
 738
 739   short attach_total;
 740
 741 #ifdef MIXMASTER
 742   LIST *chain;
 743 #endif
 744
 745 #ifdef USE_POP
 746   int refno;                    /* message number on server */
 747 #endif
 748
 749 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
 750   void *data;                   /* driver-specific data */
 751 #endif
 752
 753   char *maildir_flags;          /* unknown maildir flags */
 754 } HEADER;
 755
 756 typedef struct thread {
 757   unsigned int fake_thread:1;
 758   unsigned int duplicate_thread:1;
 759   unsigned int sort_children:1;
 760   unsigned int check_subject:1;
 761   unsigned int visible:1;
 762   unsigned int deep:1;
 763   unsigned int subtree_visible:2;
 764   unsigned int next_subtree_visible:1;
 765   struct thread *parent;
 766   struct thread *child;
 767   struct thread *next;
 768   struct thread *prev;
 769   HEADER *message;
 770   HEADER *sort_key;
 771 } THREAD;
 772
 773
 774 /* flag to mutt_pattern_comp() */
 775 #define M_FULL_MSG      (1<<0)       /* enable body and header matching */
 776
 777 typedef enum {
 778   M_MATCH_FULL_ADDRESS = 1
 779 } pattern_exec_flag;
 780
 781 typedef struct pattern_t {
 782   short op;
 783   unsigned int not : 1;
 784   unsigned int alladdr : 1;
 785   unsigned int stringmatch : 1;
 786   int min;
 787   int max;
 788   struct pattern_t *next;
 789   struct pattern_t *child;      /* arguments to logical op */
 790   char* str;
 791   regex_t *rx;
 792 } pattern_t;
 793
 794 typedef struct {
 795   char *path;
 796   FILE *fp;
 797   time_t mtime;
 798   time_t mtime_cur;             /* used with maildir folders */
 799   off_t size;
 800   off_t vsize;
 801   char *pattern;                /* limit pattern string */
 802   pattern_t *limit_pattern;     /* compiled limit pattern */
 803   HEADER **hdrs;
 804   HEADER *last_tag;             /* last tagged msg. used to link threads */
 805   THREAD *tree;                 /* top of thread tree */
 806   HASH *id_hash;                /* hash table by msg id */
 807   HASH *subj_hash;              /* hash table by subject */
 808   HASH *thread_hash;            /* hash table for threading */
 809   int *v2r;                     /* mapping from virtual to real msgno */
 810   int hdrmax;                   /* number of pointers in hdrs */
 811   int msgcount;                 /* number of messages in the mailbox */
 812   int vcount;                   /* the number of virtual messages */
 813   int tagged;                   /* how many messages are tagged? */
 814   int new;                      /* how many new messages? */
 815   int unread;                   /* how many unread messages? */
 816   int deleted;                  /* how many deleted messages */
 817   int appended;                 /* how many saved messages? */
 818   int flagged;                  /* how many flagged messages */
 819   int msgnotreadyet;            /* which msg "new" in pager, -1 if none */
 820 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
 821   void *data;                   /* driver specific data */
 822 #endif                          /* USE_IMAP */
 823
 824   short magic;                  /* mailbox type */
 825
 826 #ifdef USE_COMPRESSED
 827   void *compressinfo;           /* compressed mbox module private data */
 828   char *realpath;               /* path to compressed mailbox */
 829 #endif                          /* USE_COMPRESSED */
 830
 831   unsigned int locked:1;        /* is the mailbox locked? */
 832   unsigned int changed:1;       /* mailbox has been modified */
 833   unsigned int readonly:1;      /* don't allow changes to the mailbox */
 834   unsigned int dontwrite:1;     /* dont write the mailbox on close */
 835   unsigned int append:1;        /* mailbox is opened in append mode */
 836   unsigned int quiet:1;         /* inhibit status messages? */
 837   unsigned int collapsed:1;     /* are all threads collapsed? */
 838   unsigned int closing:1;       /* mailbox is being closed */
 839   unsigned int counting:1;      /* do we just want to cound? */
 840 } CONTEXT;
 841
 842 /* for attachment counter */
 843 typedef struct {
 844   char *major;
 845   int major_int;
 846   const char *minor;
 847   regex_t minor_rx;
 848 } ATTACH_MATCH;
 849
 850 /* Flags for mutt_count_body_parts() */
 851 #define M_PARTS_TOPLEVEL (1<<0) /* is the top-level part */
 852 #define M_PARTS_RECOUNT (1<<1) /* force recount */
 853
 854 #include "protos.h"
 855 #include "lib.h"
 856 #include "globals.h"
 857
 858 #endif /* !_MUTT_H */