nail.h

   1 /*@ S-nail - a mail user agent derived from Berkeley Mail.
   2  *@ Header inclusion, macros, constants, types and the global var declarations.
   3  *
   4  * Copyright (c) 2000-2004 Gunnar Ritter, Freiburg i. Br., Germany.
   5  * Copyright (c) 2012 - 2015 Steffen (Daode) Nurpmeso <sdaoden@users.sf.net>.
   6  */
   7 /*
   8  * Copyright (c) 1980, 1993
   9  *      The Regents of the University of California.  All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  * 3. Neither the name of the University nor the names of its contributors
  20  *    may be used to endorse or promote products derived from this software
  21  *    without specific prior written permission.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33  * SUCH DAMAGE.
  34  */
  35
  36 /*
  37  * Mail -- a mail program
  38  *
  39  * Author: Kurt Shoens (UCB) March 25, 1978
  40  */
  41
  42 #include "config.h"
  43
  44 #include <sys/stat.h>
  45 #include <sys/types.h>
  46
  47 #ifdef HAVE_GETTIMEOFDAY
  48 # include <sys/time.h>
  49 #endif
  50
  51 #include <errno.h>
  52 #include <fcntl.h>
  53 #include <limits.h>
  54 #include <setjmp.h>
  55 #include <signal.h>
  56 #include <stdarg.h>
  57 #include <stdio.h>
  58 #include <stdlib.h>
  59 #include <string.h>
  60 #include <termios.h>
  61 #include <time.h>
  62 #include <unistd.h>
  63
  64 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
  65 # include <stdint.h>
  66 #else
  67 # include <inttypes.h>
  68 #endif
  69
  70 #ifdef HAVE_C90AMEND1
  71 # include <wchar.h>
  72 # include <wctype.h>
  73 #endif
  74 #ifdef HAVE_DEBUG
  75 # include <assert.h>
  76 #endif
  77 #ifdef HAVE_ICONV
  78 # include <iconv.h>
  79 #endif
  80 #ifdef HAVE_REGEX
  81 # include <regex.h>
  82 #endif
  83
  84 #ifdef HAVE_OPENSSL_MD5
  85 # include <openssl/md5.h>
  86 #endif
  87
  88 /*
  89  * Constants, some nail-specific macros
  90  */
  91
  92 #if !defined NI_MAXHOST
  93 # define NI_MAXHOST     1025
  94 #endif
  95
  96 /* TODO PATH_MAX: fixed-size buffer is always wrong (think NFS) */
  97 #ifndef PATH_MAX
  98 # ifdef MAXPATHLEN
  99 #  define PATH_MAX      MAXPATHLEN
 100 # else
 101 #  define PATH_MAX      1024        /* _XOPEN_PATH_MAX POSIX 2008/Cor 1-2013 */
 102 # endif
 103 #endif
 104
 105 #ifndef HOST_NAME_MAX
 106 # ifdef _POSIX_HOST_NAME_MAX
 107 #  define HOST_NAME_MAX _POSIX_HOST_NAME_MAX
 108 # else
 109 #  define HOST_NAME_MAX 255
 110 # endif
 111 #endif
 112
 113 #ifndef NAME_MAX
 114 # ifdef _POSIX_NAME_MAX
 115 #  define NAME_MAX      _POSIX_NAME_MAX
 116 # else
 117 #  define NAME_MAX      14
 118 # endif
 119 #endif
 120 #if NAME_MAX < 8
 121 # error NAME_MAX too small
 122 #endif
 123
 124 #ifndef STDIN_FILENO
 125 # define STDIN_FILENO   0
 126 #endif
 127 #ifndef STDOUT_FILENO
 128 # define STDOUT_FILENO  1
 129 #endif
 130 #ifndef STDERR_FILENO
 131 # define STDERR_FILENO  2
 132 #endif
 133
 134 #ifdef NSIG_MAX
 135 # undef NSIG
 136 # define NSIG           NSIG_MAX
 137 #elif !defined NSIG
 138 # define NSIG           ((sizeof(sigset_t) * 8) - 1)
 139 #endif
 140
 141 #ifdef O_CLOEXEC
 142 # define _O_CLOEXEC        O_CLOEXEC
 143 # define _CLOEXEC_SET(FD)  do {;} while(0)
 144 #else
 145 # define _O_CLOEXEC        0
 146 # define _CLOEXEC_SET(FD)  \
 147    do { (void)fcntl((FD), F_SETFD, FD_CLOEXEC); } while (0)
 148 #endif
 149
 150 /*  */
 151
 152 #if BUFSIZ + 0 > 2560               /* TODO simply use BUFSIZ? */
 153 # define LINESIZE       BUFSIZ      /* max readable line width */
 154 #else
 155 # define LINESIZE       2560
 156 #endif
 157 #define BUFFER_SIZE     (BUFSIZ >= (1u << 13) ? BUFSIZ : (1u << 14))
 158
 159 /* Network protocol newline */
 160 #define NETNL           "\015\012"
 161 #define NETLINE(X)      X NETNL
 162
 163 /* Number of Not-Yet-Dead calls that are remembered */
 164 #if defined HAVE_DEBUG || defined HAVE_DEVEL || defined HAVE_NYD2
 165 # ifdef HAVE_NYD2
 166 #  define NYD_CALLS_MAX (25 * 84)
 167 # elif defined HAVE_DEVEL
 168 #  define NYD_CALLS_MAX (25 * 42)
 169 # else
 170 #  define NYD_CALLS_MAX (25 * 10)
 171 # endif
 172 #endif
 173
 174 #define APPEND                   /* New mail goes to end of mailbox */
 175 #define CBAD            (-15555)
 176 #define DOTLOCK_TRIES   5        /* Number of open(2) calls for dotlock */
 177 #define FILE_LOCK_TRIES 10       /* Maximum tries before file_lock() fails */
 178 #define ERRORS_MAX      1000     /* Maximum error ring entries TODO configable*/
 179 #define ESCAPE          '~'      /* Default escape for sending */
 180 #define FIO_STACK_SIZE  20       /* Maximum recursion for sourcing */
 181 #define HIST_SIZE       242      /* tty.c: history list default size */
 182 #define HSHSIZE         23       /* Hash prime TODO make dynamic, obsolete */
 183 #define MAXARGC         1024     /* Maximum list of raw strings */
 184 #define MAXEXP          25       /* Maximum expansion of aliases */
 185 #define PROMPT_BUFFER_SIZE 80    /* getprompt() bufsize (> 3!) */
 186 #define REFERENCES_MAX  20       /* Maximum entries in References: */
 187 #define FTMP_OPEN_TRIES 10       /* Maximum number of Ftmp() open(2) tries */
 188
 189 #define ACCOUNT_NULL    "null"   /* Name of "null" account */
 190 #define MAILRC          "~/.mailrc"
 191 #define NETRC           "~/.netrc"
 192 #define TMPDIR_FALLBACK "/tmp"
 193
 194 /* Some environment variables for pipe hooks */
 195 #define AGENT_USER      "NAIL_USER"
 196 #define AGENT_USER_ENC  "NAIL_USER_ENC"
 197 #define AGENT_HOST      "NAIL_HOST"
 198 #define AGENT_HOST_PORT "NAIL_HOST_PORT"
 199
 200 #undef COLOUR
 201 #ifdef HAVE_COLOUR
 202 # define COLOUR(X)      X
 203 #else
 204 # define COLOUR(X)
 205 #endif
 206 #define COLOUR_MSGINFO  "fg=green"
 207 #define COLOUR_PARTINFO "fg=brown"
 208 #define COLOUR_FROM_    "fg=brown"
 209 #define COLOUR_HEADER   "fg=red"
 210 #define COLOUR_UHEADER  "ft=bold,fg=red"
 211 /* The COLOUR_TERMS is in addition to those which have "color" in their name!
 212  * (Keep in SYNC: ./nail.h:COLOUR_TERMS, ./nail.1:*colour-terms*"!) */
 213 #define COLOUR_TERMS    \
 214    "aterm,cons25,gnome,konsole,kterm,linux,"\
 215    "rxvt,rxvt-unicode,screen,sun,vt100,vt220,wsvt25,xterm"
 216 #define COLOUR_USER_HEADERS "from,subject"
 217
 218 /* Special FD requests for run_command() / start_command() */
 219 #define COMMAND_FD_PASS -1
 220 #define COMMAND_FD_NULL -2
 221
 222 /*  */
 223 #define FROM_DATEBUF    64    /* Size of RFC 4155 From_ line date */
 224 #define DATE_DAYSYEAR   365L
 225 #define DATE_SECSMIN    60L
 226 #define DATE_MINSHOUR   60L
 227 #define DATE_HOURSDAY   24L
 228 #define DATE_SECSDAY    (DATE_SECSMIN * DATE_MINSHOUR * DATE_HOURSDAY)
 229
 230 /* *indentprefix* default as of POSIX */
 231 #define INDENT_DEFAULT  "\t"
 232
 233 /* Default *encoding* as enum mime_enc below */
 234 #define MIME_DEFAULT_ENCODING MIMEE_QP
 235
 236 /* Maximum allowed line length in a mail before QP folding is necessary), and
 237  * the real limit we go for */
 238 #define MIME_LINELEN_MAX   998   /* Plus CRLF */
 239 #define MIME_LINELEN_LIMIT (MIME_LINELEN_MAX - 48)
 240
 241 /* Ditto, SHOULD */
 242 #define MIME_LINELEN    78    /* Plus CRLF */
 243
 244 /* And in headers which contain an encoded word according to RFC 2047 there is
 245  * yet another limit; also RFC 2045: 6.7, (5). */
 246 #define MIME_LINELEN_RFC2047 76
 247
 248 /* Locations of mime.types(5) */
 249 #define MIME_TYPES_USR  "~/.mime.types"
 250 #define MIME_TYPES_SYS  "/etc/mime.types"
 251
 252 /* Fallback MIME charsets, if *charset-7bit* and *charset-8bit* or not set.
 253  * (Keep in SYNC: ./nail.1:"Character sets", ./nail.h:CHARSET_*!) */
 254 #define CHARSET_7BIT    "US-ASCII"
 255 #ifdef HAVE_ICONV
 256 # define CHARSET_8BIT      "UTF-8"
 257 # define CHARSET_8BIT_OKEY charset_8bit
 258 #else
 259 # define CHARSET_8BIT      "ISO-8859-1"
 260 # define CHARSET_8BIT_OKEY ttycharset
 261 #endif
 262
 263 /* Some environment variables for pipe hooks etc. */
 264 #define NAILENV_TMPDIR              "NAIL_TMPDIR"
 265 #define NAILENV_FILENAME            "NAIL_FILENAME"
 266 #define NAILENV_FILENAME_GENERATED  "NAIL_FILENAME_GENERATED"
 267 #define NAILENV_FILENAME_TEMPORARY  "NAIL_FILENAME_TEMPORARY"
 268 #define NAILENV_CONTENT             "NAIL_CONTENT"
 269 #define NAILENV_CONTENT_EVIDENCE    "NAIL_CONTENT_EVIDENCE"
 270
 271 /* Is *W* a quoting (ASCII only) character? */
 272 #define ISQUOTE(W)      \
 273    ((W) == L'>' || (W) == L'|' || (W) == L'}' || (W) == L':')
 274
 275 /* Maximum number of quote characters (not bytes!) that'll be used on
 276  * follow lines when compressing leading quote characters */
 277 #define QUOTE_MAX       42
 278
 279 /* How much spaces should a <tab> count when *quote-fold*ing? (power-of-two!) */
 280 #define QUOTE_TAB_SPACES 8
 281
 282 /* Maximum size of a message that is passed through to the spam system */
 283 #define SPAM_MAXSIZE    420000
 284
 285 /* String dope: dynamic buffer size, and size of the single builtin one that's
 286  * used first; note that these value include the size of the structure */
 287 #define SBUFFER_SIZE    ((0x10000u >> 1u) - 0x400)
 288 #define SBUFFER_BUILTIN (0x10000u >> 1u)
 289
 290 /* These come from the configuration (named Xxy to not clash with sh(1)..) */
 291 #ifndef XSHELL
 292 # define XSHELL         "/bin/sh"
 293 #endif
 294 #ifndef XLISTER
 295 # define XLISTER        "ls"
 296 #endif
 297 #ifndef XPAGER
 298 # define XPAGER         "more"
 299 #endif
 300
 301 /*
 302  * OS, CC support, generic macros etc.
 303  */
 304
 305 /* OS: we're not a library, only set what needs special treatment somewhere */
 306 #define OS_DRAGONFLY    0
 307 #define OS_SOLARIS      0
 308 #define OS_SUNOS        0
 309
 310 #ifdef __DragonFly__
 311 # undef OS_DRAGONFLY
 312 # define OS_DRAGONFLY   1
 313 #elif defined __solaris__ || defined __sun
 314 # if defined __SVR4 || defined __svr4__
 315 #  undef OS_SOLARIS
 316 #  define OS_SOLARIS    1
 317 # else
 318 #  undef OS_SUNOS
 319 #  define OS_SUNOS      1
 320 # endif
 321 #endif
 322
 323 /* CC */
 324 #define CC_CLANG           0
 325 #define PREREQ_CLANG(X,Y)  0
 326 #define CC_GCC             0
 327 #define PREREQ_GCC(X,Y)    0
 328 #define CC_TCC             0
 329 #define PREREQ_TCC(X,Y)    0
 330
 331 #ifdef __clang__
 332 # undef CC_CLANG
 333 # undef PREREQ_CLANG
 334 # define CC_CLANG          1
 335 # define PREREQ_CLANG(X,Y) \
 336    (__clang_major__ + 0 > (X) || \
 337     (__clang_major__ + 0 == (X) && __clang_minor__ + 0 >= (Y)))
 338 # define __EXTEN           __extension__
 339
 340 #elif defined __GNUC__
 341 # undef CC_GCC
 342 # undef PREREQ_GCC
 343 # define CC_GCC            1
 344 # define PREREQ_GCC(X,Y)   \
 345    (__GNUC__ + 0 > (X) || (__GNUC__ + 0 == (X) && __GNUC_MINOR__ + 0 >= (Y)))
 346 # define __EXTEN           __extension__
 347
 348 #elif defined __TINYC__
 349 # undef CC_TCC
 350 # define CC_TCC            1
 351 #endif
 352
 353 #ifndef __EXTEN
 354 # define __EXTEN
 355 #endif
 356
 357 /* Suppress some technical warnings via #pragma's unless developing.
 358  * XXX Wild guesses: clang(1) 1.7 and (OpenBSD) gcc(1) 4.2.1 don't work */
 359 #ifndef HAVE_DEVEL
 360 # if PREREQ_CLANG(3, 4)
 361 #  pragma clang diagnostic ignored "-Wunused-result"
 362 #  pragma clang diagnostic ignored "-Wformat"
 363 # elif PREREQ_GCC(4, 7)
 364 #  pragma GCC diagnostic ignored "-Wunused-local-typedefs"
 365 #  pragma GCC diagnostic ignored "-Wunused-result"
 366 #  pragma GCC diagnostic ignored "-Wformat"
 367 # endif
 368 #endif
 369
 370 /* For injection macros like DBG(), NATCH_CHAR() */
 371 #define COMMA           ,
 372
 373 #define EMPTY_FILE()    typedef int CONCAT(avoid_empty_file__, n_FILE);
 374
 375 /* Pointer to size_t */
 376 #define PTR2SIZE(X)     ((size_t)(uintptr_t)(X))
 377
 378 /* Pointer comparison (types from below) */
 379 #define PTRCMP(A,C,B)   ((uintptr_t)(A) C (uintptr_t)(B))
 380
 381 /* Ditto, compare (maybe mixed-signed) integers cases to T bits, unsigned;
 382  * Note: doesn't sign-extend correctly, that's still up to the caller */
 383 #define UICMP(T,A,C,B)  ((ui ## T ## _t)(A) C (ui ## T ## _t)(B))
 384
 385 /* Align something to a size/boundary that cannot cause just any problem */
 386 #define n_ALIGN(X)      (((X) + 2*sizeof(void*)) & ~((2*sizeof(void*)) - 1))
 387
 388 /* Members in constant array */
 389 #ifndef NELEM
 390 # define NELEM(A)       (sizeof(A) / sizeof(A[0]))
 391 #endif
 392
 393 /* sizeof() for member fields */
 394 #define SIZEOF_FIELD(T,F) sizeof(((T *)NULL)->F)
 395
 396 /* Casts-away (*NOT* cast-away) */
 397 #define UNUSED(X)       ((void)(X))
 398 #define UNCONST(P)      ((void*)(uintptr_t)(void const*)(P))
 399 #define UNVOLATILE(P)   ((void*)(uintptr_t)(void volatile*)(P))
 400 #define UNXXX(T,C,P)    ((T)(uintptr_t)(C)(P))
 401
 402 /* __STDC_VERSION__ is ISO C99, so also use __STDC__, which should work */
 403 #if defined __STDC__ || defined __STDC_VERSION__ /*|| defined __cplusplus*/
 404 # define STRING(X)      #X
 405 # define XSTRING(X)     STRING(X)
 406 # define CONCAT(S1,S2)  _CONCAT(S1, S2)
 407 # define _CONCAT(S1,S2) S1 ## S2
 408 #else
 409 # define STRING(X)      "X"
 410 # define XSTRING        STRING
 411 # define CONCAT(S1,S2)  S1/**/S2
 412 #endif
 413
 414 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
 415 # define n_FIELD_INITN(N) CONCAT(., N) =
 416 # define n_FIELD_INITI(I) [I] =
 417 #else
 418 # define n_FIELD_INITN(N)
 419 # define n_FIELD_INITI(N)
 420 #endif
 421
 422 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
 423 # define VFIELD_SIZE(X)
 424 # define VFIELD_SIZEOF(T,F) (0)
 425 #else
 426 # define VFIELD_SIZE(X) \
 427   ((X) == 0 ? sizeof(size_t) \
 428    : ((ssize_t)(X) < 0 ? sizeof(size_t) - ABS(X) : (size_t)(X)))
 429 # define VFIELD_SIZEOF(T,F) SIZEOF_FIELD(T, F)
 430 #endif
 431
 432 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
 433 # define HAVE_INLINE
 434 # define INLINE         inline
 435 # define SINLINE        static inline
 436 #elif CC_CLANG || PREREQ_GCC(2, 9)
 437 # define HAVE_INLINE
 438 # define INLINE         static __inline
 439 # define SINLINE        static __inline
 440 #else
 441 # define INLINE
 442 # define SINLINE        static
 443 #endif
 444
 445 #undef __FUN__
 446 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
 447 # define __FUN__        __func__
 448 #elif CC_CLANG || PREREQ_GCC(3, 4)
 449 # define __FUN__        __extension__ __FUNCTION__
 450 #else
 451 # define __FUN__        uagent   /* Something that is not a literal */
 452 #endif
 453
 454 #if defined __predict_true && defined __predict_false
 455 # define LIKELY(X)      __predict_true(X)
 456 # define UNLIKELY(X)    __predict_false(X)
 457 #elif CC_CLANG || PREREQ_GCC(2, 96)
 458 # define LIKELY(X)      __builtin_expect(X, 1)
 459 # define UNLIKELY(X)    __builtin_expect(X, 0)
 460 #else
 461 # define LIKELY(X)      (X)
 462 # define UNLIKELY(X)    (X)
 463 #endif
 464
 465 #undef HAVE_NATCH_CHAR
 466 #undef NATCH_CHAR
 467 #if defined HAVE_SETLOCALE && defined HAVE_C90AMEND1 && defined HAVE_WCWIDTH
 468 # define HAVE_NATCH_CHAR
 469 # define NATCH_CHAR(X)  X
 470 #else
 471 # define NATCH_CHAR(X)
 472 #endif
 473
 474 /* Compile-Time-Assert
 475  * Problem is that some compilers warn on unused local typedefs, so add
 476  * a special local CTA to overcome this */
 477 #define CTA(TEST)       _CTA_1(TEST, n_FILE, __LINE__)
 478 #define LCTA(TEST)      _LCTA_1(TEST, n_FILE, __LINE__)
 479
 480 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 201112L
 481 # define n_CTA(T,M) _Static_assert(T, M)
 482 # define n_LCTA(T,M) _Static_assert(T, M)
 483 #else
 484 # define n_CTA(T,M)  _CTA_1(T, n_FILE, __LINE__)
 485 # define n_LCTA(T,M) _LCTA_1(T, n_FILE, __LINE__)
 486 #endif
 487
 488 #ifdef n_MAIN_SOURCE
 489 # define n_MCTA(T,M) n_CTA(T, M);
 490 #else
 491 # define n_MCTA(T,M)
 492 #endif
 493
 494 #define _CTA_1(T,F,L)   _CTA_2(T, F, L)
 495 #define _CTA_2(T,F,L)  \
 496    typedef char ASSERTION_failed_in_file_## F ## _at_line_ ## L[(T) ? 1 : -1]
 497 #define _LCTA_1(T,F,L)  _LCTA_2(T, F, L)
 498 #define _LCTA_2(T,F,L) \
 499 do {\
 500    typedef char ASSERTION_failed_in_file_## F ## _at_line_ ## L[(T) ? 1 : -1];\
 501    ASSERTION_failed_in_file_## F ## _at_line_ ## L __i_am_unused__;\
 502    UNUSED(__i_am_unused__);\
 503 } while (0)
 504
 505 #define UNINIT(N,V)     N = V
 506
 507 #undef ISPOW2
 508 #define ISPOW2(X)       ((((X) - 1) & (X)) == 0)
 509 #undef MIN
 510 #define MIN(A, B)       ((A) < (B) ? (A) : (B))
 511 #undef MAX
 512 #define MAX(A, B)       ((A) < (B) ? (B) : (A))
 513 #undef ABS
 514 #define ABS(A)          ((A) < 0 ? -(A) : (A))
 515
 516 #undef DBG
 517 #undef NDBG
 518 #ifndef HAVE_DEBUG
 519 # undef assert
 520 # define assert(X)      UNUSED(0)
 521 # define DBG(X)
 522 # define NDBG(X)        X
 523 # define DBGOR(X,Y)     Y
 524 #else
 525 # define DBG(X)         X
 526 # define NDBG(X)
 527 # define DBGOR(X,Y)     X
 528 #endif
 529
 530 /* Translation (init in main.c) */
 531 #undef _
 532 #undef N_
 533 #undef V_
 534 #define _(S)            S
 535 #define N_(S)           S
 536 #define V_(S)           S
 537
 538 /*
 539  * Types
 540  */
 541
 542 #ifdef UINT8_MAX
 543 # define UI8_MAX        UINT8_MAX
 544 # define SI8_MIN        INT8_MIN
 545 # define SI8_MAX        INT8_MAX
 546 typedef uint8_t         ui8_t;
 547 typedef int8_t          si8_t;
 548 #elif UCHAR_MAX != 255
 549 # error UCHAR_MAX must be 255
 550 #else
 551 # define UI8_MAX        UCHAR_MAX
 552 # define SI8_MIN        CHAR_MIN
 553 # define SI8_MAX        CHAR_MAX
 554 typedef unsigned char   ui8_t;
 555 typedef signed char     si8_t;
 556 #endif
 557
 558 #if !defined PRIu8 || !defined PRId8
 559 # undef PRIu8
 560 # undef PRId8
 561 # define PRIu8          "hhu"
 562 # define PRId8          "hhd"
 563 #endif
 564
 565 #ifdef UINT16_MAX
 566 # define UI16_MAX       UINT16_MAX
 567 # define SI16_MIN       INT16_MIN
 568 # define SI16_MAX       INT16_MAX
 569 typedef uint16_t        ui16_t;
 570 typedef int16_t         si16_t;
 571 #elif USHRT_MAX != 0xFFFFu
 572 # error USHRT_MAX must be 0xFFFF
 573 #else
 574 # define UI16_MAX       USHRT_MAX
 575 # define SI16_MIN       SHRT_MIN
 576 # define SI16_MAX       SHRT_MAX
 577 typedef unsigned short  ui16_t;
 578 typedef signed short    si16_t;
 579 #endif
 580
 581 #if !defined PRIu16 || !defined PRId16
 582 # undef PRIu16
 583 # undef PRId16
 584 # if UI16_MAX == UINT_MAX
 585 #  define PRIu16        "u"
 586 #  define PRId16        "d"
 587 # else
 588 #  define PRIu16        "hu"
 589 #  define PRId16        "hd"
 590 # endif
 591 #endif
 592
 593 #ifdef UINT32_MAX
 594 # define UI32_MAX       UINT32_MAX
 595 # define SI32_MIN       INT32_MIN
 596 # define SI32_MAX       INT32_MAX
 597 typedef uint32_t        ui32_t;
 598 typedef int32_t         si32_t;
 599 #elif ULONG_MAX == 0xFFFFFFFFu
 600 # define UI32_MAX       ULONG_MAX
 601 # define SI32_MIN       LONG_MIN
 602 # define SI32_MAX       LONG_MAX
 603 typedef unsigned long int  ui32_t;
 604 typedef signed long int    si32_t;
 605 #elif UINT_MAX != 0xFFFFFFFFu
 606 # error UINT_MAX must be 0xFFFFFFFF
 607 #else
 608 # define UI32_MAX       UINT_MAX
 609 # define SI32_MIN       INT_MIN
 610 # define SI32_MAX       INT_MAX
 611 typedef unsigned int    ui32_t;
 612 typedef signed int      si32_t;
 613 #endif
 614
 615 #if !defined PRIu32 || !defined PRId32
 616 # undef PRIu32
 617 # undef PRId32
 618 # if UI32_MAX == ULONG_MAX
 619 #  define PRIu32        "lu"
 620 #  define PRId32        "ld"
 621 # else
 622 #  define PRIu32        "u"
 623 #  define PRId32        "d"
 624 # endif
 625 #endif
 626
 627 #ifdef UINT64_MAX
 628 # define UI64_MAX       UINT64_MAX
 629 # define SI64_MIN       INT64_MIN
 630 # define SI64_MAX       INT64_MAX
 631 typedef uint64_t        ui64_t;
 632 typedef int64_t         si64_t;
 633 #elif ULONG_MAX <= 0xFFFFFFFFu
 634 # if !defined ULLONG_MAX || (ULLONG_MAX >> 31) < 0xFFFFFFFFu
 635 #  error We need a 64 bit integer
 636 # else
 637 #  define UI64_MAX      ULLONG_MAX
 638 #  define SI64_MIN      LLONG_MIN
 639 #  define SI64_MAX      LLONG_MAX
 640 __EXTEN typedef unsigned long long  ui64_t;
 641 __EXTEN typedef signed long long    si64_t;
 642 # endif
 643 #else
 644 # define UI64_MAX       ULONG_MAX
 645 # define SI64_MIN       LONG_MIN
 646 # define SI64_MAX       LONG_MAX
 647 typedef unsigned long   ui64_t;
 648 typedef signed long     si64_t;
 649 #endif
 650
 651 #if !defined PRIu64 || !defined PRId64 || !defined PRIX64
 652 # undef PRIu64
 653 # undef PRId64
 654 # undef PRIX64
 655 # if defined ULLONG_MAX && UI64_MAX == ULLONG_MAX
 656 #  define PRIu64        "llu"
 657 #  define PRId64        "lld"
 658 #  define PRIX64        "llX"
 659 # else
 660 #  define PRIu64        "lu"
 661 #  define PRId64        "ld"
 662 #  define PRIX64        "lX"
 663 # endif
 664 #endif
 665
 666 /* (So that we can use UICMP() for size_t comparison, too) */
 667 typedef size_t          uiz_t;
 668 typedef ssize_t         siz_t;
 669
 670 #undef PRIuZ
 671 #undef PRIdZ
 672 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
 673 # define PRIuZ          "zu"
 674 # define PRIdZ          "zd"
 675 # define UIZ_MAX        SIZE_MAX
 676 #elif defined SIZE_MAX
 677   /* UnixWare has size_t as unsigned as required but uses a signed limit
 678    * constant (which is thus false!) */
 679 # if SIZE_MAX == UI64_MAX || SIZE_MAX == SI64_MAX
 680 #  define PRIuZ         PRIu64
 681 #  define PRIdZ         PRId64
 682 n_MCTA(sizeof(size_t) == sizeof(ui64_t),
 683    "Format string mismatch, compile with ISO C99 compiler (-std=c99)!")
 684 # elif SIZE_MAX == UI32_MAX || SIZE_MAX == SI32_MAX
 685 #  define PRIuZ         PRIu32
 686 #  define PRIdZ         PRId32
 687 n_MCTA(sizeof(size_t) == sizeof(ui32_t),
 688    "Format string mismatch, compile with ISO C99 compiler (-std=c99)!")
 689 # else
 690 #  error SIZE_MAX is neither UI64_MAX nor UI32_MAX (please report this)
 691 # endif
 692 # define UIZ_MAX        SIZE_MAX
 693 #endif
 694 #ifndef PRIuZ
 695 # define PRIuZ          "lu"
 696 # define PRIdZ          "ld"
 697 n_MCTA(sizeof(size_t) == sizeof(unsigned long),
 698    "Format string mismatch, compile with ISO C99 compiler (-std=c99)!")
 699 # define UIZ_MAX        ULONG_MAX
 700 #endif
 701
 702 #ifndef UINTPTR_MAX
 703 # ifdef SIZE_MAX
 704 #  define uintptr_t     size_t
 705 #  define UINTPTR_MAX   SIZE_MAX
 706 # else
 707 #  define uintptr_t     unsigned long
 708 #  define UINTPTR_MAX   ULONG_MAX
 709 # endif
 710 #endif
 711
 712 #if !defined PRIuPTR || !defined PRIXPTR
 713 # undef PRIuPTR
 714 # undef PRIXPTR
 715 # if UINTPTR_MAX == ULONG_MAX
 716 #  define PRIuPTR       "lu"
 717 #  define PRIXPTR       "lX"
 718 # else
 719 #  define PRIuPTR       "u"
 720 #  define PRIXPTR       "X"
 721 # endif
 722 #endif
 723
 724 enum {FAL0, TRU1, TRUM1 = -1};
 725 typedef si8_t           bool_t;
 726
 727 /* Add shorter aliases for "normal" integers */
 728 typedef unsigned long   ul_i;
 729 typedef unsigned int    ui_i;
 730 typedef unsigned short  us_i;
 731 typedef unsigned char   uc_i;
 732
 733 typedef signed long     sl_i;
 734 typedef signed int      si_i;
 735 typedef signed short    ss_i;
 736 typedef signed char     sc_i;
 737
 738 typedef void (          *sighandler_type)(int);
 739
 740 enum authtype {
 741    AUTHTYPE_NONE     = 1<<0,
 742    AUTHTYPE_PLAIN    = 1<<1,  /* POP3: APOP is covered by this */
 743    AUTHTYPE_LOGIN    = 1<<2,
 744    AUTHTYPE_CRAM_MD5 = 1<<3,
 745    AUTHTYPE_GSSAPI   = 1<<4
 746 };
 747
 748 enum expand_addr_flags {
 749    EAF_NONE       = 0,        /* -> EAF_NOFILE | EAF_NOPIPE */
 750    EAF_RESTRICT   = 1<<0,     /* "restrict" (do unless interaktive / -[~#]) */
 751    EAF_FAIL       = 1<<1,     /* "fail" */
 752    /* Bits reused by enum expand_addr_check_mode! */
 753    EAF_FILE       = 1<<3,     /* +"file" targets */
 754    EAF_PIPE       = 1<<4,     /* +"pipe" command pipe targets */
 755    EAF_NAME       = 1<<5,     /* +"name"s (non-address) names / MTA aliases */
 756    EAF_ADDR       = 1<<6,     /* +"addr" network address (contain "@") */
 757
 758    EAF_TARGET_MASK  = EAF_FILE | EAF_PIPE | EAF_NAME | EAF_ADDR,
 759    EAF_RESTRICT_TARGETS = EAF_NAME | EAF_ADDR /* (default set if not set) */
 760 };
 761
 762 enum expand_addr_check_mode {
 763    EACM_NONE      = 0,        /* Don't care about *expandaddr* */
 764    EACM_NORMAL    = 1<<0,     /* Use our normal *expandaddr* checking */
 765    EACM_STRICT    = 1<<1,     /* Never allow any file or pipe addresse */
 766    EACM_MODE_MASK = 0x3,      /* _NORMAL and _STRICT are mutual! */
 767
 768    EACM_NOLOG     = 1<<2,     /* Don't log check errors */
 769
 770    /* Some special overwrites of EAF_TARGETs.
 771     * May NOT clash with EAF_* bits which may be ORd to these here! */
 772
 773    EACM_NONAME    = 1<<16
 774 };
 775
 776 enum colourspec {
 777    COLOURSPEC_MSGINFO,
 778    COLOURSPEC_PARTINFO,
 779    COLOURSPEC_FROM_,
 780    COLOURSPEC_HEADER,
 781    COLOURSPEC_UHEADER,
 782    COLOURSPEC_RESET
 783 };
 784
 785 enum conversion {
 786    CONV_NONE,        /* no conversion */
 787    CONV_7BIT,        /* no conversion, is 7bit */
 788    CONV_FROMQP,      /* convert from quoted-printable */
 789    CONV_TOQP,        /* convert to quoted-printable */
 790    CONV_8BIT,        /* convert to 8bit (iconv) */
 791    CONV_FROMB64,     /* convert from base64 */
 792    CONV_FROMB64_T,   /* convert from base64/text */
 793    CONV_TOB64,       /* convert to base64 */
 794    CONV_FROMHDR,     /* convert from RFC1522 format */
 795    CONV_TOHDR,       /* convert to RFC1522 format */
 796    CONV_TOHDR_A      /* convert addresses for header */
 797 };
 798
 799 enum cproto {
 800    CPROTO_SMTP,
 801    CPROTO_POP3,
 802    CPROTO_IMAP
 803 };
 804
 805 enum dotlock_state {
 806    DLS_NONE,
 807    DLS_CANT_CHDIR,            /* Failed to chdir(2) into desired path */
 808    DLS_NAMETOOLONG,           /* Lock file name would be too long */
 809    DLS_ROFS,                  /* Read-only filesystem (no error, mailbox RO) */
 810    DLS_NOPERM,                /* No permission to creat lock file */
 811    DLS_NOEXEC,                /* Privilege separated dotlocker not found */
 812    DLS_PRIVFAILED,            /* Rising privileges failed in dotlocker */
 813    DLS_EXIST,                 /* Lock file already exists, stale lock? */
 814    DLS_FISHY,                 /* Something makes us think bad of situation */
 815    DLS_DUNNO,                 /* Catch-all error */
 816    DLS_PING,                  /* Not an error, but have to wait for lock */
 817    DLS_ABANDON    = 1<<7      /* ORd to any but _NONE: give up, don't retry */
 818 };
 819
 820 enum exit_status {
 821    EXIT_OK        = EXIT_SUCCESS,
 822    EXIT_ERR       = EXIT_FAILURE,
 823    EXIT_USE       = 64,       /* sysexits.h:EX_USAGE */
 824    EXIT_NOUSER    = 67,       /* :EX_NOUSER */
 825    EXIT_COLL_ABORT = 1<<1,    /* Message collection was aborted */
 826    EXIT_SEND_ERROR = 1<<2     /* Unspecified send error occurred */
 827 };
 828
 829 enum fedit_mode {
 830    FEDIT_NONE     = 0,
 831    FEDIT_SYSBOX   = 1<<0,     /* %: prefix */
 832    FEDIT_RDONLY   = 1<<1,     /* Readonly (per-box, OPT_R_FLAG is global) */
 833    FEDIT_NEWMAIL  = 1<<2      /* `newmail' operation TODO OBSOLETE THIS! */
 834 };
 835
 836 enum fexp_mode {
 837    FEXP_FULL,                 /* Full expansion */
 838    FEXP_LOCAL     = 1<<0,     /* Result must be local file/maildir */
 839    FEXP_SHELL     = 1<<1,     /* No folder %,#,&,+ stuff, yet sh(1) */
 840    FEXP_NSHORTCUT = 1<<2,     /* Don't expand shortcuts */
 841    FEXP_SILENT    = 1<<3,     /* Don't print but only return errors */
 842    FEXP_MULTIOK   = 1<<4,     /* Expansion to many entries is ok */
 843    FEXP_NSHELL    = 1<<5      /* Don't do shell word exp. (but ~/, $VAR) */
 844 };
 845
 846 enum file_lock_type {
 847    FLT_READ,
 848    FLT_WRITE
 849 };
 850
 851 enum mimecontent {
 852    MIME_UNKNOWN,     /* unknown content */
 853    MIME_SUBHDR,      /* inside a multipart subheader */
 854    MIME_822,         /* message/rfc822 content */
 855    MIME_MESSAGE,     /* other message/ content */
 856    MIME_TEXT_PLAIN,  /* text/plain content */
 857    MIME_TEXT_HTML,   /* text/html content */
 858    MIME_TEXT,        /* other text/ content */
 859    MIME_ALTERNATIVE, /* multipart/alternative content */
 860    MIME_RELATED,     /* mime/related (RFC 2387) */
 861    MIME_DIGEST,      /* multipart/digest content */
 862    MIME_MULTI,       /* other multipart/ content */
 863    MIME_PKCS7,       /* PKCS7 content */
 864    MIME_DISCARD      /* content is discarded */
 865 };
 866
 867 enum mime_counter_evidence {
 868    MIMECE_NONE,
 869    MIMECE_SET        = 1<<0,  /* *mime-counter-evidence* was set */
 870    MIMECE_BIN_OVWR   = 1<<1,  /* appli../octet-stream: check, ovw if possible */
 871    MIMECE_ALL_OVWR   = 1<<2,  /* all: check, ovw if possible */
 872    MIMECE_BIN_PARSE  = 1<<3   /* appli../octet-stream: classify contents last */
 873 };
 874
 875 /* Content-Transfer-Encodings as defined in RFC 2045:
 876  * - Quoted-Printable, section 6.7
 877  * - Base64, section 6.8 */
 878 #define QP_LINESIZE     (4 * 19)       /* Max. compliant QP linesize */
 879
 880 #define B64_LINESIZE    (4 * 19)       /* Max. compliant Base64 linesize */
 881 #define B64_ENCODE_INPUT_PER_LINE 57   /* Max. input for Base64 encode/line */
 882
 883 enum mime_enc {
 884    MIMEE_NONE,       /* message is not in MIME format */
 885    MIMEE_BIN,        /* message is in binary encoding */
 886    MIMEE_8B,         /* message is in 8bit encoding */
 887    MIMEE_7B,         /* message is in 7bit encoding */
 888    MIMEE_QP,         /* message is quoted-printable */
 889    MIMEE_B64         /* message is in base64 encoding */
 890 };
 891
 892 /* xxx QP came later, maybe rewrite all to use mime_enc_flags directly? */
 893 enum mime_enc_flags {
 894    MIMEEF_NONE,
 895    MIMEEF_SALLOC     = 1<<0,  /* Use salloc(), not srealloc().. */
 896    /* ..result .s,.l point to user buffer of *_LINESIZE+[+[+]] bytes instead */
 897    MIMEEF_BUF        = 1<<1,
 898    MIMEEF_CRLF       = 1<<2,  /* (encode) Append "\r\n" to lines */
 899    MIMEEF_LF         = 1<<3,  /* (encode) Append "\n" to lines */
 900    /* (encode) If one of _CRLF/_LF is set, honour *_LINESIZE+[+[+]] and
 901     * inject the desired line-ending whenever a linewrap is desired */
 902    MIMEEF_MULTILINE  = 1<<4,
 903    /* (encode) Quote with header rules, do not generate soft NL breaks?
 904     * For mustquote(), specifies wether special RFC 2047 header rules
 905     * should be used instead */
 906    MIMEEF_ISHEAD     = 1<<5,
 907    /* (encode) Ditto; for mustquote() this furtherly fine-tunes behaviour in
 908     * that characters which would not be reported as "must-quote" when
 909     * detecting wether quoting is necessary at all will be reported as
 910     * "must-quote" if they have to be encoded in an encoded word */
 911    MIMEEF_ISENCWORD  = 1<<6,
 912    __MIMEEF_LAST     = 6
 913 };
 914
 915 enum qpflags {
 916    QP_NONE        = MIMEEF_NONE,
 917    QP_SALLOC      = MIMEEF_SALLOC,
 918    QP_BUF         = MIMEEF_BUF,
 919    QP_ISHEAD      = MIMEEF_ISHEAD,
 920    QP_ISENCWORD   = MIMEEF_ISENCWORD
 921 };
 922
 923 enum b64flags {
 924    B64_NONE       = MIMEEF_NONE,
 925    B64_SALLOC     = MIMEEF_SALLOC,
 926    B64_BUF        = MIMEEF_BUF,
 927    B64_CRLF       = MIMEEF_CRLF,
 928    B64_LF         = MIMEEF_LF,
 929    B64_MULTILINE  = MIMEEF_MULTILINE,
 930    /* Not used, but for clarity only */
 931    B64_ISHEAD     = MIMEEF_ISHEAD,
 932    B64_ISENCWORD  = MIMEEF_ISENCWORD,
 933    /* Special version of Base64, "Base64URL", according to RFC 4648.
 934     * Only supported for encoding! */
 935    B64_RFC4648URL = 1<<(__MIMEEF_LAST+1),
 936    /* Don't use any ("=") padding;
 937     * may NOT be used with any of _CRLF, _LF or _MULTILINE */
 938    B64_NOPAD      = 1<<(__MIMEEF_LAST+2)
 939 };
 940
 941 enum mime_parse_flags {
 942    MIME_PARSE_NONE      = 0,
 943    MIME_PARSE_DECRYPT   = 1<<0,
 944    MIME_PARSE_PARTS     = 1<<1
 945 };
 946
 947 enum mime_handler_flags {
 948    MIME_HDL_NULL,                /* No pipe- mimetype handler, go away */
 949    MIME_HDL_CMD,                 /* Normal command */
 950    MIME_HDL_TEXT,                /* @ special cmd to force treatment as text */
 951    MIME_HDL_PTF,                 /* A special pointer-to-function handler */
 952    MIME_HDL_MSG,                 /* Display msg (returned as command string) */
 953    MIME_HDL_TYPE_MASK   = 7,
 954    MIME_HDL_ISQUOTE     = 1<<4,  /* Is quote action (we have info, keep it!) */
 955    MIME_HDL_NOQUOTE     = 1<<5,  /* No MIME for quoting */
 956    MIME_HDL_ALWAYS      = 1<<6,  /* Handler shall run for multi-msg actions */
 957    MIME_HDL_ASYNC       = 1<<7,  /* Should run asynchronously */
 958    MIME_HDL_NEEDSTERM   = 1<<8,  /* Takes over terminal */
 959    MIME_HDL_TMPF        = 1<<9,  /* Create temporary file (zero-sized) */
 960    MIME_HDL_TMPF_FILL   = 1<<10, /* Fill in the msg body content */
 961    MIME_HDL_TMPF_UNLINK = 1<<11  /* Delete it later again */
 962 };
 963
 964 enum mlist_state {
 965    MLIST_OTHER       = 0,     /* Normal address */
 966    MLIST_KNOWN       = 1,     /* A known `mlist' */
 967    MLIST_SUBSCRIBED  = -1     /* A `mlsubscribe'd list */
 968 };
 969
 970 enum oflags {
 971    OF_RDONLY      = 1<<0,
 972    OF_WRONLY      = 1<<1,
 973    OF_RDWR        = 1<<2,
 974    OF_APPEND      = 1<<3,
 975    OF_CREATE      = 1<<4,
 976    OF_TRUNC       = 1<<5,
 977    OF_EXCL        = 1<<6,
 978    OF_CLOEXEC     = 1<<7,     /* TODO not used, always implied!  CHANGE!! */
 979    OF_UNLINK      = 1<<8,     /* Only for Ftmp(): unlink(2) after creation */
 980    OF_HOLDSIGS    = 1<<9,     /* Mutual with OF_UNLINK - await Ftmp_free() */
 981    OF_REGISTER    = 1<<10,    /* Register file in our file table */
 982    OF_REGISTER_UNLINK = 1<<11, /* unlink(2) upon unreg.; _REGISTER asserted! */
 983    OF_SUFFIX      = 1<<12     /* Ftmp() name hint is mandatory! extension! */
 984 };
 985
 986 enum okay {
 987    STOP = 0,
 988    OKAY = 1
 989 };
 990
 991 enum okey_xlook_mode {
 992    OXM_PLAIN      = 1<<0,     /* Plain key always tested */
 993    OXM_H_P        = 1<<1,     /* Check PLAIN-.url_h_p */
 994    OXM_U_H_P      = 1<<2,     /* Check PLAIN-.url_u_h_p */
 995    OXM_ALL        = 0x7
 996 };
 997
 998 /* <0 means "stop" unless *prompt* extensions are enabled. */
 999 enum prompt_exp {
1000    PROMPT_STOP    = -1,       /* \c */
1001    /* *prompt* extensions: \$, \@ etc. */
1002    PROMPT_DOLLAR  = -2,
1003    PROMPT_AT      = -3
1004 };
1005
1006 enum protocol {
1007    PROTO_FILE,       /* refers to a local file */
1008    PROTO_POP3,       /* is a pop3 server string */
1009    PROTO_IMAP,       /* is an imap server string */
1010    PROTO_MAILDIR,    /* refers to a maildir folder */
1011    PROTO_UNKNOWN     /* unknown protocol */
1012 };
1013
1014 enum sendaction {
1015    SEND_MBOX,        /* no conversion to perform */
1016    SEND_RFC822,      /* no conversion, no From_ line */
1017    SEND_TODISP,      /* convert to displayable form */
1018    SEND_TODISP_ALL,  /* same, include all MIME parts */
1019    SEND_SHOW,        /* convert to 'show' command form */
1020    SEND_TOSRCH,      /* convert for IMAP SEARCH */
1021    SEND_TOFILE,      /* convert for saving body to a file */
1022    SEND_TOPIPE,      /* convert for pipe-content/subc. */
1023    SEND_QUOTE,       /* convert for quoting */
1024    SEND_QUOTE_ALL,   /* same, include all MIME parts */
1025    SEND_DECRYPT      /* decrypt */
1026 };
1027
1028 #ifdef HAVE_SSL
1029 enum ssl_verify_level {
1030    SSL_VERIFY_IGNORE,
1031    SSL_VERIFY_WARN,
1032    SSL_VERIFY_ASK,
1033    SSL_VERIFY_STRICT
1034 };
1035 #endif
1036
1037 enum tdflags {
1038    TD_NONE,                   /* no display conversion */
1039    TD_ISPR        = 1<<0,     /* use isprint() checks */
1040    TD_ICONV       = 1<<1,     /* use iconv() */
1041    TD_DELCTRL     = 1<<2,     /* delete control characters */
1042
1043    /*
1044     * NOTE: _TD_EOF and _TD_BUFCOPY may be ORd with enum conversion and
1045     * enum sendaction, and may thus NOT clash with their bit range!
1046     */
1047    _TD_EOF        = 1<<14,    /* EOF seen, last round! */
1048    _TD_BUFCOPY    = 1<<15     /* Buffer may be constant, copy it */
1049 };
1050
1051 enum user_options {
1052    OPT_NONE,
1053    OPT_DEBUG      = 1u<< 0,   /* -d / *debug* */
1054    OPT_VERB       = 1u<< 1,   /* -v / *verbose* */
1055    OPT_VERBVERB   = 1u<< 2,   /* .. even more verbosity */
1056    OPT_EXISTONLY  = 1u<< 3,   /* -e */
1057    OPT_HEADERSONLY = 1u<<4,   /* -H */
1058    OPT_HEADERLIST = 1u<< 5,   /* -L */
1059    OPT_QUICKRUN_MASK = OPT_EXISTONLY | OPT_HEADERSONLY | OPT_HEADERLIST,
1060    OPT_NOSRC      = 1u<< 6,   /* -n */
1061    OPT_E_FLAG     = 1u<< 7,   /* -E / *skipemptybody* */
1062    OPT_F_FLAG     = 1u<< 8,   /* -F */
1063    OPT_N_FLAG     = 1u<< 9,   /* -N / *header* */
1064    OPT_R_FLAG     = 1u<<10,   /* -R */
1065    OPT_r_FLAG     = 1u<<11,   /* -r (plus option_r_arg) */
1066    OPT_t_FLAG     = 1u<<12,   /* -t */
1067    OPT_u_FLAG     = 1u<<13,   /* -u / $USER and pw->pw_uid != getuid(2) */
1068    OPT_TILDE_FLAG = 1u<<14,   /* -~ */
1069    OPT_BATCH_FLAG = 1u<<15,   /* -# */
1070
1071    /*  */
1072    OPT_MEMDEBUG   = 1<<16,    /* *memdebug* */
1073
1074    /*  */
1075    OPT_SENDMODE   = 1u<<17,   /* Usage case forces send mode */
1076    OPT_INTERACTIVE = 1u<<18,  /* isatty(0) */
1077    OPT_TTYIN      = OPT_INTERACTIVE,
1078    OPT_TTYOUT     = 1u<<19,
1079    OPT_UNICODE    = 1u<<20,   /* We're in an UTF-8 environment */
1080    OPT_ENC_MBSTATE = 1u<<21,  /* Multibyte environment with shift states */
1081
1082    /* Some easy-access shortcuts */
1083    OPT_D_V        = OPT_DEBUG | OPT_VERB,
1084    OPT_D_VV       = OPT_DEBUG | OPT_VERBVERB,
1085    OPT_D_V_VV     = OPT_DEBUG | OPT_VERB | OPT_VERBVERB
1086 };
1087
1088 #define IS_TTY_SESSION() \
1089    ((options & (OPT_TTYIN | OPT_TTYOUT)) == (OPT_TTYIN | OPT_TTYOUT))
1090
1091 #define OBSOLETE(X) \
1092 do {\
1093    if (options & OPT_D_V_VV)\
1094       n_err("%s: %s\n", _("Obsoletion warning"), X);\
1095 } while (0)
1096 #define OBSOLETE2(X,Y) \
1097 do {\
1098    if (options & OPT_D_V_VV)\
1099       n_err("%s: %s: %s\n", _("Obsoletion warning"), X, Y);\
1100 } while (0)
1101
1102 enum program_state {
1103    PS_STARTED        = 1<< 0,       /* main.c startup code passed, functional */
1104
1105    PS_LOADING        = 1<< 1,       /* Loading user resource files, startup */
1106    PS_SOURCING       = 1<< 2,       /* Sourcing a resource file */
1107    PS_IN_LOAD        = PS_LOADING | PS_SOURCING,
1108
1109    PS_EVAL_ERROR     = 1<< 4,       /* Last evaluate() command failed */
1110
1111    PS_HOOK_NEWMAIL   = 1<< 6,
1112    PS_HOOK           = 1<< 7,
1113    PS_HOOK_MASK      = PS_HOOK_NEWMAIL | PS_HOOK,
1114
1115    PS_EDIT           = 1<< 8,       /* Current mailbox not a "system mailbox" */
1116    PS_SETFILE_OPENED = 1<< 9,       /* (hack) setfile() opened a new box */
1117    PS_SAW_COMMAND    = 1<<10,       /* ..after mailbox switch */
1118
1119    PS_DID_PRINT_DOT  = 1<<16,       /* Current message has been printed */
1120
1121    PS_MSGLIST_SAW_NO = 1<<17,       /* Last *LIST saw numerics */
1122    PS_MSGLIST_DIRECT = 1<<18,       /* One msg was directly chosen by number */
1123    PS_MSGLIST_MASK   = PS_MSGLIST_SAW_NO | PS_MSGLIST_DIRECT,
1124
1125    PS_HEADER_NEEDED_MIME = 1<<20,   /* mime_write_tohdr() needed x TODO HACK! */
1126
1127    /* Various first-time-init switches */
1128    PS_ERRORS_NOTED   = 1<<24,       /* Ring of `errors' content, print msg */
1129    PS_ATTACHMENTS_NOTED = 1<<25,    /* Attachment filename quoting noted */
1130    PS_t_FLAG         = 1<<26        /* OPT_t_FLAG made persistant */
1131 };
1132
1133 /* A large enum with all the boolean and value options a.k.a their keys.
1134  * Only the constant keys are in here, to be looked up via ok_[bv]look(),
1135  * ok_[bv]set() and ok_[bv]clear().
1136  * Note: see the comments in accmacvar.c before changing *anything* in here! */
1137 enum okeys {
1138    ok_b_add_file_recipients,
1139    ok_v_agent_shell_lookup,
1140    ok_b_allnet,
1141    ok_b_append,
1142    ok_b_ask,
1143    ok_b_askatend,
1144    ok_b_askattach,
1145    ok_b_askbcc,
1146    ok_b_askcc,
1147    ok_b_asksign,
1148    ok_b_asksub,
1149    ok_b_attachment_ask_content_description,
1150    ok_b_attachment_ask_content_disposition,
1151    ok_b_attachment_ask_content_id,
1152    ok_b_attachment_ask_content_type,
1153    ok_v_attrlist,
1154    ok_v_autobcc,
1155    ok_v_autocc,
1156    ok_b_autocollapse,
1157    ok_b_autoprint,
1158 ok_b_autothread,
1159    ok_v_autosort,
1160
1161    ok_b_bang,
1162    ok_b_batch_exit_on_error,
1163    ok_b_bsdannounce,
1164    ok_b_bsdcompat,
1165    ok_b_bsdflags,
1166    ok_b_bsdheadline,
1167    ok_b_bsdmsgs,
1168    ok_b_bsdorder,
1169    ok_b_bsdset,
1170
1171    ok_v_charset_7bit,
1172    ok_v_charset_8bit,
1173    ok_v_charset_unknown_8bit,
1174    ok_v_cmd,
1175    ok_b_colour_disable,
1176    ok_v_colour_from_,                  /* {name=colour-from_} */
1177    ok_v_colour_header,
1178    ok_v_colour_msginfo,
1179    ok_b_colour_pager,
1180    ok_v_colour_partinfo,
1181    ok_v_colour_terms,
1182    ok_v_colour_uheader,
1183    ok_v_colour_user_headers,
1184    ok_v_crt,
1185
1186    ok_v_DEAD,
1187    ok_v_datefield,
1188    ok_v_datefield_markout_older,
1189    ok_b_debug,                         /* {special=1} */
1190    ok_b_disconnected,
1191    ok_b_disposition_notification_send,
1192    ok_b_dot,
1193    ok_b_dotlock_ignore_error,
1194
1195    ok_v_EDITOR,
1196    ok_b_editalong,
1197    ok_b_editheaders,
1198 ok_b_emptybox,
1199    ok_b_emptystart,
1200    ok_v_encoding,
1201    ok_v_escape,
1202    ok_v_expandaddr,
1203    ok_v_expandargv,
1204
1205    ok_v_features,                      /* {rdonly=1,virtual=_features} */
1206    ok_b_flipr,
1207    ok_v_folder,                        /* {special=1} */
1208    ok_v_folder_hook,
1209    ok_b_followup_to,
1210    ok_v_followup_to_honour,
1211    ok_b_forward_as_attachment,
1212    ok_v_from,
1213    ok_b_fullnames,
1214    ok_v_fwdheading,
1215
1216    ok_b_header,                        /* {special=1} */
1217    ok_v_headline,
1218    ok_v_headline_bidi,
1219    ok_v_history_file,
1220    ok_b_history_gabby,
1221    ok_b_history_gabby_persist,
1222    ok_v_history_size,
1223    ok_b_hold,
1224    ok_v_hostname,
1225
1226    ok_b_idna_disable,
1227    ok_b_ignore,
1228    ok_b_ignoreeof,
1229    ok_v_indentprefix,
1230    ok_v_imap_auth,
1231    ok_v_imap_cache,
1232    ok_v_imap_keepalive,
1233    ok_v_imap_list_depth,
1234    ok_b_imap_use_starttls,
1235
1236    ok_b_keep,
1237    ok_b_keep_content_length,
1238    ok_b_keepsave,
1239
1240    ok_v_LISTER,
1241    ok_v_line_editor_cursor_right,      /* {special=1} */
1242    ok_b_line_editor_disable,
1243
1244    ok_v_MAIL,
1245    ok_v_MBOX,
1246    ok_b_markanswered,
1247    ok_b_mbox_rfc4155,
1248    ok_b_memdebug,                      /* {special=1} */
1249    ok_b_message_id_disable,
1250    ok_v_message_inject_head,
1251    ok_v_message_inject_tail,
1252    ok_b_metoo,
1253    ok_b_mime_allow_text_controls,
1254    ok_b_mime_alternative_favour_rich,
1255    ok_v_mime_counter_evidence,
1256    ok_v_mimetypes_load_control,
1257
1258    ok_v_NAIL_EXTRA_RC,                 /* {name=NAIL_EXTRA_RC} */
1259 ok_v_NAIL_HEAD,                     /* {name=NAIL_HEAD} */
1260 ok_v_NAIL_HISTFILE,                 /* {name=NAIL_HISTFILE} */
1261 ok_v_NAIL_HISTSIZE,                 /* {name=NAIL_HISTSIZE} */
1262 ok_v_NAIL_TAIL,                     /* {name=NAIL_TAIL} */
1263    ok_b_netrc_lookup,
1264    ok_v_newfolders,
1265    ok_v_newmail,
1266
1267    ok_v_ORGANIZATION,
1268    ok_b_outfolder,
1269
1270    ok_v_PAGER,
1271    ok_b_page,
1272    ok_v_password,
1273    ok_b_piperaw,
1274    ok_v_pop3_auth,
1275    ok_b_pop3_bulk_load,
1276    ok_v_pop3_keepalive,
1277    ok_b_pop3_no_apop,
1278    ok_b_pop3_use_starttls,
1279    ok_b_print_all_chars,
1280    ok_b_print_alternatives,
1281    ok_v_prompt,
1282
1283    ok_b_quiet,
1284    ok_v_quote,
1285    ok_b_quote_as_attachment,
1286    ok_v_quote_fold,
1287
1288    ok_b_recipients_in_cc,
1289    ok_v_record,
1290    ok_b_record_resent,
1291    ok_b_reply_in_same_charset,
1292    ok_v_reply_strings,
1293    ok_v_replyto,
1294    ok_v_reply_to_honour,
1295    ok_b_rfc822_body_from_,             /* {name=rfc822-body-from_} */
1296
1297    ok_v_SHELL,
1298    ok_b_save,
1299    ok_v_screen,
1300    ok_b_searchheaders,
1301    ok_v_sendcharsets,
1302    ok_b_sendcharsets_else_ttycharset,
1303    ok_v_sender,
1304    ok_v_sendmail,
1305    ok_v_sendmail_arguments,
1306    ok_b_sendmail_no_default_arguments,
1307    ok_v_sendmail_progname,
1308    ok_b_sendwait,
1309    ok_b_showlast,
1310    ok_b_showname,
1311    ok_b_showto,
1312    ok_v_Sign,
1313    ok_v_sign,
1314    ok_v_signature,
1315    ok_b_skipemptybody,                 /* {special=1} */
1316    ok_v_smime_ca_dir,
1317    ok_v_smime_ca_file,
1318    ok_v_smime_cipher,
1319    ok_v_smime_crl_dir,
1320    ok_v_smime_crl_file,
1321    /* smime-encrypt-USER@HOST */
1322    ok_b_smime_force_encryption,
1323    ok_b_smime_no_default_ca,
1324    ok_b_smime_sign,
1325    ok_v_smime_sign_cert,
1326    ok_v_smime_sign_include_certs,
1327    ok_v_smime_sign_message_digest,
1328    ok_v_smtp,
1329    ok_v_smtp_auth,
1330 ok_v_smtp_auth_password,
1331 ok_v_smtp_auth_user,
1332    ok_v_smtp_hostname,
1333    ok_b_smtp_use_starttls,
1334    ok_v_spam_interface,
1335    ok_v_spam_maxsize,
1336    ok_v_spamc_command,
1337    ok_v_spamc_arguments,
1338    ok_v_spamc_user,
1339    ok_v_spamd_socket,
1340    ok_v_spamd_user,
1341    ok_v_spamfilter_ham,
1342    ok_v_spamfilter_noham,
1343    ok_v_spamfilter_nospam,
1344    ok_v_spamfilter_rate,
1345    ok_v_spamfilter_rate_scanscore,
1346    ok_v_spamfilter_spam,
1347    ok_v_ssl_ca_dir,
1348    ok_v_ssl_ca_file,
1349    ok_v_ssl_cert,
1350    ok_v_ssl_cipher_list,
1351    ok_v_ssl_config_file,
1352    ok_v_ssl_crl_dir,
1353    ok_v_ssl_crl_file,
1354    ok_v_ssl_key,
1355    ok_v_ssl_method,
1356    ok_b_ssl_no_default_ca,
1357    ok_v_ssl_protocol,
1358    ok_v_ssl_rand_egd,
1359    ok_v_ssl_rand_file,
1360    ok_v_ssl_verify,
1361    ok_v_stealthmua,
1362
1363    ok_b_term_ca_mode,
1364    ok_v_toplines,
1365    ok_v_ttycharset,
1366
1367    ok_v_user,
1368
1369    ok_v_VISUAL,
1370    ok_b_v15_compat,
1371    ok_b_verbose,                       /* {special=1} */
1372    ok_v_version,                       /* {rdonly=1,virtual=VERSION} */
1373    ok_v_version_major,                 /* {rdonly=1,virtual=VERSION_MAJOR} */
1374    ok_v_version_minor,                 /* {rdonly=1,virtual=VERSION_MINOR} */
1375    ok_v_version_update,                /* {rdonly=1,virtual=VERSION_UPDATE} */
1376
1377    ok_b_writebackedited
1378 };
1379
1380 /* Locale-independent character classes */
1381 enum {
1382    C_CNTRL        = 0000,
1383    C_BLANK        = 0001,
1384    C_WHITE        = 0002,
1385    C_SPACE        = 0004,
1386    C_PUNCT        = 0010,
1387    C_OCTAL        = 0020,
1388    C_DIGIT        = 0040,
1389    C_UPPER        = 0100,
1390    C_LOWER        = 0200
1391 };
1392
1393 struct str {
1394    char     *s;      /* the string's content */
1395    size_t   l;       /* the stings's length */
1396 };
1397
1398 struct colour_table {
1399    /* Plus a copy of *colour-user-headers* */
1400    struct str  ct_csinfo[COLOURSPEC_RESET+1 + 1];
1401 };
1402
1403 struct bidi_info {
1404    struct str  bi_start;      /* Start of (possibly) bidirectional text */
1405    struct str  bi_end;        /* End of ... */
1406    size_t      bi_pad;        /* No of visual columns to reserve for BIDI pad */
1407 };
1408
1409 struct url {
1410    char const     *url_input;       /* Input as given (really) */
1411    enum cproto    url_cproto;       /* Communication protocol as given */
1412    bool_t         url_needs_tls;    /* Wether the protocol uses SSL/TLS */
1413    bool_t         url_had_user;     /* Wether .url_user was part of the URL */
1414    ui16_t         url_portno;       /* atoi .url_port or default, host endian */
1415    char const     *url_port;        /* Port (if given) or NULL */
1416    char           url_proto[14];    /* Communication protocol as 'xy\0//' */
1417    ui8_t          url_proto_len;    /* Length of .url_proto ('\0' index) */
1418    ui8_t          url_proto_xlen;   /* .. if '\0' is replaced with ':' */
1419    struct str     url_user;         /* User, exactly as given / looked up */
1420    struct str     url_user_enc;     /* User, urlxenc()oded */
1421    struct str     url_pass;         /* Pass (urlxdec()oded) or NULL */
1422    struct str     url_host;         /* Service hostname */
1423    struct str     url_path;         /* CPROTO_IMAP: path suffix or NULL */
1424    /* TODO: url_get_component(url *, enum COMPONENT, str *store) */
1425    struct str     url_h_p;          /* .url_host[:.url_port] */
1426    /* .url_user@.url_host
1427     * Note: for CPROTO_SMTP this may resolve HOST via *smtp-hostname* (->
1428     * *hostname*)!  (And may later be overwritten according to *from*!) */
1429    struct str     url_u_h;
1430    struct str     url_u_h_p;        /* .url_user@.url_host[:.url_port] */
1431    struct str     url_eu_h_p;       /* .url_user_enc@.url_host[:.url_port] */
1432    char const     *url_p_u_h_p;     /* .url_proto://.url_u_h_p */
1433    char const     *url_p_eu_h_p;    /* .url_proto://.url_eu_h_p */
1434    char const     *url_p_eu_h_p_p;  /* .url_proto://.url_eu_h_p[/.url_path] */
1435 };
1436
1437 struct ccred {
1438    enum cproto    cc_cproto;     /* Communication protocol */
1439    enum authtype  cc_authtype;   /* Desired authentication */
1440    char const     *cc_auth;      /* Authentication type as string */
1441    struct str     cc_user;       /* User (urlxdec()oded) or NULL */
1442    struct str     cc_pass;       /* Password (urlxdec()oded) or NULL */
1443 };
1444
1445 #ifdef HAVE_DOTLOCK
1446 struct dotlock_info {
1447    char const  *di_file_name;    /* Mailbox to lock */
1448    char const  *di_lock_name;    /* .di_file_name + .lock */
1449    char const  *di_hostname;     /* ..filled in parent (due resolver delays) */
1450    char const  *di_randstr;      /* ..ditto, random string */
1451    size_t      di_pollmsecs;     /* Delay in between locking attempts */
1452    struct stat *di_stb;
1453 };
1454 #endif
1455
1456 struct mime_handler {
1457    enum mime_handler_flags mh_flags;
1458    struct str  mh_msg;           /* Message describing this command */
1459    /* XXX union{} the following? */
1460    char const  *mh_shell_cmd;    /* For MIME_HDL_CMD */
1461    int         (*mh_ptf)(void);  /* PTF main() for MIME_HDL_PTF */
1462 };
1463
1464 struct time_current {
1465    time_t      tc_time;
1466    struct tm   tc_gm;
1467    struct tm   tc_local;
1468    char        tc_ctime[32];
1469 };
1470
1471 struct quoteflt {
1472    FILE        *qf_os;        /* Output stream */
1473    char const  *qf_pfix;
1474    ui32_t      qf_pfix_len;   /* Length of prefix: 0: bypass */
1475    ui32_t      qf_qfold_min;  /* Simple way: wrote prefix? */
1476 #ifdef HAVE_QUOTE_FOLD
1477    ui32_t      qf_qfold_max;  /* Otherwise: line lengths */
1478    ui8_t       qf_state;      /* *quote-fold* state machine */
1479    bool_t      qf_brk_isws;   /* Breakpoint is at WS */
1480    ui8_t       __dummy[2];
1481    ui32_t      qf_wscnt;      /* Whitespace count */
1482    ui32_t      qf_brkl;       /* Breakpoint */
1483    ui32_t      qf_brkw;       /* Visual width, breakpoint */
1484    ui32_t      qf_datw;       /* Current visual output line width */
1485    struct str  qf_dat;        /* Current visual output line */
1486    struct str  qf_currq;      /* Current quote, compressed */
1487    mbstate_t   qf_mbps[2];
1488 #endif
1489 };
1490
1491 #ifdef HAVE_FILTER_HTML_TAGSOUP
1492 struct htmlflt {
1493    FILE        *hf_os;        /* Output stream */
1494    ui32_t      hf_flags;
1495    ui32_t      hf_lmax;       /* Maximum byte +1 in .hf_line/4 */
1496    ui32_t      hf_len;        /* Current bytes in .hf_line */
1497    ui32_t      hf_last_ws;    /* Last whitespace on line (fold purposes) */
1498    ui32_t      hf_mboff;      /* Last offset for "mbtowc" */
1499    ui32_t      hf_mbwidth;    /* We count characters not bytes if possible */
1500    char        *hf_line;      /* Output line buffer - MUST be last field! */
1501    si32_t      hf_href_dist;  /* Count of lines since last HREF flush */
1502    ui32_t      hf_href_no;    /* HREF sequence number */
1503    struct htmlflt_href *hf_hrefs;
1504    struct htmlflt_tag const *hf_ign_tag; /* Tag that will end ignore mode */
1505    char        *hf_curr;      /* Current cursor into .hf_bdat */
1506    char        *hf_bmax;      /* Maximum byte in .hf_bdat +1 */
1507    char        *hf_bdat;      /* (Temporary) Tag content data storage */
1508 };
1509 #endif
1510
1511 struct search_expr {
1512    char const  *ss_where;     /* ..to search for the expr. (not always used) */
1513    char const  *ss_sexpr;     /* String search expr.; NULL: use .ss_regex */
1514 #ifdef HAVE_REGEX
1515    regex_t     ss_regex;
1516 #endif
1517 };
1518
1519 struct eval_ctx {
1520    struct str  ev_line;          /* The terminated data to evaluate */
1521    ui32_t      ev_line_size;     /* May be used to store line memory size */
1522    bool_t      ev_is_recursive;  /* Evaluation in evaluation? (collect ~:) */
1523    ui8_t       __dummy[3];
1524    bool_t      ev_add_history;   /* Enter (final) command in history? */
1525    char const  *ev_new_content;  /* History: reenter line, start with this */
1526 };
1527
1528 struct termios_state {
1529    struct termios ts_tios;
1530    char        *ts_linebuf;
1531    size_t      ts_linesize;
1532    bool_t      ts_needs_reset;
1533 };
1534
1535 #define termios_state_reset() \
1536 do {\
1537    if (termios_state.ts_needs_reset) {\
1538       tcsetattr(0, TCSADRAIN, &termios_state.ts_tios);\
1539       termios_state.ts_needs_reset = FAL0;\
1540    }\
1541 } while (0)
1542
1543 struct sock {                 /* data associated with a socket */
1544    int         s_fd;          /* file descriptor */
1545 #ifdef HAVE_SSL
1546    int         s_use_ssl;     /* SSL is used */
1547 # ifdef HAVE_OPENSSL
1548    void        *s_ssl;        /* SSL object */
1549 # endif
1550 #endif
1551    char        *s_wbuf;       /* for buffered writes */
1552    int         s_wbufsize;    /* allocated size of s_buf */
1553    int         s_wbufpos;     /* position of first empty data byte */
1554    char        *s_rbufptr;    /* read pointer to s_rbuf */
1555    int         s_rsz;         /* size of last read in s_rbuf */
1556    char const  *s_desc;       /* description of error messages */
1557    void        (*s_onclose)(void);     /* execute on close */
1558    char        s_rbuf[LINESIZE + 1];   /* for buffered reads */
1559 };
1560
1561 struct sockconn {
1562    struct url     sc_url;
1563    struct ccred   sc_cred;
1564    struct sock    sc_sock;
1565 };
1566
1567 struct mailbox {
1568    enum {
1569       MB_NONE     = 000,      /* no reply expected */
1570       MB_COMD     = 001,      /* command reply expected */
1571       MB_MULT     = 002,      /* multiline reply expected */
1572       MB_PREAUTH  = 004,      /* not in authenticated state */
1573       MB_BYE      = 010       /* may accept a BYE state */
1574    }           mb_active;
1575    FILE        *mb_itf;       /* temp file with messages, read open */
1576    FILE        *mb_otf;       /* same, write open */
1577    char        *mb_sorted;    /* sort method */
1578    enum {
1579       MB_VOID,       /* no type (e. g. connection failed) */
1580       MB_FILE,       /* local file */
1581       MB_POP3,       /* POP3 mailbox */
1582       MB_IMAP,       /* IMAP mailbox */
1583       MB_MAILDIR,    /* maildir folder */
1584       MB_CACHE       /* cached mailbox */
1585    }           mb_type;       /* type of mailbox */
1586    enum {
1587       MB_DELE = 01,  /* may delete messages in mailbox */
1588       MB_EDIT = 02   /* may edit messages in mailbox */
1589    }           mb_perm;
1590    int mb_threaded;           /* mailbox has been threaded */
1591 #ifdef HAVE_IMAP
1592    enum mbflags {
1593       MB_NOFLAGS  = 000,
1594       MB_UIDPLUS  = 001 /* supports IMAP UIDPLUS */
1595    }           mb_flags;
1596    unsigned long  mb_uidvalidity;   /* IMAP unique identifier validity */
1597    char        *mb_imap_account;    /* name of current IMAP account */
1598    char        *mb_imap_pass;       /* xxx v15-compat URL workaround */
1599    char        *mb_imap_mailbox;    /* name of current IMAP mailbox */
1600    char        *mb_cache_directory; /* name of cache directory */
1601 #endif
1602    struct sock mb_sock;       /* socket structure */
1603 };
1604
1605 enum needspec {
1606    NEED_UNSPEC,      /* unspecified need, don't fetch */
1607    NEED_HEADER,      /* need the header of a message */
1608    NEED_BODY         /* need header and body of a message */
1609 };
1610
1611 enum havespec {
1612    HAVE_NOTHING,              /* nothing downloaded yet */
1613    HAVE_HEADER    = 01,       /* header is downloaded */
1614    HAVE_BODY      = 02        /* entire message is downloaded */
1615 };
1616
1617 /* flag bits. Attention: Flags that are used in cache.c may not change */
1618 enum mflag {
1619    MUSED          = (1<< 0),  /* entry is used, but this bit isn't */
1620    MDELETED       = (1<< 1),  /* entry has been deleted */
1621    MSAVED         = (1<< 2),  /* entry has been saved */
1622    MTOUCH         = (1<< 3),  /* entry has been noticed */
1623    MPRESERVE      = (1<< 4),  /* keep entry in sys mailbox */
1624    MMARK          = (1<< 5),  /* message is marked! */
1625    MODIFY         = (1<< 6),  /* message has been modified */
1626    MNEW           = (1<< 7),  /* message has never been seen */
1627    MREAD          = (1<< 8),  /* message has been read sometime. */
1628    MSTATUS        = (1<< 9),  /* message status has changed */
1629    MBOX           = (1<<10),  /* Send this to mbox, regardless */
1630    MNOFROM        = (1<<11),  /* no From line */
1631    MHIDDEN        = (1<<12),  /* message is hidden to user */
1632    MFULLYCACHED   = (1<<13),  /* message is completely cached */
1633    MBOXED         = (1<<14),  /* message has been sent to mbox */
1634    MUNLINKED      = (1<<15),  /* message was unlinked from cache */
1635    MNEWEST        = (1<<16),  /* message is very new (newmail) */
1636    MFLAG          = (1<<17),  /* message has been flagged recently */
1637    MUNFLAG        = (1<<18),  /* message has been unflagged */
1638    MFLAGGED       = (1<<19),  /* message is `flagged' */
1639    MANSWER        = (1<<20),  /* message has been answered recently */
1640    MUNANSWER      = (1<<21),  /* message has been unanswered */
1641    MANSWERED      = (1<<22),  /* message is `answered' */
1642    MDRAFT         = (1<<23),  /* message has been drafted recently */
1643    MUNDRAFT       = (1<<24),  /* message has been undrafted */
1644    MDRAFTED       = (1<<25),  /* message is marked as `draft' */
1645    MOLDMARK       = (1<<26),  /* messages was marked previously */
1646    MSPAM          = (1<<27),  /* message is classified as spam */
1647    MSPAMUNSURE    = (1<<28)   /* message may be spam, but it is unsure */
1648 };
1649 #define MMNORM          (MDELETED | MSAVED | MHIDDEN)
1650 #define MMNDEL          (MDELETED | MHIDDEN)
1651
1652 #define visible(mp)     (((mp)->m_flag & MMNDEL) == 0)
1653
1654 struct mimepart {
1655    enum mflag  m_flag;        /* flags */
1656    enum havespec m_have;      /* downloaded parts of the part */
1657 #ifdef HAVE_SPAM
1658    ui32_t      m_spamscore;   /* Spam score as int, 24:8 bits */
1659 #endif
1660    int         m_block;       /* block number of this part */
1661    size_t      m_offset;      /* offset in block of part */
1662    size_t      m_size;        /* Bytes in the part */
1663    size_t      m_xsize;       /* Bytes in the full part */
1664    long        m_lines;       /* Lines in the message */
1665    long        m_xlines;      /* Lines in the full message */
1666    time_t      m_time;        /* time the message was sent */
1667    char const  *m_from;       /* message sender */
1668    struct mimepart *m_nextpart;     /* next part at same level */
1669    struct mimepart *m_multipart;    /* parts of multipart */
1670    struct mimepart *m_parent;       /* enclosing multipart part */
1671    char const  *m_ct_type;          /* content-type */
1672    char const  *m_ct_type_plain;    /* content-type without specs */
1673    char const  *m_ct_type_usr_ovwr; /* Forcefully overwritten one */
1674    enum mimecontent m_mimecontent;  /* same in enum */
1675    char const  *m_charset;    /* charset */
1676    char const  *m_ct_enc;     /* content-transfer-encoding */
1677    enum mime_enc m_mime_enc;     /* same in enum */
1678    char        *m_partstring; /* part level string */
1679    char        *m_filename;   /* attachment filename */
1680 };
1681
1682 struct message {
1683    enum mflag  m_flag;        /* flags */
1684    enum havespec m_have;      /* downloaded parts of the message */
1685 #ifdef HAVE_SPAM
1686    ui32_t      m_spamscore;   /* Spam score as int, 24:8 bits */
1687 #endif
1688    int         m_block;       /* block number of this message */
1689    size_t      m_offset;      /* offset in block of message */
1690    size_t      m_size;        /* Bytes in the message */
1691    size_t      m_xsize;       /* Bytes in the full message */
1692    long        m_lines;       /* Lines in the message */
1693    long        m_xlines;      /* Lines in the full message */
1694    time_t      m_time;        /* time the message was sent */
1695    time_t      m_date;        /* time in the 'Date' field */
1696    unsigned    m_idhash;      /* hash on Message-ID for threads */
1697    struct message *m_child;   /* first child of this message */
1698    struct message *m_younger; /* younger brother of this message */
1699    struct message *m_elder;   /* elder brother of this message */
1700    struct message *m_parent;  /* parent of this message */
1701    unsigned    m_level;       /* thread level of message */
1702    long        m_threadpos;   /* position in threaded display */
1703 #ifdef HAVE_IMAP
1704    unsigned long m_uid;       /* IMAP unique identifier */
1705 #endif
1706    char        *m_maildir_file;  /* original maildir file of msg */
1707    ui32_t      m_maildir_hash;   /* hash of file name in maildir sub */
1708    int         m_collapsed;      /* collapsed thread information */
1709 };
1710
1711 /* Given a file address, determine the block number it represents */
1712 #define mailx_blockof(off)                ((int) ((off) / 4096))
1713 #define mailx_offsetof(off)               ((int) ((off) % 4096))
1714 #define mailx_positionof(block, offset)   ((off_t)(block) * 4096 + (offset))
1715
1716 /* Argument types */
1717 enum argtype {
1718    ARG_MSGLIST    = 0,        /* Message list type */
1719    ARG_STRLIST    = 1,        /* A pure string */
1720    ARG_RAWLIST    = 2,        /* Shell string list */
1721    ARG_NOLIST     = 3,        /* Just plain 0 */
1722    ARG_NDMLIST    = 4,        /* Message list, no defaults */
1723    ARG_ECHOLIST   = 5,        /* Like raw list, but keep quote chars */
1724    ARG_ARGMASK    = 7,        /* Mask of the above */
1725
1726    ARG_A          = 1u<< 4,   /* Needs an active mailbox */
1727    ARG_F          = 1u<< 5,   /* Is a conditional command */
1728    ARG_H          = 1u<< 6,   /* Never place in history */
1729    ARG_I          = 1u<< 7,   /* Interactive command bit */
1730    ARG_M          = 1u<< 8,   /* Legal from send mode bit */
1731    ARG_P          = 1u<< 9,   /* Autoprint dot after command */
1732    ARG_R          = 1u<<10,   /* Cannot be called from collect / recursion */
1733    ARG_T          = 1u<<11,   /* Is a transparent command */
1734    ARG_V          = 1u<<12,   /* Places data in temporary_arg_v_store */
1735    ARG_W          = 1u<<13,   /* Invalid when read only bit */
1736    ARG_O          = 1u<<14    /* OBSOLETE()d command */
1737 };
1738
1739 enum gfield {
1740    GTO            = 1<< 0,    /* Grab To: line */
1741    GSUBJECT       = 1<< 1,    /* Likewise, Subject: line */
1742    GCC            = 1<< 2,    /* And the Cc: line */
1743    GBCC           = 1<< 3,    /* And also the Bcc: line */
1744
1745    GNL            = 1<< 4,    /* Print blank line after */
1746    GDEL           = 1<< 5,    /* Entity removed from list */
1747    GCOMMA         = 1<< 6,    /* detract puts in commas */
1748    GUA            = 1<< 7,    /* User-Agent field */
1749    GMIME          = 1<< 8,    /* MIME 1.0 fields */
1750    GMSGID         = 1<< 9,    /* a Message-ID */
1751
1752    GIDENT         = 1<<11,    /* From:, Reply-To:, Organization:, MFT: */
1753    GREF           = 1<<12,    /* References:, In-Reply-To:, (Message-Id:) */
1754    GDATE          = 1<<13,    /* Date: field */
1755    GFULL          = 1<<14,    /* Include full names, comments etc. */
1756    GSKIN          = 1<<15,    /* Skin names */
1757    GEXTRA         = 1<<16,    /* Extra fields (mostly like GIDENT XXX) */
1758    GFILES         = 1<<17,    /* Include filename and pipe addresses */
1759    GFULLEXTRA     = 1<<18     /* Only with GFULL: GFULL less address */
1760 };
1761 #define GMASK           (GTO | GSUBJECT | GCC | GBCC)
1762
1763 enum header_flags {
1764    HF_NONE        = 0,
1765    HF_LIST_REPLY  = 1<< 0,
1766    HF_MFT_SENDER  = 1<< 1,    /* Add ourselves to Mail-Followup-To: */
1767    HF_RECIPIENT_RECORD = 1<<10, /* Save message in file named after rec. */
1768    HF__NEXT_SHIFT = 11
1769 };
1770
1771 /* Structure used to pass about the current state of a message (header) */
1772 struct header {
1773    ui32_t      h_flags;       /* enum header_flags bits */
1774    ui32_t      h_dummy;
1775    struct name *h_to;         /* Dynamic "To:" string */
1776    char        *h_subject;    /* Subject string */
1777    struct name *h_cc;         /* Carbon copies string */
1778    struct name *h_bcc;        /* Blind carbon copies */
1779    struct name *h_ref;        /* References (possibly overridden) */
1780    struct attachment *h_attach; /* MIME attachments */
1781    char        *h_charset;    /* preferred charset */
1782    struct name *h_from;       /* overridden "From:" field */
1783    struct name *h_sender;     /* overridden "Sender:" field */
1784    struct name *h_replyto;    /* overridden "Reply-To:" field */
1785    struct name *h_message_id; /* overridden "Message-ID:" field */
1786    struct name *h_in_reply_to;/* overridden "In-Reply-To:" field */
1787    struct name *h_mft;        /* Mail-Followup-To */
1788    char const  *h_list_post;  /* Address from List-Post:, for `Lreply' */
1789    char        *h_organization; /* overridden "Organization:" field */
1790 };
1791
1792 /* Handling of namelist nodes used in processing the recipients of mail and
1793  * aliases, inspection of mail-addresses and all that kind of stuff */
1794 enum nameflags {
1795    NAME_NAME_SALLOC        = 1<< 0, /* .n_name is doped */
1796    NAME_FULLNAME_SALLOC    = 1<< 1, /* .n_fullname is doped */
1797    NAME_SKINNED            = 1<< 2, /* Is actually skin()ned */
1798    NAME_IDNA               = 1<< 3, /* IDNA was applied */
1799
1800    NAME_ADDRSPEC_CHECKED   = 1<< 4, /* Address has been .. and */
1801    NAME_ADDRSPEC_ISFILE    = 1<< 5, /* ..is a file path */
1802    NAME_ADDRSPEC_ISPIPE    = 1<< 6, /* ..is a command for piping */
1803    NAME_ADDRSPEC_ISFILEORPIPE = NAME_ADDRSPEC_ISFILE | NAME_ADDRSPEC_ISPIPE,
1804    NAME_ADDRSPEC_ISNAME    = 1<< 7, /* ..is a valid mail network address */
1805    NAME_ADDRSPEC_ISADDR    = 1<< 8, /* ..is a valid mail network address */
1806
1807    NAME_ADDRSPEC_ERR_EMPTY = 1<< 9, /* An empty string (or NULL) */
1808    NAME_ADDRSPEC_ERR_ATSEQ = 1<<10, /* Weird @ sequence */
1809    NAME_ADDRSPEC_ERR_CHAR  = 1<<11, /* Invalid character */
1810    NAME_ADDRSPEC_ERR_IDNA  = 1<<12, /* IDNA convertion failed */
1811    NAME_ADDRSPEC_INVALID   = NAME_ADDRSPEC_ERR_EMPTY |
1812          NAME_ADDRSPEC_ERR_ATSEQ | NAME_ADDRSPEC_ERR_CHAR |
1813          NAME_ADDRSPEC_ERR_IDNA,
1814
1815    /* Error storage (we must fit in 31-bit) */
1816    _NAME_SHIFTWC  = 13,
1817    _NAME_MAXWC    = 0x3FFFF,
1818    _NAME_MASKWC   = _NAME_MAXWC << _NAME_SHIFTWC
1819 };
1820
1821 /* In the !_ERR_EMPTY case, the failing character can be queried */
1822 #define NAME_ADDRSPEC_ERR_GETWC(F)  \
1823    ((((unsigned int)(F) & _NAME_MASKWC) >> _NAME_SHIFTWC) & _NAME_MAXWC)
1824 #define NAME_ADDRSPEC_ERR_SET(F, E, WC) \
1825 do {\
1826    (F) = ((F) & ~(NAME_ADDRSPEC_INVALID | _NAME_MASKWC)) |\
1827          (E) | (((unsigned int)(WC) & _NAME_MAXWC) << _NAME_SHIFTWC);\
1828 } while (0)
1829
1830 struct name {
1831    struct name *n_flink;      /* Forward link in list. */
1832    struct name *n_blink;      /* Backward list link */
1833    enum gfield n_type;        /* From which list it came */
1834    enum nameflags n_flags;    /* enum nameflags */
1835    char        *n_name;       /* This fella's address */
1836    char        *n_fullname;   /* Ditto, unless GFULL including comment */
1837    char        *n_fullextra;  /* GFULL, without address */
1838 };
1839
1840 struct addrguts {
1841    char const  *ag_input;     /* Input string as given */
1842    size_t      ag_ilen;       /* strlen() of input */
1843    size_t      ag_iaddr_start; /* Start of *addr-spec* in .ag_input */
1844    size_t      ag_iaddr_aend; /* ..and one past its end */
1845    char        *ag_skinned;   /* Output (alloced if !=.ag_input) */
1846    size_t      ag_slen;       /* strlen() of .ag_skinned */
1847    size_t      ag_sdom_start; /* Start of domain in .ag_skinned, */
1848    enum nameflags ag_n_flags; /* enum nameflags of .ag_skinned */
1849 };
1850
1851 /* MIME attachments */
1852 enum attach_conv {
1853    AC_DEFAULT,       /* _get_lc() -> _iter_*() */
1854    AC_FIX_OUTCS,     /* _get_lc() -> "charset=" .a_charset */
1855    AC_FIX_INCS,      /* "charset=".a_input_charset (nocnv) */
1856    AC_TMPFILE        /* attachment.a_tmpf is converted */
1857 };
1858
1859 struct attachment {
1860    struct attachment *a_flink;   /* Forward link in list. */
1861    struct attachment *a_blink;   /* Backward list link */
1862    char const  *a_name;       /* file name */
1863    char const  *a_content_type;  /* content type */
1864    char const  *a_content_disposition; /* content disposition */
1865    char const  *a_content_id; /* content id */
1866    char const  *a_content_description; /* content description */
1867    char const  *a_input_charset; /* Interpretation depends on .a_conv */
1868    char const  *a_charset;    /* ... */
1869    FILE        *a_tmpf;       /* If AC_TMPFILE */
1870    enum attach_conv a_conv;   /* User chosen conversion */
1871    int         a_msgno;       /* message number */
1872 };
1873
1874 struct sendbundle {
1875    struct header  *sb_hp;
1876    struct name    *sb_to;
1877    FILE           *sb_input;
1878    struct str     sb_signer;  /* USER@HOST for signing+ */
1879    struct url     sb_url;
1880    struct ccred   sb_ccred;
1881 };
1882
1883 /* Structure of the hash table of ignored header fields */
1884 struct ignoretab {
1885    int         i_count;       /* Number of entries */
1886    struct ignored {
1887       struct ignored *i_link;    /* Next ignored field in bucket */
1888       char           *i_field;   /* This ignored field */
1889    }           *i_head[HSHSIZE];
1890 };
1891
1892 /* For saving the current directory and later returning */
1893 struct cw {
1894 #ifdef HAVE_FCHDIR
1895    int         cw_fd;
1896 #else
1897    char        cw_wd[PATH_MAX];
1898 #endif
1899 };
1900
1901 /*
1902  * Global variable declarations
1903  *
1904  * These become instantiated in main.c.
1905  */
1906
1907 #undef VL
1908 #ifdef n_MAIN_SOURCE
1909 # ifndef HAVE_AMALGAMATION
1910 #  define VL
1911 # else
1912 #  define VL            static
1913 # endif
1914 #else
1915 # define VL             extern
1916 #endif
1917
1918 VL int         mb_cur_max;          /* Value of MB_CUR_MAX */
1919 VL int         realscreenheight;    /* The real screen height */
1920 VL int         scrnwidth;           /* Screen width, or best guess */
1921 VL int         scrnheight;          /* Screen height/guess (4 header) */
1922
1923 VL char const  *homedir;            /* Path name of home directory */
1924 VL char const  *myname;             /* My login name */
1925 VL char const  *progname;           /* Our name */
1926 VL char const  *tempdir;            /* The temporary directory */
1927
1928 VL gid_t       group_id;            /* getgid() and getuid() */
1929 VL uid_t       user_id;
1930
1931 VL int         exit_status;         /* Exit status */
1932 VL ui32_t      options;             /* Bits of enum user_options */
1933 VL struct name *option_r_arg;       /* Argument to -r option */
1934 VL char const  **smopts;            /* sendmail(1) opts from commline */
1935 VL size_t      smopts_count;        /* Entries in smopts */
1936
1937 VL ui32_t      pstate;              /* Bits of enum program_state */
1938 VL size_t      noreset;             /* String resets suspended (recursive) */
1939
1940 /* XXX stylish sorting */
1941 VL int            msgCount;            /* Count of messages read in */
1942 VL struct mailbox mb;                  /* Current mailbox */
1943 VL int            image;               /* File descriptor for msg image */
1944 VL char           mailname[PATH_MAX];  /* Name of current file TODO URL/object*/
1945 VL char           displayname[80 - 40]; /* Prettyfied for display TODO URL/obj*/
1946 VL char           prevfile[PATH_MAX];  /* Name of previous file TODO URL/obj */
1947 VL char const     *account_name;       /* Current account name or NULL */
1948 VL off_t          mailsize;            /* Size of system mailbox */
1949 VL struct message *dot;                /* Pointer to current message */
1950 VL struct message *prevdot;            /* Previous current message */
1951 VL struct message *message;            /* The actual message structure */
1952 VL struct message *threadroot;         /* first threaded message */
1953 VL int            imap_created_mailbox; /* hack to get feedback from imap */
1954
1955 VL struct ignoretab  ignore[2];        /* ignored and retained fields
1956                                         * 0 is ignore, 1 is retain */
1957 VL struct ignoretab  saveignore[2];    /* ignored and retained fields
1958                                         * on save to folder */
1959 VL struct ignoretab  allignore[2];     /* special, ignore all headers */
1960 VL struct ignoretab  fwdignore[2];     /* fields to ignore for forwarding */
1961
1962 VL struct time_current  time_current;  /* time(3); send: mail1() XXXcarrier */
1963 VL struct termios_state termios_state; /* getpassword(); see commands().. */
1964
1965 #ifdef HAVE_COLOUR
1966 VL struct colour_table  *colour_table;
1967 #endif
1968
1969 #ifdef HAVE_SSL
1970 VL enum ssl_verify_level   ssl_verify_level; /* SSL verification level */
1971 #endif
1972
1973 #ifdef HAVE_ICONV
1974 VL iconv_t     iconvd;
1975 #endif
1976
1977 VL sigjmp_buf  srbuf;
1978 VL int         interrupts;
1979 VL sighandler_type dflpipe;
1980 VL sighandler_type handlerstacktop;
1981 #define handlerpush(f)  (savedtop = handlerstacktop, handlerstacktop = (f))
1982 #define handlerpop()    (handlerstacktop = savedtop)
1983
1984 /* TODO Temporary hacks unless the codebase doesn't jump and uses pass-by-value
1985  * TODO carrier structs instead of locals */
1986 VL char        *temporary_arg_v_store;
1987 VL void        *temporary_localopts_store;
1988 /* TODO temporary storage to overcome which_protocol() mess (for PROTO_FILE) */
1989 VL char const  *temporary_protocol_ext;
1990
1991 /* The remaining variables need initialization */
1992
1993 #ifndef HAVE_AMALGAMATION
1994 VL char const  month_names[12 + 1][4];
1995 VL char const  weekday_names[7 + 1][4];
1996
1997 VL char const  uagent[sizeof UAGENT];
1998
1999 VL uc_i const  class_char[1 + 0x7F];
2000 #endif
2001
2002 /*
2003  * Finally, let's include the function prototypes XXX embed
2004  */
2005
2006 #ifndef n_PRIVSEP_SOURCE
2007 # include "nailfuns.h"
2008 #endif
2009
2010 /* s-it-mode */