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 "rfc822.h"
  45 #include "list.h"
  46 #include "hash.h"
  47 #include "charset.h"
  48 #include "lib/rx.h"
  49
  50 #ifndef HAVE_WC_FUNCS
  51 # ifdef MB_LEN_MAX
  52 #  undef MB_LEN_MAX
  53 # endif
  54 # define MB_LEN_MAX 16
  55 #endif
  56
  57 # define MUTT_VERSION (VERSION)
  58
  59 /* nifty trick I stole from ELM 2.5alpha. */
  60 #ifdef MAIN_C
  61 #define WHERE
  62 #define INITVAL(x) = x
  63 #else
  64 #define WHERE extern
  65 #define INITVAL(x)
  66 #endif
  67
  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 */
  76
  77 typedef struct {
  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? */
  82 } BUFFER;
  83
  84 typedef struct {
  85   int ch;                       /* raw key pressed */
  86   int op;                       /* function op */
  87 } event_t;
  88
  89 /* flags for _mutt_system() */
  90 #define M_DETACH_PROCESS        1       /* detach subprocess from group */
  91
  92 /* flags for mutt_FormatString() */
  93 typedef enum {
  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 */
 101 } format_flag;
 102
 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)
 116
 117 #ifdef USE_COMPRESSED
 118 #define M_OPENHOOK      (1<<12)
 119 #define M_APPENDHOOK    (1<<13)
 120 #define M_CLOSEHOOK     (1<<14)
 121 #endif
 122
 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
 138
 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)
 144
 145 enum {
 146   /* modes for mutt_view_attachment() */
 147   M_REGULAR = 1,
 148   M_MAILCAP,
 149   M_AS_TEXT,
 150
 151   /* action codes used by mutt_set_flag() and mutt_pattern_function() */
 152   M_ALL,
 153   M_NONE,
 154   M_NEW,
 155   M_OLD,
 156   M_REPLIED,
 157   M_READ,
 158   M_UNREAD,
 159   M_DELETE,
 160   M_UNDELETE,
 161   M_DELETED,
 162   M_APPENDED,
 163   M_PURGED,
 164   M_FLAG,
 165   M_TAG,
 166   M_UNTAG,
 167   M_LIMIT,
 168   M_EXPIRED,
 169   M_SUPERSEDED,
 170   M_REALNAME,
 171
 172   /* actions for mutt_pattern_comp/mutt_pattern_exec */
 173   M_AND,
 174   M_OR,
 175   M_TO,
 176   M_CC,
 177   M_COLLAPSED,
 178   M_SUBJECT,
 179   M_FROM,
 180   M_DATE,
 181   M_DATE_RECEIVED,
 182   M_DUPLICATED,
 183   M_UNREFERENCED,
 184   M_ID,
 185   M_BODY,
 186   M_HEADER,
 187   M_HORMEL,
 188   M_WHOLE_MSG,
 189   M_SENDER,
 190   M_MESSAGE,
 191   M_SCORE,
 192   M_SIZE,
 193   M_REFERENCE,
 194   M_RECIPIENT,
 195   M_LIST,
 196   M_PERSONAL_RECIP,
 197   M_PERSONAL_FROM,
 198   M_ADDRESS,
 199   M_CRYPT_SIGN,
 200   M_CRYPT_VERIFIED,
 201   M_CRYPT_ENCRYPT,
 202   M_PGP_KEY,
 203   M_XLABEL,
 204 #ifdef USE_NNTP
 205   M_NEWSGROUPS,
 206 #endif
 207
 208   /* Options for Mailcap lookup */
 209   M_EDIT,
 210   M_COMPOSE,
 211   M_PRINT,
 212   M_AUTOVIEW,
 213
 214   /* options for socket code */
 215   M_NEW_SOCKET,
 216 #ifdef USE_SSL
 217   M_NEW_SSL_SOCKET,
 218 #endif
 219
 220   /* Options for mutt_save_attachment */
 221   M_SAVE_APPEND,
 222   M_SAVE_OVERWRITE
 223 };
 224
 225 /* possible arguments to set_quadoption() */
 226 enum {
 227   M_NO,
 228   M_YES,
 229   M_ASKNO,
 230   M_ASKYES
 231 };
 232
 233 /* quad-option vars */
 234 enum {
 235   OPT_ABORT,
 236   OPT_ATTACH,
 237   OPT_BOUNCE,
 238   OPT_COPY,
 239   OPT_DELETE,
 240   OPT_FORWEDIT,
 241   OPT_INCLUDE,
 242 #ifdef USE_IMAP
 243   OPT_IMAPRECONNECT,
 244 #endif
 245   OPT_MFUPTO,
 246   OPT_MIMEFWD,
 247   OPT_MIMEFWDREST,
 248   OPT_MOVE,
 249   OPT_PGPMIMEAUTO,              /* ask to revert to PGP/MIME when inline fails */
 250 #ifdef USE_POP
 251   OPT_POPDELETE,
 252   OPT_POPRECONNECT,
 253 #endif
 254   OPT_POSTPONE,
 255   OPT_PRINT,
 256   OPT_QUIT,
 257   OPT_REPLYTO,
 258   OPT_RECALL,
 259 #if defined(USE_SSL) || defined(USE_GNUTLS)
 260   OPT_SSLSTARTTLS,
 261 #endif
 262   OPT_SUBJECT,
 263   OPT_VERIFYSIG,                /* verify PGP signatures */
 264   OPT_LISTREPLY,
 265 #ifdef USE_NNTP
 266   OPT_TOMODERATED,
 267   OPT_NNTPRECONNECT,
 268   OPT_CATCHUP,
 269   OPT_FOLLOWUPTOPOSTER,
 270 #endif                          /* USE_NNTP */
 271
 272   /* THIS MUST BE THE LAST VALUE. */
 273   OPT_MAX
 274 };
 275
 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)
 287
 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)
 292
 293 /* flags for parse_spam_list */
 294 #define M_SPAM          1
 295 #define M_NOSPAM        2
 296
 297 /* boolean vars */
 298 enum {
 299   OPTALLOW8BIT,
 300   OPTALLOWANSI,
 301   OPTARROWCURSOR,
 302   OPTASCIICHARS,
 303   OPTASKBCC,
 304   OPTASKCC,
 305   OPTASKFOLLOWUP,
 306   OPTASKXCOMMENTTO,
 307   OPTATTACHSPLIT,
 308   OPTAUTOEDIT,
 309   OPTAUTOTAG,
 310   OPTBEEP,
 311   OPTBEEPNEW,
 312   OPTBOUNCEDELIVERED,
 313   OPTBRAILLEFRIENDLY,
 314   OPTCHECKNEW,
 315   OPTCOLLAPSEUNREAD,
 316   OPTCONFIRMAPPEND,
 317   OPTCONFIRMCREATE,
 318   OPTDELETEUNTAG,
 319   OPTDELSP,
 320   OPTDIGESTCOLLAPSE,
 321   OPTDUPTHREADS,
 322   OPTEDITHDRS,
 323   OPTENCODEFROM,
 324   OPTENVFROM,
 325   OPTFASTREPLY,
 326   OPTFCCATTACH,
 327   OPTFCCCLEAR,
 328   OPTFOLLOWUPTO,
 329   OPTFORCEBUFFYCHECK,
 330   OPTFORCENAME,
 331   OPTFORWDECODE,
 332   OPTFORWQUOTE,
 333 #if USE_HCACHE
 334   OPTHCACHEVERIFY,
 335 #if HAVE_QDBM
 336   OPTHCACHECOMPRESS,
 337 #endif /* HAVE_QDBM */
 338 #endif
 339   OPTHDRS,
 340   OPTHEADER,
 341   OPTHELP,
 342   OPTHIDDENHOST,
 343   OPTHIDELIMITED,
 344   OPTHIDEMISSING,
 345   OPTHIDETHREADSUBJECT,
 346   OPTHIDETOPLIMITED,
 347   OPTHIDETOPMISSING,
 348   OPTIGNORELISTREPLYTO,
 349 #ifdef USE_IMAP
 350   OPTIMAPCHECKSUBSCRIBED,
 351   OPTIMAPLSUB,
 352   OPTIMAPPASSIVE,
 353   OPTIMAPPEEK,
 354   OPTIMAPSERVERNOISE,
 355 #endif
 356 #if defined(USE_SSL) || defined(USE_GNUTLS)
 357 # ifndef USE_GNUTLS
 358   OPTSSLSYSTEMCERTS,
 359   OPTSSLV2,
 360 # endif /* !USE_GNUTLS */
 361   OPTSSLV3,
 362   OPTTLSV1,
 363   OPTSSLFORCETLS,
 364 #endif /* USE_SSL || USE_GNUTLS */
 365   OPTIMPLICITAUTOVIEW,
 366   OPTINCLUDEONLYFIRST,
 367   OPTKEEPFLAGGED,
 368   OPTMAILCAPSANITIZE,
 369   OPTMAILDIRTRASH,
 370   OPTMARKERS,
 371   OPTMARKOLD,
 372   OPTMBOXPANE,
 373   OPTMENUSCROLL,                /* scroll menu instead of implicit next-page */
 374   OPTMENUMOVEOFF,
 375   OPTMETAKEY,                   /* interpret ALT-x as ESC-x */
 376   OPTMETOO,
 377   OPTMHPURGE,
 378   OPTMIMEFORWDECODE,
 379 #ifdef USE_NNTP
 380   OPTMIMESUBJECT,               /* encode subject line with RFC2047 */
 381 #endif
 382   OPTNARROWTREE,
 383   OPTPAGERSTOP,
 384   OPTPIPEDECODE,
 385   OPTPIPESPLIT,
 386 #ifdef USE_POP
 387   OPTPOPAUTHTRYALL,
 388   OPTPOPLAST,
 389 #endif
 390   OPTPRINTDECODE,
 391   OPTPRINTSPLIT,
 392   OPTPROMPTAFTER,
 393   OPTQUOTEEMPTY,
 394   OPTQUOTEQUOTED,
 395   OPTREADONLY,
 396   OPTREPLYSELF,
 397   OPTRESOLVE,
 398   OPTREVALIAS,
 399   OPTREVNAME,
 400   OPTREVREAL,
 401   OPTRFC2047PARAMS,
 402   OPTSAVEADDRESS,
 403   OPTSAVEEMPTY,
 404   OPTSAVENAME,
 405   OPTSCORE,
 406   OPTSIGDASHES,
 407   OPTSIGONTOP,
 408   OPTSORTRE,
 409   OPTSPAMSEP,
 410   OPTSTATUSONTOP,
 411   OPTSTRICTMAILTO,
 412   OPTSTRICTMIME,
 413   OPTSTRICTTHREADS,
 414   OPTSTRIPWAS,
 415   OPTSTUFFQUOTED,
 416   OPTSUSPEND,
 417   OPTTEXTFLOWED,
 418   OPTTHOROUGHSRC,
 419   OPTTHREADRECEIVED,
 420   OPTTILDE,
 421   OPTUNCOLLAPSEJUMP,
 422   OPTUSE8BITMIME,
 423   OPTUSEDOMAIN,
 424   OPTUSEFROM,
 425   OPTUSEGPGAGENT,
 426 #ifdef HAVE_LIBIDN
 427   OPTUSEIDN,
 428 #endif
 429 #ifdef HAVE_GETADDRINFO
 430   OPTUSEIPV6,
 431 #endif
 432   OPTWAITKEY,
 433   OPTWEED,
 434   OPTWRAP,
 435   OPTWRAPSEARCH,
 436   OPTWRITEBCC,                  /* write out a bcc header? */
 437   OPTXMAILER,
 438   OPTXMAILTO,                   /* 1 if $edit_header is forcebly set */
 439   OPTXTERMSETTITLES,
 440
 441   OPTCRYPTUSEGPGME,
 442
 443   /* PGP options */
 444
 445   OPTCRYPTAUTOSIGN,
 446   OPTCRYPTAUTOENCRYPT,
 447   OPTCRYPTAUTOPGP,
 448   OPTCRYPTAUTOSMIME,
 449   OPTCRYPTREPLYENCRYPT,
 450   OPTCRYPTREPLYSIGN,
 451   OPTCRYPTREPLYSIGNENCRYPTED,
 452   OPTCRYPTTIMESTAMP,
 453   OPTSMIMEISDEFAULT,
 454   OPTASKCERTLABEL,
 455   OPTSDEFAULTDECRYPTKEY,
 456   OPTPGPIGNORESUB,
 457   OPTPGPCHECKEXIT,
 458   OPTPGPLONGIDS,
 459   OPTPGPAUTODEC,
 460 #if 0
 461   OPTPGPENCRYPTSELF,
 462 #endif
 463   OPTPGPRETAINABLESIG,
 464   OPTPGPSTRICTENC,
 465   OPTFORWDECRYPT,
 466   OPTPGPSHOWUNUSABLE,
 467   OPTPGPAUTOINLINE,
 468   OPTPGPREPLYINLINE,
 469
 470   /* news options */
 471
 472 #ifdef USE_NNTP
 473   OPTSHOWNEWNEWS,
 474   OPTSHOWONLYUNREAD,
 475   OPTSAVEUNSUB,
 476   OPTLOADDESC,
 477   OPTXCOMMENTTO,
 478 #endif                          /* USE_NNTP */
 479
 480   /* pseudo options */
 481
 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
 503                                  *          external program.
 504                                  */
 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 */
 510
 511 #ifdef USE_NNTP
 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 */
 515 #endif
 516   OPTSHORTENHIERARCHY,          /* set when to shorten "hierarchies" in the sidebar */
 517   OPTSIDEBARNEWMAILONLY,
 518   OPTMAX
 519 };
 520
 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)))
 526
 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)
 531
 532 typedef struct spam_list_t {
 533   rx_t *rx;
 534   int nmatch;
 535   char *template;
 536   struct spam_list_t *next;
 537 } SPAM_LIST;
 538
 539
 540 #define mutt_new_spam_list() mem_calloc (1, sizeof (SPAM_LIST))
 541 void mutt_free_spam_list (SPAM_LIST **);
 542
 543 int mutt_matches_ignore (const char *, LIST *);
 544
 545 void mutt_init (int, LIST *);
 546
 547 typedef struct envelope {
 548   ADDRESS *return_path;
 549   ADDRESS *from;
 550   ADDRESS *to;
 551   ADDRESS *cc;
 552   ADDRESS *bcc;
 553   ADDRESS *sender;
 554   ADDRESS *reply_to;
 555   ADDRESS *mail_followup_to;
 556   char *list_post;              /* this stores a mailto URL, or nothing */
 557   char *subject;
 558   char *real_subj;              /* offset of the real subject */
 559   char *message_id;
 560   char *supersedes;
 561   char *date;
 562   char *x_label;
 563   char *organization;
 564 #ifdef USE_NNTP
 565   char *newsgroups;
 566   char *xref;
 567   char *followup_to;
 568   char *x_comment_to;
 569 #endif
 570   BUFFER *spam;
 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 */
 576 } ENVELOPE;
 577
 578 typedef struct parameter {
 579   char *attribute;
 580   char *value;
 581   struct parameter *next;
 582 } PARAMETER;
 583
 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 */
 596 } CONTENT;
 597
 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
 607                                  * attachment
 608                                  */
 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
 613                                  */
 614   char *d_filename;             /* filename to be used for the
 615                                  * content-disposition header.
 616                                  * If NULL, filename is used
 617                                  * instead.
 618                                  */
 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.
 624                                  */
 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 */
 628
 629   struct attachptr *aptr;       /* Menu information, used in recvattach.c */
 630
 631   time_t stamp;                 /* time stamp of last
 632                                  * encoding update.
 633                                  */
 634
 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
 642                                  */
 643   unsigned int tagged:1;
 644   unsigned int deleted:1;       /* attachment marked for deletion */
 645
 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.
 650    */
 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
 661                                            the message. */
 662
 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) */
 666
 667   unsigned int collapsed:1;     /* used by recvattach */
 668
 669 } BODY;
 670
 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 */
 674
 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 */
 683   unsigned int old:1;
 684   unsigned int read:1;
 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
 695                                  * option.
 696                                  */
 697
 698   /* timezone of the sender of this message */
 699   unsigned int zhours:5;
 700   unsigned int zminutes:6;
 701   unsigned int zoccident:1;
 702
 703   /* bits used for caching when searching */
 704   unsigned int searched:1;
 705   unsigned int matched:1;
 706
 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 */
 711
 712   short recipient;              /* user_is_recipient()'s return value, cached */
 713
 714   int pair;                     /* color-pair to use when displaying in the index */
 715
 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 */
 723   int score;
 724   ENVELOPE *env;                /* envelope information */
 725   BODY *content;                /* list of MIME parts */
 726   char *path;
 727 #ifdef USE_NNTP
 728   int article_num;
 729 #endif
 730
 731   char *tree;                   /* character string to print thread tree */
 732   struct thread *thread;
 733
 734 #ifdef MIXMASTER
 735   LIST *chain;
 736 #endif
 737
 738 #ifdef USE_POP
 739   int refno;                    /* message number on server */
 740 #endif
 741
 742 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
 743   void *data;                   /* driver-specific data */
 744 #endif
 745
 746   char *maildir_flags;          /* unknown maildir flags */
 747 } HEADER;
 748
 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;
 755   unsigned int deep:1;
 756   unsigned int subtree_visible:2;
 757   unsigned int next_subtree_visible:1;
 758   struct thread *parent;
 759   struct thread *child;
 760   struct thread *next;
 761   struct thread *prev;
 762   HEADER *message;
 763   HEADER *sort_key;
 764 } THREAD;
 765
 766
 767 /* flag to mutt_pattern_comp() */
 768 #define M_FULL_MSG      1       /* enable body and header matching */
 769
 770 typedef enum {
 771   M_MATCH_FULL_ADDRESS = 1
 772 } pattern_exec_flag;
 773
 774 typedef struct pattern_t {
 775   short op;
 776   short not;
 777   short alladdr;
 778   int min;
 779   int max;
 780   struct pattern_t *next;
 781   struct pattern_t *child;      /* arguments to logical op */
 782   regex_t *rx;
 783 } pattern_t;
 784
 785 typedef struct {
 786   char *path;
 787   FILE *fp;
 788   time_t mtime;
 789   time_t mtime_cur;             /* used with maildir folders */
 790   off_t size;
 791   off_t vsize;
 792   char *pattern;                /* limit pattern string */
 793   pattern_t *limit_pattern;     /* compiled limit pattern */
 794   HEADER **hdrs;
 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 */
 814
 815   short magic;                  /* mailbox type */
 816
 817 #ifdef USE_COMPRESSED
 818   void *compressinfo;           /* compressed mbox module private data */
 819   char *realpath;               /* path to compressed mailbox */
 820 #endif                          /* USE_COMPRESSED */
 821
 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? */
 831 } CONTEXT;
 832
 833 #include "protos.h"
 834 #include "lib.h"
 835 #include "globals.h"
 836
 837 #endif /* !_MUTT_H */