1 /*@ S-nail - a mail user agent derived from Berkeley Mail.
2 *@ Header inclusion, macros, constants, types and the global var declarations.
4 * Copyright (c) 2000-2004 Gunnar Ritter, Freiburg i. Br., Germany.
5 * Copyright (c) 2012 - 2015 Steffen (Daode) Nurpmeso <sdaoden@users.sf.net>.
8 * Copyright (c) 1980, 1993
9 * The Regents of the University of California. All rights reserved.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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
37 * Mail -- a mail program
39 * Author: Kurt Shoens (UCB) March 25, 1978
45 #include <sys/types.h>
47 #ifdef HAVE_GETTIMEOFDAY
48 # include <sys/time.h>
64 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
67 # include <inttypes.h>
84 #ifdef HAVE_OPENSSL_MD5
85 # include <openssl/md5.h>
89 * Constants, some nail-specific macros
92 #if !defined NI_MAXHOST
93 # define NI_MAXHOST 1025
96 /* TODO PATH_MAX: fixed-size buffer is always wrong (think NFS) */
99 # define PATH_MAX MAXPATHLEN
101 # define PATH_MAX 1024 /* _XOPEN_PATH_MAX POSIX 2008/Cor 1-2013 */
105 #ifndef HOST_NAME_MAX
106 # ifdef _POSIX_HOST_NAME_MAX
107 # define HOST_NAME_MAX _POSIX_HOST_NAME_MAX
109 # define HOST_NAME_MAX 255
114 # ifdef _POSIX_NAME_MAX
115 # define NAME_MAX _POSIX_NAME_MAX
121 # error NAME_MAX too small
125 # define STDIN_FILENO 0
127 #ifndef STDOUT_FILENO
128 # define STDOUT_FILENO 1
130 #ifndef STDERR_FILENO
131 # define STDERR_FILENO 2
136 # define NSIG NSIG_MAX
138 # define NSIG ((sizeof(sigset_t) * 8) - 1)
142 # define _O_CLOEXEC O_CLOEXEC
143 # define _CLOEXEC_SET(FD) do {;} while(0)
145 # define _O_CLOEXEC 0
146 # define _CLOEXEC_SET(FD) \
147 do { (void)fcntl((FD), F_SETFD, FD_CLOEXEC); } while (0)
152 #if BUFSIZ + 0 > 2560 /* TODO simply use BUFSIZ? */
153 # define LINESIZE BUFSIZ /* max readable line width */
155 # define LINESIZE 2560
157 #define BUFFER_SIZE (BUFSIZ >= (1u << 13) ? BUFSIZ : (1u << 14))
159 /* Network protocol newline */
160 #define NETNL "\015\012"
161 #define NETLINE(X) X NETNL
163 /* Number of Not-Yet-Dead calls that are remembered */
164 #if defined HAVE_DEBUG || defined HAVE_DEVEL || defined HAVE_NYD2
166 # define NYD_CALLS_MAX (25 * 84)
167 # elif defined HAVE_DEVEL
168 # define NYD_CALLS_MAX (25 * 42)
170 # define NYD_CALLS_MAX (25 * 10)
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 */
189 #define ACCOUNT_NULL "null" /* Name of "null" account */
190 #define MAILRC "~/.mailrc"
191 #define NETRC "~/.netrc"
192 #define TMPDIR_FALLBACK "/tmp"
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"
202 # define n_COLOUR(X) X
207 /* The n_COLOUR_TERMS is in addition to those which have "color" in their name!
208 * (Keep in SYNC: ./nail.h:n_COLOUR_TERMS, ./nail.1:*colour-terms*"!) */
209 #define n_COLOUR_TERMS \
210 "aterm,cons25,gnome,konsole,kterm,linux,"\
211 "rxvt,rxvt-unicode,screen,sun,vt100,vt220,wsvt25,xterm"
213 /* Special FD requests for run_command() / start_command() */
214 #define COMMAND_FD_PASS -1
215 #define COMMAND_FD_NULL -2
218 #define FROM_DATEBUF 64 /* Size of RFC 4155 From_ line date */
219 #define DATE_DAYSYEAR 365L
220 #define DATE_SECSMIN 60L
221 #define DATE_MINSHOUR 60L
222 #define DATE_HOURSDAY 24L
223 #define DATE_SECSDAY (DATE_SECSMIN * DATE_MINSHOUR * DATE_HOURSDAY)
225 /* *indentprefix* default as of POSIX */
226 #define INDENT_DEFAULT "\t"
228 /* Default *encoding* as enum mime_enc below */
229 #define MIME_DEFAULT_ENCODING MIMEE_QP
231 /* Maximum allowed line length in a mail before QP folding is necessary), and
232 * the real limit we go for */
233 #define MIME_LINELEN_MAX 998 /* Plus CRLF */
234 #define MIME_LINELEN_LIMIT (MIME_LINELEN_MAX - 48)
237 #define MIME_LINELEN 78 /* Plus CRLF */
239 /* And in headers which contain an encoded word according to RFC 2047 there is
240 * yet another limit; also RFC 2045: 6.7, (5). */
241 #define MIME_LINELEN_RFC2047 76
243 /* Locations of mime.types(5) */
244 #define MIME_TYPES_USR "~/.mime.types"
245 #define MIME_TYPES_SYS "/etc/mime.types"
247 /* Fallback MIME charsets, if *charset-7bit* and *charset-8bit* or not set.
248 * (Keep in SYNC: ./nail.1:"Character sets", ./nail.h:CHARSET_*!) */
249 #define CHARSET_7BIT "US-ASCII"
251 # define CHARSET_8BIT "UTF-8"
252 # define CHARSET_8BIT_OKEY charset_8bit
254 # define CHARSET_8BIT "ISO-8859-1"
255 # define CHARSET_8BIT_OKEY ttycharset
258 /* Some environment variables for pipe hooks etc. */
259 #define NAILENV_TMPDIR "NAIL_TMPDIR"
260 #define NAILENV_FILENAME "NAIL_FILENAME"
261 #define NAILENV_FILENAME_GENERATED "NAIL_FILENAME_GENERATED"
262 #define NAILENV_FILENAME_TEMPORARY "NAIL_FILENAME_TEMPORARY"
263 #define NAILENV_CONTENT "NAIL_CONTENT"
264 #define NAILENV_CONTENT_EVIDENCE "NAIL_CONTENT_EVIDENCE"
266 /* Is *W* a quoting (ASCII only) character? */
268 ((W) == L'>' || (W) == L'|' || (W) == L'}' || (W) == L':')
270 /* Maximum number of quote characters (not bytes!) that'll be used on
271 * follow lines when compressing leading quote characters */
274 /* How much spaces should a <tab> count when *quote-fold*ing? (power-of-two!) */
275 #define QUOTE_TAB_SPACES 8
277 /* Maximum size of a message that is passed through to the spam system */
278 #define SPAM_MAXSIZE 420000
280 /* String dope: dynamic buffer size, and size of the single builtin one that's
281 * used first; note that these value include the size of the structure */
282 #define SBUFFER_SIZE ((0x10000u >> 1u) - 0x400)
283 #define SBUFFER_BUILTIN (0x10000u >> 1u)
285 /* These come from the configuration (named Xxy to not clash with sh(1)..) */
287 # define XSHELL "/bin/sh"
290 # define XLISTER "ls"
293 # define XPAGER "more"
297 * OS, CC support, generic macros etc.
300 /* OS: we're not a library, only set what needs special treatment somewhere */
301 #define OS_DRAGONFLY 0
307 # define OS_DRAGONFLY 1
308 #elif defined __solaris__ || defined __sun
309 # if defined __SVR4 || defined __svr4__
311 # define OS_SOLARIS 1
320 #define PREREQ_CLANG(X,Y) 0
322 #define PREREQ_GCC(X,Y) 0
324 #define PREREQ_TCC(X,Y) 0
330 # define PREREQ_CLANG(X,Y) \
331 (__clang_major__ + 0 > (X) || \
332 (__clang_major__ + 0 == (X) && __clang_minor__ + 0 >= (Y)))
333 # define __EXTEN __extension__
335 #elif defined __GNUC__
339 # define PREREQ_GCC(X,Y) \
340 (__GNUC__ + 0 > (X) || (__GNUC__ + 0 == (X) && __GNUC_MINOR__ + 0 >= (Y)))
341 # define __EXTEN __extension__
343 #elif defined __TINYC__
352 /* Suppress some technical warnings via #pragma's unless developing.
353 * XXX Wild guesses: clang(1) 1.7 and (OpenBSD) gcc(1) 4.2.1 don't work */
355 # if PREREQ_CLANG(3, 4)
356 # pragma clang diagnostic ignored "-Wunused-result"
357 # pragma clang diagnostic ignored "-Wformat"
358 # elif PREREQ_GCC(4, 7)
359 # pragma GCC diagnostic ignored "-Wunused-local-typedefs"
360 # pragma GCC diagnostic ignored "-Wunused-result"
361 # pragma GCC diagnostic ignored "-Wformat"
365 /* For injection macros like DBG(), NATCH_CHAR() */
368 #define EMPTY_FILE() typedef int CONCAT(avoid_empty_file__, n_FILE);
370 /* Pointer to size_t */
371 #define PTR2SIZE(X) ((size_t)(uintptr_t)(X))
373 /* Pointer comparison (types from below) */
374 #define PTRCMP(A,C,B) ((uintptr_t)(A) C (uintptr_t)(B))
376 /* Ditto, compare (maybe mixed-signed) integers cases to T bits, unsigned;
377 * Note: doesn't sign-extend correctly, that's still up to the caller */
378 #define UICMP(T,A,C,B) ((ui ## T ## _t)(A) C (ui ## T ## _t)(B))
380 /* Align something to a size/boundary that cannot cause just any problem */
381 #define n_ALIGN(X) (((X) + 2*sizeof(void*)) & ~((2*sizeof(void*)) - 1))
383 /* Members in constant array */
385 # define NELEM(A) (sizeof(A) / sizeof(A[0]))
388 /* sizeof() for member fields */
389 #define SIZEOF_FIELD(T,F) sizeof(((T *)NULL)->F)
391 /* Casts-away (*NOT* cast-away) */
392 #define UNUSED(X) ((void)(X))
393 #define UNCONST(P) ((void*)(uintptr_t)(void const*)(P))
394 #define UNVOLATILE(P) ((void*)(uintptr_t)(void volatile*)(P))
395 #define UNXXX(T,C,P) ((T)(uintptr_t)(C)(P))
397 /* __STDC_VERSION__ is ISO C99, so also use __STDC__, which should work */
398 #if defined __STDC__ || defined __STDC_VERSION__ /*|| defined __cplusplus*/
399 # define STRING(X) #X
400 # define XSTRING(X) STRING(X)
401 # define CONCAT(S1,S2) _CONCAT(S1, S2)
402 # define _CONCAT(S1,S2) S1 ## S2
404 # define STRING(X) "X"
405 # define XSTRING STRING
406 # define CONCAT(S1,S2) S1/**/S2
409 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
410 # define n_FIELD_INITN(N) CONCAT(., N) =
411 # define n_FIELD_INITI(I) [I] =
413 # define n_FIELD_INITN(N)
414 # define n_FIELD_INITI(N)
417 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
418 # define VFIELD_SIZE(X)
419 # define VFIELD_SIZEOF(T,F) (0)
421 # define VFIELD_SIZE(X) \
422 ((X) == 0 ? sizeof(size_t) \
423 : ((ssize_t)(X) < 0 ? sizeof(size_t) - ABS(X) : (size_t)(X)))
424 # define VFIELD_SIZEOF(T,F) SIZEOF_FIELD(T, F)
427 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
429 # define INLINE inline
430 # define SINLINE static inline
431 #elif CC_CLANG || PREREQ_GCC(2, 9)
433 # define INLINE static __inline
434 # define SINLINE static __inline
437 # define SINLINE static
441 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
442 # define __FUN__ __func__
443 #elif CC_CLANG || PREREQ_GCC(3, 4)
444 # define __FUN__ __extension__ __FUNCTION__
446 # define __FUN__ uagent /* Something that is not a literal */
449 #if defined __predict_true && defined __predict_false
450 # define LIKELY(X) __predict_true(X)
451 # define UNLIKELY(X) __predict_false(X)
452 #elif CC_CLANG || PREREQ_GCC(2, 96)
453 # define LIKELY(X) __builtin_expect(X, 1)
454 # define UNLIKELY(X) __builtin_expect(X, 0)
456 # define LIKELY(X) (X)
457 # define UNLIKELY(X) (X)
460 #undef HAVE_NATCH_CHAR
462 #if defined HAVE_SETLOCALE && defined HAVE_C90AMEND1 && defined HAVE_WCWIDTH
463 # define HAVE_NATCH_CHAR
464 # define NATCH_CHAR(X) X
466 # define NATCH_CHAR(X)
469 /* Compile-Time-Assert
470 * Problem is that some compilers warn on unused local typedefs, so add
471 * a special local CTA to overcome this */
472 #define CTA(TEST) _CTA_1(TEST, n_FILE, __LINE__)
473 #define LCTA(TEST) _LCTA_1(TEST, n_FILE, __LINE__)
475 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 201112L
476 # define n_CTA(T,M) _Static_assert(T, M)
477 # define n_LCTA(T,M) _Static_assert(T, M)
479 # define n_CTA(T,M) _CTA_1(T, n_FILE, __LINE__)
480 # define n_LCTA(T,M) _LCTA_1(T, n_FILE, __LINE__)
484 # define n_MCTA(T,M) n_CTA(T, M);
489 #define _CTA_1(T,F,L) _CTA_2(T, F, L)
490 #define _CTA_2(T,F,L) \
491 typedef char ASSERTION_failed_in_file_## F ## _at_line_ ## L[(T) ? 1 : -1]
492 #define _LCTA_1(T,F,L) _LCTA_2(T, F, L)
493 #define _LCTA_2(T,F,L) \
495 typedef char ASSERTION_failed_in_file_## F ## _at_line_ ## L[(T) ? 1 : -1];\
496 ASSERTION_failed_in_file_## F ## _at_line_ ## L __i_am_unused__;\
497 UNUSED(__i_am_unused__);\
500 #define UNINIT(N,V) N = V
503 #define ISPOW2(X) ((((X) - 1) & (X)) == 0)
505 #define MIN(A, B) ((A) < (B) ? (A) : (B))
507 #define MAX(A, B) ((A) < (B) ? (B) : (A))
509 #define ABS(A) ((A) < 0 ? -(A) : (A))
515 # define assert(X) UNUSED(0)
518 # define DBGOR(X,Y) Y
522 # define DBGOR(X,Y) X
525 /* Translation (init in main.c) */
538 # define UI8_MAX UINT8_MAX
539 # define SI8_MIN INT8_MIN
540 # define SI8_MAX INT8_MAX
541 typedef uint8_t ui8_t
;
542 typedef int8_t si8_t
;
543 #elif UCHAR_MAX != 255
544 # error UCHAR_MAX must be 255
546 # define UI8_MAX UCHAR_MAX
547 # define SI8_MIN CHAR_MIN
548 # define SI8_MAX CHAR_MAX
549 typedef unsigned char ui8_t
;
550 typedef signed char si8_t
;
553 #if !defined PRIu8 || !defined PRId8
561 # define UI16_MAX UINT16_MAX
562 # define SI16_MIN INT16_MIN
563 # define SI16_MAX INT16_MAX
564 typedef uint16_t ui16_t
;
565 typedef int16_t si16_t
;
566 #elif USHRT_MAX != 0xFFFFu
567 # error USHRT_MAX must be 0xFFFF
569 # define UI16_MAX USHRT_MAX
570 # define SI16_MIN SHRT_MIN
571 # define SI16_MAX SHRT_MAX
572 typedef unsigned short ui16_t
;
573 typedef signed short si16_t
;
576 #if !defined PRIu16 || !defined PRId16
579 # if UI16_MAX == UINT_MAX
589 # define UI32_MAX UINT32_MAX
590 # define SI32_MIN INT32_MIN
591 # define SI32_MAX INT32_MAX
592 typedef uint32_t ui32_t
;
593 typedef int32_t si32_t
;
594 #elif ULONG_MAX == 0xFFFFFFFFu
595 # define UI32_MAX ULONG_MAX
596 # define SI32_MIN LONG_MIN
597 # define SI32_MAX LONG_MAX
598 typedef unsigned long int ui32_t
;
599 typedef signed long int si32_t
;
600 #elif UINT_MAX != 0xFFFFFFFFu
601 # error UINT_MAX must be 0xFFFFFFFF
603 # define UI32_MAX UINT_MAX
604 # define SI32_MIN INT_MIN
605 # define SI32_MAX INT_MAX
606 typedef unsigned int ui32_t
;
607 typedef signed int si32_t
;
610 #if !defined PRIu32 || !defined PRId32
613 # if UI32_MAX == ULONG_MAX
623 # define UI64_MAX UINT64_MAX
624 # define SI64_MIN INT64_MIN
625 # define SI64_MAX INT64_MAX
626 typedef uint64_t ui64_t
;
627 typedef int64_t si64_t
;
628 #elif ULONG_MAX <= 0xFFFFFFFFu
629 # if !defined ULLONG_MAX || (ULLONG_MAX >> 31) < 0xFFFFFFFFu
630 # error We need a 64 bit integer
632 # define UI64_MAX ULLONG_MAX
633 # define SI64_MIN LLONG_MIN
634 # define SI64_MAX LLONG_MAX
635 __EXTEN
typedef unsigned long long ui64_t
;
636 __EXTEN
typedef signed long long si64_t
;
639 # define UI64_MAX ULONG_MAX
640 # define SI64_MIN LONG_MIN
641 # define SI64_MAX LONG_MAX
642 typedef unsigned long ui64_t
;
643 typedef signed long si64_t
;
646 #if !defined PRIu64 || !defined PRId64 || !defined PRIX64
650 # if defined ULLONG_MAX && UI64_MAX == ULLONG_MAX
651 # define PRIu64 "llu"
652 # define PRId64 "lld"
653 # define PRIX64 "llX"
661 /* (So that we can use UICMP() for size_t comparison, too) */
662 typedef size_t uiz_t
;
663 typedef ssize_t siz_t
;
667 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
670 # define UIZ_MAX SIZE_MAX
671 #elif defined SIZE_MAX
672 /* UnixWare has size_t as unsigned as required but uses a signed limit
673 * constant (which is thus false!) */
674 # if SIZE_MAX == UI64_MAX || SIZE_MAX == SI64_MAX
675 # define PRIuZ PRIu64
676 # define PRIdZ PRId64
677 n_MCTA(sizeof(size_t) == sizeof(ui64_t
),
678 "Format string mismatch, compile with ISO C99 compiler (-std=c99)!")
679 # elif SIZE_MAX == UI32_MAX || SIZE_MAX == SI32_MAX
680 # define PRIuZ PRIu32
681 # define PRIdZ PRId32
682 n_MCTA(sizeof(size_t) == sizeof(ui32_t
),
683 "Format string mismatch, compile with ISO C99 compiler (-std=c99)!")
685 # error SIZE_MAX is neither UI64_MAX nor UI32_MAX (please report this)
687 # define UIZ_MAX SIZE_MAX
692 n_MCTA(sizeof(size_t) == sizeof(unsigned long),
693 "Format string mismatch, compile with ISO C99 compiler (-std=c99)!")
694 # define UIZ_MAX ULONG_MAX
699 # define uintptr_t size_t
700 # define UINTPTR_MAX SIZE_MAX
702 # define uintptr_t unsigned long
703 # define UINTPTR_MAX ULONG_MAX
707 #if !defined PRIuPTR || !defined PRIXPTR
710 # if UINTPTR_MAX == ULONG_MAX
711 # define PRIuPTR "lu"
712 # define PRIXPTR "lX"
719 enum {FAL0
, TRU1
, TRUM1
= -1};
720 typedef si8_t bool_t
;
722 /* Add shorter aliases for "normal" integers */
723 typedef unsigned long ul_i
;
724 typedef unsigned int ui_i
;
725 typedef unsigned short us_i
;
726 typedef unsigned char uc_i
;
728 typedef signed long sl_i
;
729 typedef signed int si_i
;
730 typedef signed short ss_i
;
731 typedef signed char sc_i
;
733 typedef void ( *sighandler_type
)(int);
736 AUTHTYPE_NONE
= 1<<0,
737 AUTHTYPE_PLAIN
= 1<<1, /* POP3: APOP is covered by this */
738 AUTHTYPE_LOGIN
= 1<<2,
739 AUTHTYPE_CRAM_MD5
= 1<<3,
740 AUTHTYPE_GSSAPI
= 1<<4
743 enum expand_addr_flags
{
744 EAF_NONE
= 0, /* -> EAF_NOFILE | EAF_NOPIPE */
745 EAF_RESTRICT
= 1<<0, /* "restrict" (do unless interaktive / -[~#]) */
746 EAF_FAIL
= 1<<1, /* "fail" */
747 /* Bits reused by enum expand_addr_check_mode! */
748 EAF_FILE
= 1<<3, /* +"file" targets */
749 EAF_PIPE
= 1<<4, /* +"pipe" command pipe targets */
750 EAF_NAME
= 1<<5, /* +"name"s (non-address) names / MTA aliases */
751 EAF_ADDR
= 1<<6, /* +"addr" network address (contain "@") */
753 EAF_TARGET_MASK
= EAF_FILE
| EAF_PIPE
| EAF_NAME
| EAF_ADDR
,
754 EAF_RESTRICT_TARGETS
= EAF_NAME
| EAF_ADDR
/* (default set if not set) */
757 enum expand_addr_check_mode
{
758 EACM_NONE
= 0, /* Don't care about *expandaddr* */
759 EACM_NORMAL
= 1<<0, /* Use our normal *expandaddr* checking */
760 EACM_STRICT
= 1<<1, /* Never allow any file or pipe addresse */
761 EACM_MODE_MASK
= 0x3, /* _NORMAL and _STRICT are mutual! */
763 EACM_NOLOG
= 1<<2, /* Don't log check errors */
765 /* Some special overwrites of EAF_TARGETs.
766 * May NOT clash with EAF_* bits which may be ORd to these here! */
772 /* We do have several groups of colour IDs; since only one of them can be
773 * active at any given time let's share the value range */
782 n_COLOUR_ID_SUM_DOTMARK
= 0,
783 n_COLOUR_ID_SUM_HEADER
,
784 n_COLOUR_ID_SUM_THREAD
,
786 /* Message display */
787 n_COLOUR_ID_VIEW_FROM_
= 0,
788 n_COLOUR_ID_VIEW_HEADER
,
789 n_COLOUR_ID_VIEW_MSGINFO
,
790 n_COLOUR_ID_VIEW_PARTINFO
,
792 n__COLOUR_IDS
= n_COLOUR_ID_VIEW_PARTINFO
+ 1
795 /* Colour preconditions, let's call them tags, cannot be an enum because for
796 * message display they are the actual header name of the current header. Thus
797 * let's use constants of pseudo pointers */
798 # define n_COLOUR_TAG_SUM_DOT ((char*)-2)
799 # define n_COLOUR_TAG_SUM_OLDER ((char*)-3)
800 #endif /* HAVE_COLOUR */
803 CONV_NONE
, /* no conversion */
804 CONV_7BIT
, /* no conversion, is 7bit */
805 CONV_FROMQP
, /* convert from quoted-printable */
806 CONV_TOQP
, /* convert to quoted-printable */
807 CONV_8BIT
, /* convert to 8bit (iconv) */
808 CONV_FROMB64
, /* convert from base64 */
809 CONV_FROMB64_T
, /* convert from base64/text */
810 CONV_TOB64
, /* convert to base64 */
811 CONV_FROMHDR
, /* convert from RFC1522 format */
812 CONV_TOHDR
, /* convert to RFC1522 format */
813 CONV_TOHDR_A
/* convert addresses for header */
823 DLS_CANT_CHDIR
, /* Failed to chdir(2) into desired path */
824 DLS_NAMETOOLONG
, /* Lock file name would be too long */
825 DLS_ROFS
, /* Read-only filesystem (no error, mailbox RO) */
826 DLS_NOPERM
, /* No permission to creat lock file */
827 DLS_NOEXEC
, /* Privilege separated dotlocker not found */
828 DLS_PRIVFAILED
, /* Rising privileges failed in dotlocker */
829 DLS_EXIST
, /* Lock file already exists, stale lock? */
830 DLS_FISHY
, /* Something makes us think bad of situation */
831 DLS_DUNNO
, /* Catch-all error */
832 DLS_PING
, /* Not an error, but have to wait for lock */
833 DLS_ABANDON
= 1<<7 /* ORd to any but _NONE: give up, don't retry */
837 EXIT_OK
= EXIT_SUCCESS
,
838 EXIT_ERR
= EXIT_FAILURE
,
839 EXIT_USE
= 64, /* sysexits.h:EX_USAGE */
840 EXIT_NOUSER
= 67, /* :EX_NOUSER */
841 EXIT_COLL_ABORT
= 1<<1, /* Message collection was aborted */
842 EXIT_SEND_ERROR
= 1<<2 /* Unspecified send error occurred */
847 FEDIT_SYSBOX
= 1<<0, /* %: prefix */
848 FEDIT_RDONLY
= 1<<1, /* Readonly (per-box, OPT_R_FLAG is global) */
849 FEDIT_NEWMAIL
= 1<<2 /* `newmail' operation TODO OBSOLETE THIS! */
853 FEXP_FULL
, /* Full expansion */
854 FEXP_LOCAL
= 1<<0, /* Result must be local file/maildir */
855 FEXP_SHELL
= 1<<1, /* No folder %,#,&,+ stuff, yet sh(1) */
856 FEXP_NSHORTCUT
= 1<<2, /* Don't expand shortcuts */
857 FEXP_SILENT
= 1<<3, /* Don't print but only return errors */
858 FEXP_MULTIOK
= 1<<4, /* Expansion to many entries is ok */
859 FEXP_NSHELL
= 1<<5 /* Don't do shell word exp. (but ~/, $VAR) */
862 enum file_lock_type
{
868 MIME_UNKNOWN
, /* unknown content */
869 MIME_SUBHDR
, /* inside a multipart subheader */
870 MIME_822
, /* message/rfc822 content */
871 MIME_MESSAGE
, /* other message/ content */
872 MIME_TEXT_PLAIN
, /* text/plain content */
873 MIME_TEXT_HTML
, /* text/html content */
874 MIME_TEXT
, /* other text/ content */
875 MIME_ALTERNATIVE
, /* multipart/alternative content */
876 MIME_RELATED
, /* mime/related (RFC 2387) */
877 MIME_DIGEST
, /* multipart/digest content */
878 MIME_MULTI
, /* other multipart/ content */
879 MIME_PKCS7
, /* PKCS7 content */
880 MIME_DISCARD
/* content is discarded */
883 enum mime_counter_evidence
{
885 MIMECE_SET
= 1<<0, /* *mime-counter-evidence* was set */
886 MIMECE_BIN_OVWR
= 1<<1, /* appli../octet-stream: check, ovw if possible */
887 MIMECE_ALL_OVWR
= 1<<2, /* all: check, ovw if possible */
888 MIMECE_BIN_PARSE
= 1<<3 /* appli../octet-stream: classify contents last */
891 /* Content-Transfer-Encodings as defined in RFC 2045:
892 * - Quoted-Printable, section 6.7
893 * - Base64, section 6.8 */
894 #define QP_LINESIZE (4 * 19) /* Max. compliant QP linesize */
896 #define B64_LINESIZE (4 * 19) /* Max. compliant Base64 linesize */
897 #define B64_ENCODE_INPUT_PER_LINE 57 /* Max. input for Base64 encode/line */
900 MIMEE_NONE
, /* message is not in MIME format */
901 MIMEE_BIN
, /* message is in binary encoding */
902 MIMEE_8B
, /* message is in 8bit encoding */
903 MIMEE_7B
, /* message is in 7bit encoding */
904 MIMEE_QP
, /* message is quoted-printable */
905 MIMEE_B64
/* message is in base64 encoding */
908 /* xxx QP came later, maybe rewrite all to use mime_enc_flags directly? */
909 enum mime_enc_flags
{
911 MIMEEF_SALLOC
= 1<<0, /* Use salloc(), not srealloc().. */
912 /* ..result .s,.l point to user buffer of *_LINESIZE+[+[+]] bytes instead */
914 MIMEEF_CRLF
= 1<<2, /* (encode) Append "\r\n" to lines */
915 MIMEEF_LF
= 1<<3, /* (encode) Append "\n" to lines */
916 /* (encode) If one of _CRLF/_LF is set, honour *_LINESIZE+[+[+]] and
917 * inject the desired line-ending whenever a linewrap is desired */
918 MIMEEF_MULTILINE
= 1<<4,
919 /* (encode) Quote with header rules, do not generate soft NL breaks?
920 * For mustquote(), specifies wether special RFC 2047 header rules
921 * should be used instead */
922 MIMEEF_ISHEAD
= 1<<5,
923 /* (encode) Ditto; for mustquote() this furtherly fine-tunes behaviour in
924 * that characters which would not be reported as "must-quote" when
925 * detecting wether quoting is necessary at all will be reported as
926 * "must-quote" if they have to be encoded in an encoded word */
927 MIMEEF_ISENCWORD
= 1<<6,
932 QP_NONE
= MIMEEF_NONE
,
933 QP_SALLOC
= MIMEEF_SALLOC
,
935 QP_ISHEAD
= MIMEEF_ISHEAD
,
936 QP_ISENCWORD
= MIMEEF_ISENCWORD
940 B64_NONE
= MIMEEF_NONE
,
941 B64_SALLOC
= MIMEEF_SALLOC
,
942 B64_BUF
= MIMEEF_BUF
,
943 B64_CRLF
= MIMEEF_CRLF
,
945 B64_MULTILINE
= MIMEEF_MULTILINE
,
946 /* Not used, but for clarity only */
947 B64_ISHEAD
= MIMEEF_ISHEAD
,
948 B64_ISENCWORD
= MIMEEF_ISENCWORD
,
949 /* Special version of Base64, "Base64URL", according to RFC 4648.
950 * Only supported for encoding! */
951 B64_RFC4648URL
= 1<<(__MIMEEF_LAST
+1),
952 /* Don't use any ("=") padding;
953 * may NOT be used with any of _CRLF, _LF or _MULTILINE */
954 B64_NOPAD
= 1<<(__MIMEEF_LAST
+2)
957 enum mime_parse_flags
{
959 MIME_PARSE_DECRYPT
= 1<<0,
960 MIME_PARSE_PARTS
= 1<<1
963 enum mime_handler_flags
{
964 MIME_HDL_NULL
, /* No pipe- mimetype handler, go away */
965 MIME_HDL_CMD
, /* Normal command */
966 MIME_HDL_TEXT
, /* @ special cmd to force treatment as text */
967 MIME_HDL_PTF
, /* A special pointer-to-function handler */
968 MIME_HDL_MSG
, /* Display msg (returned as command string) */
969 MIME_HDL_TYPE_MASK
= 7,
970 MIME_HDL_ISQUOTE
= 1<<4, /* Is quote action (we have info, keep it!) */
971 MIME_HDL_NOQUOTE
= 1<<5, /* No MIME for quoting */
972 MIME_HDL_ALWAYS
= 1<<6, /* Handler shall run for multi-msg actions */
973 MIME_HDL_ASYNC
= 1<<7, /* Should run asynchronously */
974 MIME_HDL_NEEDSTERM
= 1<<8, /* Takes over terminal */
975 MIME_HDL_TMPF
= 1<<9, /* Create temporary file (zero-sized) */
976 MIME_HDL_TMPF_FILL
= 1<<10, /* Fill in the msg body content */
977 MIME_HDL_TMPF_UNLINK
= 1<<11 /* Delete it later again */
981 MLIST_OTHER
= 0, /* Normal address */
982 MLIST_KNOWN
= 1, /* A known `mlist' */
983 MLIST_SUBSCRIBED
= -1 /* A `mlsubscribe'd list */
994 OF_CLOEXEC
= 1<<7, /* TODO not used, always implied! CHANGE!! */
995 OF_UNLINK
= 1<<8, /* Only for Ftmp(): unlink(2) after creation */
996 OF_HOLDSIGS
= 1<<9, /* Mutual with OF_UNLINK - await Ftmp_free() */
997 OF_REGISTER
= 1<<10, /* Register file in our file table */
998 OF_REGISTER_UNLINK
= 1<<11, /* unlink(2) upon unreg.; _REGISTER asserted! */
999 OF_SUFFIX
= 1<<12 /* Ftmp() name hint is mandatory! extension! */
1007 enum okey_xlook_mode
{
1008 OXM_PLAIN
= 1<<0, /* Plain key always tested */
1009 OXM_H_P
= 1<<1, /* Check PLAIN-.url_h_p */
1010 OXM_U_H_P
= 1<<2, /* Check PLAIN-.url_u_h_p */
1014 /* <0 means "stop" unless *prompt* extensions are enabled. */
1016 PROMPT_STOP
= -1, /* \c */
1017 /* *prompt* extensions: \$, \@ etc. */
1023 PROTO_FILE
, /* refers to a local file */
1024 PROTO_POP3
, /* is a pop3 server string */
1025 PROTO_MAILDIR
, /* refers to a maildir folder */
1026 PROTO_UNKNOWN
/* unknown protocol */
1030 SEND_MBOX
, /* no conversion to perform */
1031 SEND_RFC822
, /* no conversion, no From_ line */
1032 SEND_TODISP
, /* convert to displayable form */
1033 SEND_TODISP_ALL
, /* same, include all MIME parts */
1034 SEND_SHOW
, /* convert to 'show' command form */
1035 SEND_TOSRCH
, /* convert for IMAP SEARCH */
1036 SEND_TOFILE
, /* convert for saving body to a file */
1037 SEND_TOPIPE
, /* convert for pipe-content/subc. */
1038 SEND_QUOTE
, /* convert for quoting */
1039 SEND_QUOTE_ALL
, /* same, include all MIME parts */
1040 SEND_DECRYPT
/* decrypt */
1044 enum ssl_verify_level
{
1053 TD_NONE
, /* no display conversion */
1054 TD_ISPR
= 1<<0, /* use isprint() checks */
1055 TD_ICONV
= 1<<1, /* use iconv() */
1056 TD_DELCTRL
= 1<<2, /* delete control characters */
1059 * NOTE: _TD_EOF and _TD_BUFCOPY may be ORd with enum conversion and
1060 * enum sendaction, and may thus NOT clash with their bit range!
1062 _TD_EOF
= 1<<14, /* EOF seen, last round! */
1063 _TD_BUFCOPY
= 1<<15 /* Buffer may be constant, copy it */
1068 OPT_DEBUG
= 1u<< 0, /* -d / *debug* */
1069 OPT_VERB
= 1u<< 1, /* -v / *verbose* */
1070 OPT_VERBVERB
= 1u<< 2, /* .. even more verbosity */
1071 OPT_EXISTONLY
= 1u<< 3, /* -e */
1072 OPT_HEADERSONLY
= 1u<<4, /* -H */
1073 OPT_HEADERLIST
= 1u<< 5, /* -L */
1074 OPT_QUICKRUN_MASK
= OPT_EXISTONLY
| OPT_HEADERSONLY
| OPT_HEADERLIST
,
1075 OPT_NOSRC
= 1u<< 6, /* -n */
1076 OPT_E_FLAG
= 1u<< 7, /* -E / *skipemptybody* */
1077 OPT_F_FLAG
= 1u<< 8, /* -F */
1078 OPT_N_FLAG
= 1u<< 9, /* -N / *header* */
1079 OPT_R_FLAG
= 1u<<10, /* -R */
1080 OPT_r_FLAG
= 1u<<11, /* -r (plus option_r_arg) */
1081 OPT_t_FLAG
= 1u<<12, /* -t */
1082 OPT_u_FLAG
= 1u<<13, /* -u / $USER and pw->pw_uid != getuid(2) */
1083 OPT_TILDE_FLAG
= 1u<<14, /* -~ */
1084 OPT_BATCH_FLAG
= 1u<<15, /* -# */
1087 OPT_MEMDEBUG
= 1<<16, /* *memdebug* */
1090 OPT_SENDMODE
= 1u<<17, /* Usage case forces send mode */
1092 OPT_TTYOUT
= 1u<<19,
1093 OPT_INTERACTIVE
= 1u<<20,
1094 OPT_UNICODE
= 1u<<21, /* We're in an UTF-8 environment */
1095 OPT_ENC_MBSTATE
= 1u<<22, /* Multibyte environment with shift states */
1097 /* Some easy-access shortcuts */
1098 OPT_D_V
= OPT_DEBUG
| OPT_VERB
,
1099 OPT_D_VV
= OPT_DEBUG
| OPT_VERBVERB
,
1100 OPT_D_V_VV
= OPT_DEBUG
| OPT_VERB
| OPT_VERBVERB
1103 #define OBSOLETE(X) \
1105 if (options & OPT_D_V_VV)\
1106 n_err("%s: %s\n", _("Obsoletion warning"), X);\
1108 #define OBSOLETE2(X,Y) \
1110 if (options & OPT_D_V_VV)\
1111 n_err("%s: %s: %s\n", _("Obsoletion warning"), X, Y);\
1114 enum program_state
{
1115 PS_STARTED
= 1<< 0, /* main.c startup code passed, functional */
1117 PS_LOADING
= 1<< 1, /* Loading user resource files, startup */
1118 PS_SOURCING
= 1<< 2, /* Sourcing a resource file */
1119 PS_IN_LOAD
= PS_LOADING
| PS_SOURCING
,
1121 PS_EVAL_ERROR
= 1<< 4, /* Last evaluate() command failed */
1123 PS_HOOK_NEWMAIL
= 1<< 6,
1125 PS_HOOK_MASK
= PS_HOOK_NEWMAIL
| PS_HOOK
,
1127 PS_EDIT
= 1<< 8, /* Current mailbox not a "system mailbox" */
1128 PS_SETFILE_OPENED
= 1<< 9, /* (hack) setfile() opened a new box */
1129 PS_SAW_COMMAND
= 1<<10, /* ..after mailbox switch */
1131 PS_DID_PRINT_DOT
= 1<<16, /* Current message has been printed */
1133 PS_MSGLIST_SAW_NO
= 1<<17, /* Last *LIST saw numerics */
1134 PS_MSGLIST_DIRECT
= 1<<18, /* One msg was directly chosen by number */
1135 PS_MSGLIST_MASK
= PS_MSGLIST_SAW_NO
| PS_MSGLIST_DIRECT
,
1137 PS_HEADER_NEEDED_MIME
= 1<<20, /* mime_write_tohdr() needed x TODO HACK! */
1139 PS_COLOUR_ACTIVE
= 1<<22, /* n_colour_env_create().._gut() cycle */
1141 /* Various first-time-init switches */
1142 PS_ERRORS_NOTED
= 1<<24, /* Ring of `errors' content, print msg */
1143 PS_ATTACHMENTS_NOTED
= 1<<25, /* Attachment filename quoting noted */
1144 PS_t_FLAG
= 1<<26 /* OPT_t_FLAG made persistant */
1147 /* A large enum with all the boolean and value options a.k.a their keys.
1148 * Only the constant keys are in here, to be looked up via ok_[bv]look(),
1149 * ok_[bv]set() and ok_[bv]clear().
1150 * Note: see the comments in accmacvar.c before changing *anything* in here! */
1152 ok_b_add_file_recipients
,
1153 ok_v_agent_shell_lookup
,
1163 ok_b_attachment_ask_content_description
,
1164 ok_b_attachment_ask_content_disposition
,
1165 ok_b_attachment_ask_content_id
,
1166 ok_b_attachment_ask_content_type
,
1176 ok_b_batch_exit_on_error
,
1187 ok_v_charset_unknown_8bit
,
1189 ok_b_colour_disable
,
1196 ok_v_datefield_markout_older
,
1197 ok_b_debug
, /* {special=1} */
1198 ok_b_disposition_notification_send
,
1200 ok_b_dotlock_ignore_error
,
1212 ok_v_features
, /* {rdonly=1,virtual=_features} */
1214 ok_v_folder
, /* {special=1} */
1217 ok_v_followup_to_honour
,
1218 ok_b_forward_as_attachment
,
1223 ok_b_header
, /* {special=1} */
1228 ok_b_history_gabby_persist
,
1239 ok_b_keep_content_length
,
1243 ok_v_line_editor_cursor_right
, /* {special=1} */
1244 ok_b_line_editor_disable
,
1250 ok_b_memdebug
, /* {special=1} */
1251 ok_b_message_id_disable
,
1252 ok_v_message_inject_head
,
1253 ok_v_message_inject_tail
,
1255 ok_b_mime_allow_text_controls
,
1256 ok_b_mime_alternative_favour_rich
,
1257 ok_v_mime_counter_evidence
,
1258 ok_v_mimetypes_load_control
,
1260 ok_v_NAIL_EXTRA_RC
, /* {name=NAIL_EXTRA_RC} */
1261 ok_v_NAIL_HEAD
, /* {name=NAIL_HEAD} */
1262 ok_v_NAIL_HISTFILE
, /* {name=NAIL_HISTFILE} */
1263 ok_v_NAIL_HISTSIZE
, /* {name=NAIL_HISTSIZE} */
1264 ok_v_NAIL_TAIL
, /* {name=NAIL_TAIL} */
1277 ok_b_pop3_bulk_load
,
1278 ok_v_pop3_keepalive
,
1280 ok_b_pop3_use_starttls
,
1281 ok_b_print_all_chars
,
1282 ok_b_print_alternatives
,
1287 ok_b_quote_as_attachment
,
1290 ok_b_recipients_in_cc
,
1293 ok_b_reply_in_same_charset
,
1296 ok_v_reply_to_honour
,
1297 ok_b_rfc822_body_from_
, /* {name=rfc822-body-from_} */
1304 ok_b_sendcharsets_else_ttycharset
,
1307 ok_v_sendmail_arguments
,
1308 ok_b_sendmail_no_default_arguments
,
1309 ok_v_sendmail_progname
,
1317 ok_b_skipemptybody
, /* {special=1} */
1322 ok_v_smime_crl_file
,
1323 /* smime-encrypt-USER@HOST */
1324 ok_b_smime_force_encryption
,
1325 ok_b_smime_no_default_ca
,
1327 ok_v_smime_sign_cert
,
1328 ok_v_smime_sign_include_certs
,
1329 ok_v_smime_sign_message_digest
,
1332 ok_v_smtp_auth_password
,
1333 ok_v_smtp_auth_user
,
1335 ok_b_smtp_use_starttls
,
1336 ok_v_spam_interface
,
1339 ok_v_spamc_arguments
,
1343 ok_v_spamfilter_ham
,
1344 ok_v_spamfilter_noham
,
1345 ok_v_spamfilter_nospam
,
1346 ok_v_spamfilter_rate
,
1347 ok_v_spamfilter_rate_scanscore
,
1348 ok_v_spamfilter_spam
,
1352 ok_v_ssl_cipher_list
,
1353 ok_v_ssl_config_file
,
1358 ok_b_ssl_no_default_ca
,
1373 ok_b_verbose
, /* {special=1} */
1374 ok_v_version
, /* {rdonly=1,virtual=VERSION} */
1375 ok_v_version_major
, /* {rdonly=1,virtual=VERSION_MAJOR} */
1376 ok_v_version_minor
, /* {rdonly=1,virtual=VERSION_MINOR} */
1377 ok_v_version_update
, /* {rdonly=1,virtual=VERSION_UPDATE} */
1379 ok_b_writebackedited
1382 /* Locale-independent character classes */
1396 char *s
; /* the string's content */
1397 size_t l
; /* the stings's length */
1401 struct str bi_start
; /* Start of (possibly) bidirectional text */
1402 struct str bi_end
; /* End of ... */
1403 size_t bi_pad
; /* No of visual columns to reserve for BIDI pad */
1407 struct n_colour_pen
;
1411 char const *url_input
; /* Input as given (really) */
1412 enum cproto url_cproto
; /* Communication protocol as given */
1413 bool_t url_needs_tls
; /* Wether the protocol uses SSL/TLS */
1414 bool_t url_had_user
; /* Wether .url_user was part of the URL */
1415 ui16_t url_portno
; /* atoi .url_port or default, host endian */
1416 char const *url_port
; /* Port (if given) or NULL */
1417 char url_proto
[14]; /* Communication protocol as 'xy\0//' */
1418 ui8_t url_proto_len
; /* Length of .url_proto ('\0' index) */
1419 ui8_t url_proto_xlen
; /* .. if '\0' is replaced with ':' */
1420 struct str url_user
; /* User, exactly as given / looked up */
1421 struct str url_user_enc
; /* User, urlxenc()oded */
1422 struct str url_pass
; /* Pass (urlxdec()oded) or NULL */
1423 struct str url_host
; /* Service hostname */
1424 struct str url_path
; /* Path suffix or NULL */
1425 /* TODO: url_get_component(url *, enum COMPONENT, str *store) */
1426 struct str url_h_p
; /* .url_host[:.url_port] */
1427 /* .url_user@.url_host
1428 * Note: for CPROTO_SMTP this may resolve HOST via *smtp-hostname* (->
1429 * *hostname*)! (And may later be overwritten according to *from*!) */
1431 struct str url_u_h_p
; /* .url_user@.url_host[:.url_port] */
1432 struct str url_eu_h_p
; /* .url_user_enc@.url_host[:.url_port] */
1433 char const *url_p_u_h_p
; /* .url_proto://.url_u_h_p */
1434 char const *url_p_eu_h_p
; /* .url_proto://.url_eu_h_p */
1435 char const *url_p_eu_h_p_p
; /* .url_proto://.url_eu_h_p[/.url_path] */
1439 enum cproto cc_cproto
; /* Communication protocol */
1440 enum authtype cc_authtype
; /* Desired authentication */
1441 char const *cc_auth
; /* Authentication type as string */
1442 struct str cc_user
; /* User (urlxdec()oded) or NULL */
1443 struct str cc_pass
; /* Password (urlxdec()oded) or NULL */
1447 struct dotlock_info
{
1448 char const *di_file_name
; /* Mailbox to lock */
1449 char const *di_lock_name
; /* .di_file_name + .lock */
1450 char const *di_hostname
; /* ..filled in parent (due resolver delays) */
1451 char const *di_randstr
; /* ..ditto, random string */
1452 size_t di_pollmsecs
; /* Delay in between locking attempts */
1453 struct stat
*di_stb
;
1457 struct mime_handler
{
1458 enum mime_handler_flags mh_flags
;
1459 struct str mh_msg
; /* Message describing this command */
1460 /* XXX union{} the following? */
1461 char const *mh_shell_cmd
; /* For MIME_HDL_CMD */
1462 int (*mh_ptf
)(void); /* PTF main() for MIME_HDL_PTF */
1465 struct time_current
{
1473 FILE *qf_os
; /* Output stream */
1474 char const *qf_pfix
;
1475 ui32_t qf_pfix_len
; /* Length of prefix: 0: bypass */
1476 ui32_t qf_qfold_min
; /* Simple way: wrote prefix? */
1477 #ifdef HAVE_QUOTE_FOLD
1478 ui32_t qf_qfold_max
; /* Otherwise: line lengths */
1479 ui8_t qf_state
; /* *quote-fold* state machine */
1480 bool_t qf_brk_isws
; /* Breakpoint is at WS */
1482 ui32_t qf_wscnt
; /* Whitespace count */
1483 ui32_t qf_brkl
; /* Breakpoint */
1484 ui32_t qf_brkw
; /* Visual width, breakpoint */
1485 ui32_t qf_datw
; /* Current visual output line width */
1486 struct str qf_dat
; /* Current visual output line */
1487 struct str qf_currq
; /* Current quote, compressed */
1488 mbstate_t qf_mbps
[2];
1492 #ifdef HAVE_FILTER_HTML_TAGSOUP
1494 FILE *hf_os
; /* Output stream */
1496 ui32_t hf_lmax
; /* Maximum byte +1 in .hf_line/4 */
1497 ui32_t hf_len
; /* Current bytes in .hf_line */
1498 ui32_t hf_last_ws
; /* Last whitespace on line (fold purposes) */
1499 ui32_t hf_mboff
; /* Last offset for "mbtowc" */
1500 ui32_t hf_mbwidth
; /* We count characters not bytes if possible */
1501 char *hf_line
; /* Output line buffer - MUST be last field! */
1502 si32_t hf_href_dist
; /* Count of lines since last HREF flush */
1503 ui32_t hf_href_no
; /* HREF sequence number */
1504 struct htmlflt_href
*hf_hrefs
;
1505 struct htmlflt_tag
const *hf_ign_tag
; /* Tag that will end ignore mode */
1506 char *hf_curr
; /* Current cursor into .hf_bdat */
1507 char *hf_bmax
; /* Maximum byte in .hf_bdat +1 */
1508 char *hf_bdat
; /* (Temporary) Tag content data storage */
1512 struct search_expr
{
1513 char const *ss_where
; /* ..to search for the expr. (not always used) */
1514 char const *ss_sexpr
; /* String search expr.; NULL: use .ss_regex */
1521 struct str ev_line
; /* The terminated data to evaluate */
1522 ui32_t ev_line_size
; /* May be used to store line memory size */
1523 bool_t ev_is_recursive
; /* Evaluation in evaluation? (collect ~:) */
1525 bool_t ev_add_history
; /* Enter (final) command in history? */
1526 char const *ev_new_content
; /* History: reenter line, start with this */
1529 struct termios_state
{
1530 struct termios ts_tios
;
1533 bool_t ts_needs_reset
;
1536 #define termios_state_reset() \
1538 if (termios_state.ts_needs_reset) {\
1539 tcsetattr(0, TCSADRAIN, &termios_state.ts_tios);\
1540 termios_state.ts_needs_reset = FAL0;\
1544 struct sock
{ /* data associated with a socket */
1545 int s_fd
; /* file descriptor */
1547 int s_use_ssl
; /* SSL is used */
1548 # ifdef HAVE_OPENSSL
1549 void *s_ssl
; /* SSL object */
1552 char *s_wbuf
; /* for buffered writes */
1553 int s_wbufsize
; /* allocated size of s_buf */
1554 int s_wbufpos
; /* position of first empty data byte */
1555 char *s_rbufptr
; /* read pointer to s_rbuf */
1556 int s_rsz
; /* size of last read in s_rbuf */
1557 char const *s_desc
; /* description of error messages */
1558 void (*s_onclose
)(void); /* execute on close */
1559 char s_rbuf
[LINESIZE
+ 1]; /* for buffered reads */
1564 struct ccred sc_cred
;
1565 struct sock sc_sock
;
1570 MB_NONE
= 000, /* no reply expected */
1571 MB_COMD
= 001, /* command reply expected */
1572 MB_MULT
= 002, /* multiline reply expected */
1573 MB_PREAUTH
= 004, /* not in authenticated state */
1574 MB_BYE
= 010 /* may accept a BYE state */
1576 FILE *mb_itf
; /* temp file with messages, read open */
1577 FILE *mb_otf
; /* same, write open */
1578 char *mb_sorted
; /* sort method */
1580 MB_VOID
, /* no type (e. g. connection failed) */
1581 MB_FILE
, /* local file */
1582 MB_POP3
, /* POP3 mailbox */
1583 MB_MAILDIR
/* maildir folder */
1584 } mb_type
; /* type of mailbox */
1586 MB_DELE
= 01, /* may delete messages in mailbox */
1587 MB_EDIT
= 02 /* may edit messages in mailbox */
1589 int mb_threaded
; /* mailbox has been threaded */
1590 struct sock mb_sock
; /* socket structure */
1594 NEED_UNSPEC
, /* unspecified need, don't fetch */
1595 NEED_HEADER
, /* need the header of a message */
1596 NEED_BODY
/* need header and body of a message */
1600 HAVE_NOTHING
, /* nothing downloaded yet */
1601 HAVE_HEADER
= 01, /* header is downloaded */
1602 HAVE_BODY
= 02 /* entire message is downloaded */
1605 /* flag bits. Attention: Flags that are used in cache.c may not change */
1607 MUSED
= (1<< 0), /* entry is used, but this bit isn't */
1608 MDELETED
= (1<< 1), /* entry has been deleted */
1609 MSAVED
= (1<< 2), /* entry has been saved */
1610 MTOUCH
= (1<< 3), /* entry has been noticed */
1611 MPRESERVE
= (1<< 4), /* keep entry in sys mailbox */
1612 MMARK
= (1<< 5), /* message is marked! */
1613 MODIFY
= (1<< 6), /* message has been modified */
1614 MNEW
= (1<< 7), /* message has never been seen */
1615 MREAD
= (1<< 8), /* message has been read sometime. */
1616 MSTATUS
= (1<< 9), /* message status has changed */
1617 MBOX
= (1<<10), /* Send this to mbox, regardless */
1618 MNOFROM
= (1<<11), /* no From line */
1619 MHIDDEN
= (1<<12), /* message is hidden to user */
1620 MBOXED
= (1<<13), /* message has been sent to mbox */
1621 MNEWEST
= (1<<14), /* message is very new (newmail) */
1622 MFLAG
= (1<<15), /* message has been flagged recently */
1623 MUNFLAG
= (1<<16), /* message has been unflagged */
1624 MFLAGGED
= (1<<17), /* message is `flagged' */
1625 MANSWER
= (1<<18), /* message has been answered recently */
1626 MUNANSWER
= (1<<19), /* message has been unanswered */
1627 MANSWERED
= (1<<20), /* message is `answered' */
1628 MDRAFT
= (1<<21), /* message has been drafted recently */
1629 MUNDRAFT
= (1<<22), /* message has been undrafted */
1630 MDRAFTED
= (1<<23), /* message is marked as `draft' */
1631 MOLDMARK
= (1<<24), /* messages was marked previously */
1632 MSPAM
= (1<<25), /* message is classified as spam */
1633 MSPAMUNSURE
= (1<<26) /* message may be spam, but it is unsure */
1635 #define MMNORM (MDELETED | MSAVED | MHIDDEN)
1636 #define MMNDEL (MDELETED | MHIDDEN)
1638 #define visible(mp) (((mp)->m_flag & MMNDEL) == 0)
1641 enum mflag m_flag
; /* flags */
1642 enum havespec m_have
; /* downloaded parts of the part */
1644 ui32_t m_spamscore
; /* Spam score as int, 24:8 bits */
1646 int m_block
; /* block number of this part */
1647 size_t m_offset
; /* offset in block of part */
1648 size_t m_size
; /* Bytes in the part */
1649 size_t m_xsize
; /* Bytes in the full part */
1650 long m_lines
; /* Lines in the message */
1651 long m_xlines
; /* Lines in the full message */
1652 time_t m_time
; /* time the message was sent */
1653 char const *m_from
; /* message sender */
1654 struct mimepart
*m_nextpart
; /* next part at same level */
1655 struct mimepart
*m_multipart
; /* parts of multipart */
1656 struct mimepart
*m_parent
; /* enclosing multipart part */
1657 char const *m_ct_type
; /* content-type */
1658 char const *m_ct_type_plain
; /* content-type without specs */
1659 char const *m_ct_type_usr_ovwr
; /* Forcefully overwritten one */
1660 enum mimecontent m_mimecontent
; /* same in enum */
1661 char const *m_charset
; /* charset */
1662 char const *m_ct_enc
; /* content-transfer-encoding */
1663 enum mime_enc m_mime_enc
; /* same in enum */
1664 char *m_partstring
; /* part level string */
1665 char *m_filename
; /* attachment filename */
1669 enum mflag m_flag
; /* flags */
1670 enum havespec m_have
; /* downloaded parts of the message */
1672 ui32_t m_spamscore
; /* Spam score as int, 24:8 bits */
1674 int m_block
; /* block number of this message */
1675 size_t m_offset
; /* offset in block of message */
1676 size_t m_size
; /* Bytes in the message */
1677 size_t m_xsize
; /* Bytes in the full message */
1678 long m_lines
; /* Lines in the message */
1679 long m_xlines
; /* Lines in the full message */
1680 time_t m_time
; /* time the message was sent */
1681 time_t m_date
; /* time in the 'Date' field */
1682 unsigned m_idhash
; /* hash on Message-ID for threads */
1683 struct message
*m_child
; /* first child of this message */
1684 struct message
*m_younger
; /* younger brother of this message */
1685 struct message
*m_elder
; /* elder brother of this message */
1686 struct message
*m_parent
; /* parent of this message */
1687 unsigned m_level
; /* thread level of message */
1688 long m_threadpos
; /* position in threaded display */
1689 char *m_maildir_file
; /* original maildir file of msg */
1690 ui32_t m_maildir_hash
; /* hash of file name in maildir sub */
1691 int m_collapsed
; /* collapsed thread information */
1694 /* Given a file address, determine the block number it represents */
1695 #define mailx_blockof(off) ((int) ((off) / 4096))
1696 #define mailx_offsetof(off) ((int) ((off) % 4096))
1697 #define mailx_positionof(block, offset) ((off_t)(block) * 4096 + (offset))
1699 /* Argument types */
1701 ARG_MSGLIST
= 0, /* Message list type */
1702 ARG_STRLIST
= 1, /* A pure string */
1703 ARG_RAWLIST
= 2, /* Shell string list */
1704 ARG_NOLIST
= 3, /* Just plain 0 */
1705 ARG_NDMLIST
= 4, /* Message list, no defaults */
1706 ARG_ECHOLIST
= 5, /* Like raw list, but keep quote chars */
1707 ARG_ARGMASK
= 7, /* Mask of the above */
1709 ARG_A
= 1u<< 4, /* Needs an active mailbox */
1710 ARG_F
= 1u<< 5, /* Is a conditional command */
1711 ARG_H
= 1u<< 6, /* Never place in history */
1712 ARG_I
= 1u<< 7, /* Interactive command bit */
1713 ARG_M
= 1u<< 8, /* Legal from send mode bit */
1714 ARG_P
= 1u<< 9, /* Autoprint dot after command */
1715 ARG_R
= 1u<<10, /* Cannot be called from collect / recursion */
1716 ARG_T
= 1u<<11, /* Is a transparent command */
1717 ARG_V
= 1u<<12, /* Places data in temporary_arg_v_store */
1718 ARG_W
= 1u<<13, /* Invalid when read only bit */
1719 ARG_O
= 1u<<14 /* OBSOLETE()d command */
1723 GTO
= 1<< 0, /* Grab To: line */
1724 GSUBJECT
= 1<< 1, /* Likewise, Subject: line */
1725 GCC
= 1<< 2, /* And the Cc: line */
1726 GBCC
= 1<< 3, /* And also the Bcc: line */
1728 GNL
= 1<< 4, /* Print blank line after */
1729 GDEL
= 1<< 5, /* Entity removed from list */
1730 GCOMMA
= 1<< 6, /* detract puts in commas */
1731 GUA
= 1<< 7, /* User-Agent field */
1732 GMIME
= 1<< 8, /* MIME 1.0 fields */
1733 GMSGID
= 1<< 9, /* a Message-ID */
1735 GIDENT
= 1<<11, /* From:, Reply-To:, Organization:, MFT: */
1736 GREF
= 1<<12, /* References:, In-Reply-To:, (Message-Id:) */
1737 GDATE
= 1<<13, /* Date: field */
1738 GFULL
= 1<<14, /* Include full names, comments etc. */
1739 GSKIN
= 1<<15, /* Skin names */
1740 GEXTRA
= 1<<16, /* Extra fields (mostly like GIDENT XXX) */
1741 GFILES
= 1<<17, /* Include filename and pipe addresses */
1742 GFULLEXTRA
= 1<<18 /* Only with GFULL: GFULL less address */
1744 #define GMASK (GTO | GSUBJECT | GCC | GBCC)
1748 HF_LIST_REPLY
= 1<< 0,
1749 HF_MFT_SENDER
= 1<< 1, /* Add ourselves to Mail-Followup-To: */
1750 HF_RECIPIENT_RECORD
= 1<<10, /* Save message in file named after rec. */
1754 /* Structure used to pass about the current state of a message (header) */
1756 ui32_t h_flags
; /* enum header_flags bits */
1758 struct name
*h_to
; /* Dynamic "To:" string */
1759 char *h_subject
; /* Subject string */
1760 struct name
*h_cc
; /* Carbon copies string */
1761 struct name
*h_bcc
; /* Blind carbon copies */
1762 struct name
*h_ref
; /* References (possibly overridden) */
1763 struct attachment
*h_attach
; /* MIME attachments */
1764 char *h_charset
; /* preferred charset */
1765 struct name
*h_from
; /* overridden "From:" field */
1766 struct name
*h_sender
; /* overridden "Sender:" field */
1767 struct name
*h_replyto
; /* overridden "Reply-To:" field */
1768 struct name
*h_message_id
; /* overridden "Message-ID:" field */
1769 struct name
*h_in_reply_to
;/* overridden "In-Reply-To:" field */
1770 struct name
*h_mft
; /* Mail-Followup-To */
1771 char const *h_list_post
; /* Address from List-Post:, for `Lreply' */
1772 char *h_organization
; /* overridden "Organization:" field */
1775 /* Handling of namelist nodes used in processing the recipients of mail and
1776 * aliases, inspection of mail-addresses and all that kind of stuff */
1778 NAME_NAME_SALLOC
= 1<< 0, /* .n_name is doped */
1779 NAME_FULLNAME_SALLOC
= 1<< 1, /* .n_fullname is doped */
1780 NAME_SKINNED
= 1<< 2, /* Is actually skin()ned */
1781 NAME_IDNA
= 1<< 3, /* IDNA was applied */
1783 NAME_ADDRSPEC_CHECKED
= 1<< 4, /* Address has been .. and */
1784 NAME_ADDRSPEC_ISFILE
= 1<< 5, /* ..is a file path */
1785 NAME_ADDRSPEC_ISPIPE
= 1<< 6, /* ..is a command for piping */
1786 NAME_ADDRSPEC_ISFILEORPIPE
= NAME_ADDRSPEC_ISFILE
| NAME_ADDRSPEC_ISPIPE
,
1787 NAME_ADDRSPEC_ISNAME
= 1<< 7, /* ..is a valid mail network address */
1788 NAME_ADDRSPEC_ISADDR
= 1<< 8, /* ..is a valid mail network address */
1790 NAME_ADDRSPEC_ERR_EMPTY
= 1<< 9, /* An empty string (or NULL) */
1791 NAME_ADDRSPEC_ERR_ATSEQ
= 1<<10, /* Weird @ sequence */
1792 NAME_ADDRSPEC_ERR_CHAR
= 1<<11, /* Invalid character */
1793 NAME_ADDRSPEC_ERR_IDNA
= 1<<12, /* IDNA convertion failed */
1794 NAME_ADDRSPEC_INVALID
= NAME_ADDRSPEC_ERR_EMPTY
|
1795 NAME_ADDRSPEC_ERR_ATSEQ
| NAME_ADDRSPEC_ERR_CHAR
|
1796 NAME_ADDRSPEC_ERR_IDNA
,
1798 /* Error storage (we must fit in 31-bit) */
1800 _NAME_MAXWC
= 0x3FFFF,
1801 _NAME_MASKWC
= _NAME_MAXWC
<< _NAME_SHIFTWC
1804 /* In the !_ERR_EMPTY case, the failing character can be queried */
1805 #define NAME_ADDRSPEC_ERR_GETWC(F) \
1806 ((((unsigned int)(F) & _NAME_MASKWC) >> _NAME_SHIFTWC) & _NAME_MAXWC)
1807 #define NAME_ADDRSPEC_ERR_SET(F, E, WC) \
1809 (F) = ((F) & ~(NAME_ADDRSPEC_INVALID | _NAME_MASKWC)) |\
1810 (E) | (((unsigned int)(WC) & _NAME_MAXWC) << _NAME_SHIFTWC);\
1814 struct name
*n_flink
; /* Forward link in list. */
1815 struct name
*n_blink
; /* Backward list link */
1816 enum gfield n_type
; /* From which list it came */
1817 enum nameflags n_flags
; /* enum nameflags */
1818 char *n_name
; /* This fella's address */
1819 char *n_fullname
; /* Ditto, unless GFULL including comment */
1820 char *n_fullextra
; /* GFULL, without address */
1824 char const *ag_input
; /* Input string as given */
1825 size_t ag_ilen
; /* strlen() of input */
1826 size_t ag_iaddr_start
; /* Start of *addr-spec* in .ag_input */
1827 size_t ag_iaddr_aend
; /* ..and one past its end */
1828 char *ag_skinned
; /* Output (alloced if !=.ag_input) */
1829 size_t ag_slen
; /* strlen() of .ag_skinned */
1830 size_t ag_sdom_start
; /* Start of domain in .ag_skinned, */
1831 enum nameflags ag_n_flags
; /* enum nameflags of .ag_skinned */
1834 /* MIME attachments */
1836 AC_DEFAULT
, /* _get_lc() -> _iter_*() */
1837 AC_FIX_OUTCS
, /* _get_lc() -> "charset=" .a_charset */
1838 AC_FIX_INCS
, /* "charset=".a_input_charset (nocnv) */
1839 AC_TMPFILE
/* attachment.a_tmpf is converted */
1843 struct attachment
*a_flink
; /* Forward link in list. */
1844 struct attachment
*a_blink
; /* Backward list link */
1845 char const *a_name
; /* file name */
1846 char const *a_content_type
; /* content type */
1847 char const *a_content_disposition
; /* content disposition */
1848 char const *a_content_id
; /* content id */
1849 char const *a_content_description
; /* content description */
1850 char const *a_input_charset
; /* Interpretation depends on .a_conv */
1851 char const *a_charset
; /* ... */
1852 FILE *a_tmpf
; /* If AC_TMPFILE */
1853 enum attach_conv a_conv
; /* User chosen conversion */
1854 int a_msgno
; /* message number */
1858 struct header
*sb_hp
;
1861 struct str sb_signer
; /* USER@HOST for signing+ */
1863 struct ccred sb_ccred
;
1866 /* Structure of the hash table of ignored header fields */
1868 int i_count
; /* Number of entries */
1870 struct ignored
*i_link
; /* Next ignored field in bucket */
1871 char *i_field
; /* This ignored field */
1875 /* For saving the current directory and later returning */
1880 char cw_wd
[PATH_MAX
];
1885 * Global variable declarations
1887 * These become instantiated in main.c.
1891 #ifdef n_MAIN_SOURCE
1892 # ifndef HAVE_AMALGAMATION
1901 VL
int mb_cur_max
; /* Value of MB_CUR_MAX */
1902 VL
int realscreenheight
; /* The real screen height */
1903 VL
int scrnwidth
; /* Screen width, or best guess */
1904 VL
int scrnheight
; /* Screen height/guess (4 header) */
1906 VL
char const *homedir
; /* Path name of home directory */
1907 VL
char const *myname
; /* My login name */
1908 VL
char const *progname
; /* Our name */
1909 VL
char const *tempdir
; /* The temporary directory */
1911 VL gid_t group_id
; /* getgid() and getuid() */
1914 VL
int exit_status
; /* Exit status */
1915 VL ui32_t options
; /* Bits of enum user_options */
1916 VL
struct name
*option_r_arg
; /* Argument to -r option */
1917 VL
char const **smopts
; /* sendmail(1) opts from commline */
1918 VL
size_t smopts_count
; /* Entries in smopts */
1920 VL ui32_t pstate
; /* Bits of enum program_state */
1921 VL
size_t noreset
; /* String resets suspended (recursive) */
1923 /* XXX stylish sorting */
1924 VL
int msgCount
; /* Count of messages read in */
1925 VL
struct mailbox mb
; /* Current mailbox */
1926 VL
int image
; /* File descriptor for msg image */
1927 VL
char mailname
[PATH_MAX
]; /* Name of current file TODO URL/object*/
1928 VL
char displayname
[80 - 40]; /* Prettyfied for display TODO URL/obj*/
1929 VL
char prevfile
[PATH_MAX
]; /* Name of previous file TODO URL/obj */
1930 VL
char const *account_name
; /* Current account name or NULL */
1931 VL off_t mailsize
; /* Size of system mailbox */
1932 VL
struct message
*dot
; /* Pointer to current message */
1933 VL
struct message
*prevdot
; /* Previous current message */
1934 VL
struct message
*message
; /* The actual message structure */
1935 VL
struct message
*threadroot
; /* first threaded message */
1937 VL
struct ignoretab ignore
[2]; /* ignored and retained fields
1938 * 0 is ignore, 1 is retain */
1939 VL
struct ignoretab saveignore
[2]; /* ignored and retained fields
1940 * on save to folder */
1941 VL
struct ignoretab allignore
[2]; /* special, ignore all headers */
1942 VL
struct ignoretab fwdignore
[2]; /* fields to ignore for forwarding */
1944 VL
struct time_current time_current
; /* time(3); send: mail1() XXXcarrier */
1945 VL
struct termios_state termios_state
; /* getpassword(); see commands().. */
1948 VL
enum ssl_verify_level ssl_verify_level
; /* SSL verification level */
1955 VL sigjmp_buf srbuf
;
1957 VL sighandler_type dflpipe
;
1958 VL sighandler_type handlerstacktop
;
1959 #define handlerpush(f) (savedtop = handlerstacktop, handlerstacktop = (f))
1960 #define handlerpop() (handlerstacktop = savedtop)
1962 /* TODO Temporary hacks unless the codebase doesn't jump and uses pass-by-value
1963 * TODO carrier structs instead of locals */
1964 VL
char *temporary_arg_v_store
;
1965 VL
void *temporary_localopts_store
;
1966 /* TODO temporary storage to overcome which_protocol() mess (for PROTO_FILE) */
1967 VL
char const *temporary_protocol_ext
;
1969 /* The remaining variables need initialization */
1971 #ifndef HAVE_AMALGAMATION
1972 VL
char const month_names
[12 + 1][4];
1973 VL
char const weekday_names
[7 + 1][4];
1975 VL
char const uagent
[sizeof UAGENT
];
1977 VL uc_i
const class_char
[1 + 0x7F];
1981 * Finally, let's include the function prototypes XXX embed
1984 #ifndef n_PRIVSEP_SOURCE
1985 # include "nailfuns.h"