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_BOUNCE,
 237   OPT_COPY,
 238   OPT_DELETE,
 239   OPT_FORWEDIT,
 240   OPT_INCLUDE,
 241 #ifdef USE_IMAP
 242   OPT_IMAPRECONNECT,
 243 #endif
 244   OPT_MFUPTO,
 245   OPT_MIMEFWD,
 246   OPT_MIMEFWDREST,
 247   OPT_MOVE,
 248   OPT_PGPMIMEAUTO,              /* ask to revert to PGP/MIME when inline fails */
 249 #ifdef USE_POP
 250   OPT_POPDELETE,
 251   OPT_POPRECONNECT,
 252 #endif
 253   OPT_POSTPONE,
 254   OPT_PRINT,
 255   OPT_QUIT,
 256   OPT_REPLYTO,
 257   OPT_RECALL,
 258 #if defined(USE_SSL) || defined(USE_GNUTLS)
 259   OPT_SSLSTARTTLS,
 260 #endif
 261   OPT_SUBJECT,
 262   OPT_VERIFYSIG,                /* verify PGP signatures */
 263   OPT_LISTREPLY,
 264 #ifdef USE_NNTP
 265   OPT_TOMODERATED,
 266   OPT_NNTPRECONNECT,
 267   OPT_CATCHUP,
 268   OPT_FOLLOWUPTOPOSTER,
 269 #endif                          /* USE_NNTP */
 270
 271   /* THIS MUST BE THE LAST VALUE. */
 272   OPT_MAX
 273 };
 274
 275 /* flags to ci_send_message() */
 276 #define SENDREPLY       (1<<0)
 277 #define SENDGROUPREPLY  (1<<1)
 278 #define SENDLISTREPLY   (1<<2)
 279 #define SENDFORWARD     (1<<3)
 280 #define SENDPOSTPONED   (1<<4)
 281 #define SENDBATCH       (1<<5)
 282 #define SENDMAILX       (1<<6)
 283 #define SENDKEY         (1<<7)
 284 #define SENDRESEND      (1<<8)
 285 #define SENDNEWS        (1<<9)
 286
 287 /* flags to _mutt_select_file() */
 288 #define M_SEL_BUFFY     (1<<0)
 289 #define M_SEL_MULTI     (1<<1)
 290 #define M_SEL_FOLDER    (1<<2)
 291
 292 /* flags for parse_spam_list */
 293 #define M_SPAM          1
 294 #define M_NOSPAM        2
 295
 296 /* boolean vars */
 297 enum {
 298   OPTALLOW8BIT,
 299   OPTALLOWANSI,
 300   OPTARROWCURSOR,
 301   OPTASCIICHARS,
 302   OPTASKBCC,
 303   OPTASKCC,
 304   OPTASKFOLLOWUP,
 305   OPTASKXCOMMENTTO,
 306   OPTATTACHSPLIT,
 307   OPTAUTOEDIT,
 308   OPTAUTOTAG,
 309   OPTBEEP,
 310   OPTBEEPNEW,
 311   OPTBOUNCEDELIVERED,
 312   OPTBRAILLEFRIENDLY,
 313   OPTCHECKNEW,
 314   OPTCOLLAPSEUNREAD,
 315   OPTCONFIRMAPPEND,
 316   OPTCONFIRMCREATE,
 317   OPTDELETEUNTAG,
 318   OPTDIGESTCOLLAPSE,
 319   OPTDUPTHREADS,
 320   OPTEDITHDRS,
 321   OPTENCODEFROM,
 322   OPTENVFROM,
 323   OPTFASTREPLY,
 324   OPTFCCATTACH,
 325   OPTFCCCLEAR,
 326   OPTFOLLOWUPTO,
 327   OPTFORCEBUFFYCHECK,
 328   OPTFORCENAME,
 329   OPTFORWDECODE,
 330   OPTFORWQUOTE,
 331 #if USE_HCACHE
 332   OPTHCACHEVERIFY,
 333 #if HAVE_QDBM
 334   OPTHCACHECOMPRESS,
 335 #endif /* HAVE_QDBM */
 336 #endif
 337   OPTHDRS,
 338   OPTHEADER,
 339   OPTHELP,
 340   OPTHIDDENHOST,
 341   OPTHIDELIMITED,
 342   OPTHIDEMISSING,
 343   OPTHIDETHREADSUBJECT,
 344   OPTHIDETOPLIMITED,
 345   OPTHIDETOPMISSING,
 346   OPTIGNORELISTREPLYTO,
 347 #ifdef USE_IMAP
 348   OPTIMAPCHECKSUBSCRIBED,
 349   OPTIMAPLSUB,
 350   OPTIMAPPASSIVE,
 351   OPTIMAPPEEK,
 352   OPTIMAPSERVERNOISE,
 353 #endif
 354 #if defined(USE_SSL) || defined(USE_GNUTLS)
 355 # ifndef USE_GNUTLS
 356   OPTSSLSYSTEMCERTS,
 357   OPTSSLV2,
 358 # endif /* !USE_GNUTLS */
 359   OPTSSLV3,
 360   OPTTLSV1,
 361   OPTSSLFORCETLS,
 362 #endif /* USE_SSL || USE_GNUTLS */
 363   OPTIMPLICITAUTOVIEW,
 364   OPTINCLUDEONLYFIRST,
 365   OPTKEEPFLAGGED,
 366   OPTMAILCAPSANITIZE,
 367   OPTMAILDIRTRASH,
 368   OPTMARKERS,
 369   OPTMARKOLD,
 370   OPTMBOXPANE,
 371   OPTMENUSCROLL,                /* scroll menu instead of implicit next-page */
 372   OPTMENUMOVEOFF,
 373   OPTMETAKEY,                   /* interpret ALT-x as ESC-x */
 374   OPTMETOO,
 375   OPTMHPURGE,
 376   OPTMIMEFORWDECODE,
 377 #ifdef USE_NNTP
 378   OPTMIMESUBJECT,               /* encode subject line with RFC2047 */
 379 #endif
 380   OPTNARROWTREE,
 381   OPTPAGERSTOP,
 382   OPTPIPEDECODE,
 383   OPTPIPESPLIT,
 384 #ifdef USE_POP
 385   OPTPOPAUTHTRYALL,
 386   OPTPOPLAST,
 387 #endif
 388   OPTPRINTDECODE,
 389   OPTPRINTSPLIT,
 390   OPTPROMPTAFTER,
 391   OPTQUOTEEMPTY,
 392   OPTQUOTEQUOTED,
 393   OPTREADONLY,
 394   OPTREPLYSELF,
 395   OPTRESOLVE,
 396   OPTREVALIAS,
 397   OPTREVNAME,
 398   OPTREVREAL,
 399   OPTRFC2047PARAMS,
 400   OPTSAVEADDRESS,
 401   OPTSAVEEMPTY,
 402   OPTSAVENAME,
 403   OPTSCORE,
 404   OPTSIGDASHES,
 405   OPTSIGONTOP,
 406   OPTSORTRE,
 407   OPTSPAMSEP,
 408   OPTSTATUSONTOP,
 409   OPTSTRICTMAILTO,
 410   OPTSTRICTMIME,
 411   OPTSTRICTTHREADS,
 412   OPTSTRIPWAS,
 413   OPTSTUFFQUOTED,
 414   OPTSUSPEND,
 415   OPTTEXTFLOWED,
 416   OPTTHOROUGHSRC,
 417   OPTTHREADRECEIVED,
 418   OPTTILDE,
 419   OPTUNCOLLAPSEJUMP,
 420   OPTUSE8BITMIME,
 421   OPTUSEDOMAIN,
 422   OPTUSEFROM,
 423   OPTUSEGPGAGENT,
 424 #ifdef HAVE_LIBIDN
 425   OPTUSEIDN,
 426 #endif
 427 #ifdef HAVE_GETADDRINFO
 428   OPTUSEIPV6,
 429 #endif
 430   OPTWAITKEY,
 431   OPTWEED,
 432   OPTWRAP,
 433   OPTWRAPSEARCH,
 434   OPTWRITEBCC,                  /* write out a bcc header? */
 435   OPTXMAILER,
 436   OPTXTERMSETTITLES,
 437
 438   OPTCRYPTUSEGPGME,
 439
 440   /* PGP options */
 441
 442   OPTCRYPTAUTOSIGN,
 443   OPTCRYPTAUTOENCRYPT,
 444   OPTCRYPTAUTOPGP,
 445   OPTCRYPTAUTOSMIME,
 446   OPTCRYPTREPLYENCRYPT,
 447   OPTCRYPTREPLYSIGN,
 448   OPTCRYPTREPLYSIGNENCRYPTED,
 449   OPTCRYPTTIMESTAMP,
 450   OPTSMIMEISDEFAULT,
 451   OPTASKCERTLABEL,
 452   OPTSDEFAULTDECRYPTKEY,
 453   OPTPGPIGNORESUB,
 454   OPTPGPCHECKEXIT,
 455   OPTPGPLONGIDS,
 456   OPTPGPAUTODEC,
 457 #if 0
 458   OPTPGPENCRYPTSELF,
 459 #endif
 460   OPTPGPRETAINABLESIG,
 461   OPTPGPSTRICTENC,
 462   OPTFORWDECRYPT,
 463   OPTPGPSHOWUNUSABLE,
 464   OPTPGPAUTOINLINE,
 465   OPTPGPREPLYINLINE,
 466
 467   /* news options */
 468
 469 #ifdef USE_NNTP
 470   OPTSHOWNEWNEWS,
 471   OPTSHOWONLYUNREAD,
 472   OPTSAVEUNSUB,
 473   OPTLOADDESC,
 474   OPTXCOMMENTTO,
 475 #endif                          /* USE_NNTP */
 476
 477   /* pseudo options */
 478
 479   OPTAUXSORT,                   /* (pseudo) using auxillary sort function */
 480   OPTFORCEREFRESH,              /* (pseudo) refresh even during macros */
 481   OPTLOCALES,                   /* (pseudo) set if user has valid locale definition */
 482   OPTNOCURSES,                  /* (pseudo) when sending in batch mode */
 483   OPTNEEDREDRAW,                /* (pseudo) to notify caller of a submenu */
 484   OPTSEARCHREVERSE,             /* (pseudo) used by ci_search_command */
 485   OPTMSGERR,                    /* (pseudo) used by mutt_error/mutt_message */
 486   OPTSEARCHINVALID,             /* (pseudo) used to invalidate the search pat */
 487   OPTSIGNALSBLOCKED,            /* (pseudo) using by mutt_block_signals () */
 488   OPTSYSSIGNALSBLOCKED,         /* (pseudo) using by mutt_block_signals_system () */
 489   OPTNEEDRESORT,                /* (pseudo) used to force a re-sort */
 490   OPTRESORTINIT,                /* (pseudo) used to force the next resort to be from scratch */
 491   OPTVIEWATTACH,                /* (pseudo) signals that we are viewing attachments */
 492   OPTFORCEREDRAWINDEX,          /* (pseudo) used to force a redraw in the main index */
 493   OPTFORCEREDRAWPAGER,          /* (pseudo) used to force a redraw in the pager */
 494   OPTSORTSUBTHREADS,            /* (pseudo) used when $sort_aux changes */
 495   OPTNEEDRESCORE,               /* (pseudo) set when the `score' command is used */
 496   OPTATTACHMSG,                 /* (pseudo) used by attach-message */
 497   OPTHIDEREAD,                  /* (pseudo) whether or not hide read messages */
 498   OPTKEEPQUIET,                 /* (pseudo) shut up the message and refresh
 499                                  *          functions while we are executing an
 500                                  *          external program.
 501                                  */
 502   OPTMENUCALLER,                /* (pseudo) tell menu to give caller a take */
 503   OPTREDRAWTREE,                /* (pseudo) redraw the thread tree */
 504   OPTPGPCHECKTRUST,             /* (pseudo) used by pgp_select_key () */
 505   OPTDONTHANDLEPGPKEYS,         /* (pseudo) used to extract PGP keys */
 506   OPTUNBUFFEREDINPUT,           /* (pseudo) don't use key buffer */
 507
 508 #ifdef USE_NNTP
 509   OPTNEWS,                      /* (pseudo) used to change reader mode */
 510   OPTNEWSSEND,                  /* (pseudo) used to change behavior when posting */
 511   OPTNEWSCACHE,                 /* (pseudo) used to indicate if news cache exist */
 512 #endif
 513   OPTSHORTENHIERARCHY,          /* set when to shorten "hierarchies" in the sidebar */
 514   OPTSIDEBARNEWMAILONLY,
 515   OPTMAX
 516 };
 517
 518 #define mutt_bit_alloc(n) calloc ((n + 7) / 8, sizeof (char))
 519 #define mutt_bit_set(v,n) v[n/8] |= (1 << (n % 8))
 520 #define mutt_bit_unset(v,n) v[n/8] &= ~(1 << (n % 8))
 521 #define mutt_bit_toggle(v,n) v[n/8] ^= (1 << (n % 8))
 522 #define mutt_bit_isset(v,n) (v[n/8] & (1 << (n % 8)))
 523
 524 #define set_option(x) mutt_bit_set(Options,x)
 525 #define unset_option(x) mutt_bit_unset(Options,x)
 526 #define toggle_option(x) mutt_bit_toggle(Options,x)
 527 #define option(x) mutt_bit_isset(Options,x)
 528
 529 typedef struct spam_list_t {
 530   rx_t *rx;
 531   int nmatch;
 532   char *template;
 533   struct spam_list_t *next;
 534 } SPAM_LIST;
 535
 536
 537 #define mutt_new_spam_list() mem_calloc (1, sizeof (SPAM_LIST))
 538 void mutt_free_spam_list (SPAM_LIST **);
 539
 540 int mutt_matches_ignore (const char *, LIST *);
 541
 542 void mutt_init (int, LIST *);
 543
 544 typedef struct envelope {
 545   ADDRESS *return_path;
 546   ADDRESS *from;
 547   ADDRESS *to;
 548   ADDRESS *cc;
 549   ADDRESS *bcc;
 550   ADDRESS *sender;
 551   ADDRESS *reply_to;
 552   ADDRESS *mail_followup_to;
 553   char *list_post;              /* this stores a mailto URL, or nothing */
 554   char *subject;
 555   char *real_subj;              /* offset of the real subject */
 556   char *message_id;
 557   char *supersedes;
 558   char *date;
 559   char *x_label;
 560   char *organization;
 561 #ifdef USE_NNTP
 562   char *newsgroups;
 563   char *xref;
 564   char *followup_to;
 565   char *x_comment_to;
 566 #endif
 567   BUFFER *spam;
 568   LIST *references;             /* message references (in reverse order) */
 569   LIST *in_reply_to;            /* in-reply-to header content */
 570   LIST *userhdrs;               /* user defined headers */
 571   unsigned int irt_changed:1;   /* In-Reply-To changed to link/break threads */
 572   unsigned int refs_changed:1;  /* References changed to break thread */
 573 } ENVELOPE;
 574
 575 typedef struct parameter {
 576   char *attribute;
 577   char *value;
 578   struct parameter *next;
 579 } PARAMETER;
 580
 581 /* Information that helps in determing the Content-* of an attachment */
 582 typedef struct content {
 583   long hibin;                   /* 8-bit characters */
 584   long lobin;                   /* unprintable 7-bit chars (eg., control chars) */
 585   long crlf;                    /* '\r' and '\n' characters */
 586   long ascii;                   /* number of ascii chars */
 587   long linemax;                 /* length of the longest line in the file */
 588   unsigned int space:1;         /* whitespace at the end of lines? */
 589   unsigned int binary:1;        /* long lines, or CR not in CRLF pair */
 590   unsigned int from:1;          /* has a line beginning with "From "? */
 591   unsigned int dot:1;           /* has a line consisting of a single dot? */
 592   unsigned int cr:1;            /* has CR, even when in a CRLF pair */
 593 } CONTENT;
 594
 595 typedef struct body {
 596   char *xtype;                  /* content-type if x-unknown */
 597   char *subtype;                /* content-type subtype */
 598   PARAMETER *parameter;         /* parameters of the content-type */
 599   char *description;            /* content-description */
 600   char *form_name;              /* Content-Disposition form-data name param */
 601   long hdr_offset;              /* offset in stream where the headers begin.
 602                                  * this info is used when invoking metamail,
 603                                  * where we need to send the headers of the
 604                                  * attachment
 605                                  */
 606   long offset;                  /* offset where the actual data begins */
 607   long length;                  /* length (in bytes) of attachment */
 608   char *filename;               /* when sending a message, this is the file
 609                                  * to which this structure refers
 610                                  */
 611   char *d_filename;             /* filename to be used for the
 612                                  * content-disposition header.
 613                                  * If NULL, filename is used
 614                                  * instead.
 615                                  */
 616   char *file_charset;           /* charset of attached file */
 617   CONTENT *content;             /* structure used to store detailed info about
 618                                  * the content of the attachment.  this is used
 619                                  * to determine what content-transfer-encoding
 620                                  * is required when sending mail.
 621                                  */
 622   struct body *next;            /* next attachment in the list */
 623   struct body *parts;           /* parts of a multipart or message/rfc822 */
 624   struct header *hdr;           /* header information for message/rfc822 */
 625
 626   struct attachptr *aptr;       /* Menu information, used in recvattach.c */
 627
 628   time_t stamp;                 /* time stamp of last
 629                                  * encoding update.
 630                                  */
 631
 632   unsigned int type:4;          /* content-type primary type */
 633   unsigned int encoding:3;      /* content-transfer-encoding */
 634   unsigned int disposition:2;   /* content-disposition */
 635   unsigned int use_disp:1;      /* Content-Disposition uses filename= ? */
 636   unsigned int unlink:1;        /* flag to indicate the the file named by
 637                                  * "filename" should be unlink()ed before
 638                                  * free()ing this structure
 639                                  */
 640   unsigned int tagged:1;
 641   unsigned int deleted:1;       /* attachment marked for deletion */
 642
 643   unsigned int noconv:1;        /* don't do character set conversion */
 644   unsigned int force_charset:1;
 645   /* send mode: don't adjust the character
 646    * set when in send-mode.
 647    */
 648   unsigned int is_signed_data:1;        /* A lot of MUAs don't indicate
 649                                            S/MIME signed-data correctly,
 650                                            e.g. they use foo.p7m even for
 651                                            the name of signed data.  This
 652                                            flag is used to keep track of
 653                                            the actual message type.  It
 654                                            gets set during the verification
 655                                            (which is done if the encryption
 656                                            try failed) and check by the
 657                                            function to figure the type of
 658                                            the message. */
 659
 660   unsigned int goodsig:1;       /* good cryptographic signature */
 661   unsigned int warnsig:1;       /* maybe good signature */
 662   unsigned int badsig:1;        /* bad cryptographic signature (needed to check encrypted s/mime-signatures) */
 663
 664   unsigned int collapsed:1;     /* used by recvattach */
 665
 666 } BODY;
 667
 668 typedef struct header {
 669   unsigned int security:11;     /* bit 0-6: flags, bit 7,8: application.
 670                                    see: crypt.h pgplib.h, smime.h */
 671
 672   unsigned int mime:1;          /* has a Mime-Version header? */
 673   unsigned int flagged:1;       /* marked important? */
 674   unsigned int tagged:1;
 675   unsigned int appended:1;      /* has been saved */
 676   unsigned int purged:1;        /* bypassing the trash folder */
 677   unsigned int deleted:1;
 678   unsigned int changed:1;
 679   unsigned int attach_del:1;    /* has an attachment marked for deletion */
 680   unsigned int old:1;
 681   unsigned int read:1;
 682   unsigned int expired:1;       /* already expired? */
 683   unsigned int superseded:1;    /* got superseded? */
 684   unsigned int replied:1;
 685   unsigned int subject_changed:1;       /* used for threading */
 686   unsigned int threaded:1;      /* used for threading */
 687   unsigned int display_subject:1;       /* used for threading */
 688   unsigned int recip_valid:1;   /* is_recipient is valid */
 689   unsigned int active:1;        /* message is not to be removed */
 690   unsigned int trash:1;         /* message is marked as trashed on disk.
 691                                  * This flag is used by the maildir_trash
 692                                  * option.
 693                                  */
 694
 695   /* timezone of the sender of this message */
 696   unsigned int zhours:5;
 697   unsigned int zminutes:6;
 698   unsigned int zoccident:1;
 699
 700   /* bits used for caching when searching */
 701   unsigned int searched:1;
 702   unsigned int matched:1;
 703
 704   /* the following are used to support collapsing threads  */
 705   unsigned int collapsed:1;     /* is this message part of a collapsed thread? */
 706   unsigned int limited:1;       /* is this message in a limited view?  */
 707   size_t num_hidden;            /* number of hidden messages in this view */
 708
 709   short recipient;              /* user_is_recipient()'s return value, cached */
 710
 711   int pair;                     /* color-pair to use when displaying in the index */
 712
 713   time_t date_sent;             /* time when the message was sent (UTC) */
 714   time_t received;              /* time when the message was placed in the mailbox */
 715   long offset;                  /* where in the stream does this message begin? */
 716   int lines;                    /* how many lines in the body of this message? */
 717   int index;                    /* the absolute (unsorted) message number */
 718   int msgno;                    /* number displayed to the user */
 719   int virtual;                  /* virtual message number */
 720   int score;
 721   ENVELOPE *env;                /* envelope information */
 722   BODY *content;                /* list of MIME parts */
 723   char *path;
 724 #ifdef USE_NNTP
 725   int article_num;
 726 #endif
 727
 728   char *tree;                   /* character string to print thread tree */
 729   struct thread *thread;
 730
 731 #ifdef MIXMASTER
 732   LIST *chain;
 733 #endif
 734
 735 #ifdef USE_POP
 736   int refno;                    /* message number on server */
 737 #endif
 738
 739 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
 740   void *data;                   /* driver-specific data */
 741 #endif
 742
 743   char *maildir_flags;          /* unknown maildir flags */
 744 } HEADER;
 745
 746 typedef struct thread {
 747   unsigned int fake_thread:1;
 748   unsigned int duplicate_thread:1;
 749   unsigned int sort_children:1;
 750   unsigned int check_subject:1;
 751   unsigned int visible:1;
 752   unsigned int deep:1;
 753   unsigned int subtree_visible:2;
 754   unsigned int next_subtree_visible:1;
 755   struct thread *parent;
 756   struct thread *child;
 757   struct thread *next;
 758   struct thread *prev;
 759   HEADER *message;
 760   HEADER *sort_key;
 761 } THREAD;
 762
 763
 764 /* flag to mutt_pattern_comp() */
 765 #define M_FULL_MSG      1       /* enable body and header matching */
 766
 767 typedef enum {
 768   M_MATCH_FULL_ADDRESS = 1
 769 } pattern_exec_flag;
 770
 771 typedef struct pattern_t {
 772   short op;
 773   short not;
 774   short alladdr;
 775   int min;
 776   int max;
 777   struct pattern_t *next;
 778   struct pattern_t *child;      /* arguments to logical op */
 779   regex_t *rx;
 780 } pattern_t;
 781
 782 typedef struct {
 783   char *path;
 784   FILE *fp;
 785   time_t mtime;
 786   time_t mtime_cur;             /* used with maildir folders */
 787   off_t size;
 788   off_t vsize;
 789   char *pattern;                /* limit pattern string */
 790   pattern_t *limit_pattern;     /* compiled limit pattern */
 791   HEADER **hdrs;
 792   HEADER *last_tag;             /* last tagged msg. used to link threads */
 793   THREAD *tree;                 /* top of thread tree */
 794   HASH *id_hash;                /* hash table by msg id */
 795   HASH *subj_hash;              /* hash table by subject */
 796   HASH *thread_hash;            /* hash table for threading */
 797   int *v2r;                     /* mapping from virtual to real msgno */
 798   int hdrmax;                   /* number of pointers in hdrs */
 799   int msgcount;                 /* number of messages in the mailbox */
 800   int vcount;                   /* the number of virtual messages */
 801   int tagged;                   /* how many messages are tagged? */
 802   int new;                      /* how many new messages? */
 803   int unread;                   /* how many unread messages? */
 804   int deleted;                  /* how many deleted messages */
 805   int appended;                 /* how many saved messages? */
 806   int flagged;                  /* how many flagged messages */
 807   int msgnotreadyet;            /* which msg "new" in pager, -1 if none */
 808 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
 809   void *data;                   /* driver specific data */
 810 #endif                          /* USE_IMAP */
 811
 812   short magic;                  /* mailbox type */
 813
 814 #ifdef USE_COMPRESSED
 815   void *compressinfo;           /* compressed mbox module private data */
 816   char *realpath;               /* path to compressed mailbox */
 817 #endif                          /* USE_COMPRESSED */
 818
 819   unsigned int locked:1;        /* is the mailbox locked? */
 820   unsigned int changed:1;       /* mailbox has been modified */
 821   unsigned int readonly:1;      /* don't allow changes to the mailbox */
 822   unsigned int dontwrite:1;     /* dont write the mailbox on close */
 823   unsigned int append:1;        /* mailbox is opened in append mode */
 824   unsigned int quiet:1;         /* inhibit status messages? */
 825   unsigned int collapsed:1;     /* are all threads collapsed? */
 826   unsigned int closing:1;       /* mailbox is being closed */
 827   unsigned int counting:1;      /* do we just want to cound? */
 828 } CONTEXT;
 829
 830 #include "protos.h"
 831 #include "lib.h"
 832 #include "globals.h"
 833
 834 #endif /* !_MUTT_H */