开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > Windows编程 > 网络编程 > 查看源码
mail.h
资源名称：imap-4.7.tar.Z　[点击查看]
上传用户：ycwykj01
上传日期：2007-01-04
资源大小：1819k
文件大小：51k
源码类别：

网络编程

开发平台：

Unix_Linux

mail.h：源码内容
  1. /*
  2.  * Program: Mailbox Access routines
  3.  *
  4.  * Author: Mark Crispin
  5.  * Networks and Distributed Computing
  6.  * Computing & Communications
  7.  * University of Washington
  8.  * Administration Building, AG-44
  9.  * Seattle, WA  98195
  10.  * Internet: MRC@CAC.Washington.EDU
  11.  *
  12.  * Date: 22 November 1989
  13.  * Last Edited: 1 November 1999
  14.  *
  15.  * Copyright 1999 by the University of Washington
  16.  *
  17.  *  Permission to use, copy, modify, and distribute this software and its
  18.  * documentation for any purpose and without fee is hereby granted, provided
  19.  * that the above copyright notice appears in all copies and that both the
  20.  * above copyright notice and this permission notice appear in supporting
  21.  * documentation, and that the name of the University of Washington not be
  22.  * used in advertising or publicity pertaining to distribution of the software
  23.  * without specific, written prior permission.  This software is made
  24.  * available "as is", and
  25.  * THE UNIVERSITY OF WASHINGTON DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED,
  26.  * WITH REGARD TO THIS SOFTWARE, INCLUDING WITHOUT LIMITATION ALL IMPLIED
  27.  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, AND IN
  28.  * NO EVENT SHALL THE UNIVERSITY OF WASHINGTON BE LIABLE FOR ANY SPECIAL,
  29.  * INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  30.  * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, TORT
  31.  * (INCLUDING NEGLIGENCE) OR STRICT LIABILITY, ARISING OUT OF OR IN CONNECTION
  32.  * WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  33.  *
  34.  */
  36. /* Build parameters */
  38. #define CACHEINCREMENT 250 /* cache growth increments */
  39. #define MAILTMPLEN 1024 /* size of a temporary buffer */
  40. #define MAXMESSAGESIZE 65000 /* MS-DOS: maximum text buffer size
  41.  * other:  initial text buffer size */
  42. #define NUSERFLAGS 30 /* # of user flags (current servers 30 max) */
  43. #define BASEYEAR 1970 /* the year time began on Unix (note: mx
  44.  * driver depends upon this matching Unix) */
  45. /* default for unqualified addresses */
  46. #define BADHOST ".MISSING-HOST-NAME."
  47. /* default for syntax errors in addresses */
  48. #define ERRHOST ".SYNTAX-ERROR."
  51. /* Coddle certain compilers' 6-character symbol limitation */
  53. #ifdef __COMPILER_KCC__
  54. #include "shortsym.h"
  55. #endif
  58. /* Constants */
  60. #define NIL 0 /* convenient name */
  61. #define T 1 /* opposite of NIL */
  62. #define LONGT (long) 1 /* long T */
  64. #define WARN (long) 1 /* mm_log warning type */
  65. #define ERROR (long) 2 /* mm_log error type */
  66. #define PARSE (long) 3 /* mm_log parse error type */
  67. #define BYE (long) 4 /* mm_notify stream dying */
  69. #define DELIM '377' /* strtok delimiter character */
  72. /* Bits from mail_parse_flags().  Don't change these, since the header format
  73.  * used by tenex, mtx, and mbx corresponds to these bits.
  74.  */
  76. #define fSEEN 1
  77. #define fDELETED 2
  78. #define fFLAGGED 4
  79. #define fANSWERED 8
  80. #define fOLD 16
  81. #define fDRAFT 32
  83. /* Global and Driver Parameters */
  85. /* 0xx: driver and authenticator flags */
  86. #define ENABLE_DRIVER (long) 1
  87. #define DISABLE_DRIVER (long) 2
  88. #define ENABLE_AUTHENTICATOR (long) 3
  89. #define DISABLE_AUTHENTICATOR (long) 4
  90. /* 1xx: c-client globals */
  91. #define GET_DRIVERS (long) 101
  92. #define SET_DRIVERS (long) 102
  93. #define GET_GETS (long) 103
  94. #define SET_GETS (long) 104
  95. #define GET_CACHE (long) 105
  96. #define SET_CACHE (long) 106
  97. #define GET_SMTPVERBOSE (long) 107
  98. #define SET_SMTPVERBOSE (long) 108
  99. #define GET_RFC822OUTPUT (long) 109
  100. #define SET_RFC822OUTPUT (long) 110
  101. #define GET_READPROGRESS (long) 111
  102. #define SET_READPROGRESS (long) 112
  103. #define GET_THREADERS (long) 113
  104. #define SET_THREADERS (long) 114
  105. #define GET_NAMESPACE (long) 115
  106. #define SET_NAMESPACE (long) 116
  107. #define GET_MAILPROXYCOPY (long) 117
  108. #define SET_MAILPROXYCOPY (long) 118
  109. #define GET_SERVICENAME (long) 119
  110. #define SET_SERVICENAME (long) 120
  111. #define GET_DRIVER (long) 121
  112. #define SET_DRIVER (long) 122
  113. #define GET_EXPUNGEATPING (long) 123
  114. #define SET_EXPUNGEATPING (long) 124
  115. #define GET_PARSEPHRASE (long) 125
  116. #define SET_PARSEPHRASE (long) 126
  117. #define GET_ALTDRIVER (long) 127
  118. #define SET_ALTDRIVER (long) 128
  119. #define GET_ALTDRIVERNAME (long) 129
  120. #define SET_ALTDRIVERNAME (long) 130
  121. #define GET_TRYALTFIRST (long) 131
  122. #define SET_TRYALTFIRST (long) 132
  123. #define GET_BLOCKNOTIFY (long) 133
  124. #define SET_BLOCKNOTIFY (long) 134
  125. #define GET_SORTRESULTS (long) 135
  126. #define SET_SORTRESULTS (long) 136
  127. #define GET_THREADRESULTS (long) 137
  128. #define SET_THREADRESULTS (long) 138
  129. #define GET_PARSELINE (long) 139
  130. #define SET_PARSELINE (long) 140
  132. /* 2xx: environment */
  133. #define GET_USERNAME (long) 201
  134. #define SET_USERNAME (long) 202
  135. #define GET_HOMEDIR (long) 203
  136. #define SET_HOMEDIR (long) 204
  137. #define GET_LOCALHOST (long) 205
  138. #define SET_LOCALHOST (long) 206
  139. #define GET_SYSINBOX (long) 207
  140. #define SET_SYSINBOX (long) 208
  141. #define GET_USERPROMPT (long) 209
  142. #define SET_USERPROMPT (long) 210
  143. /* 3xx: TCP/IP */
  144. #define GET_OPENTIMEOUT (long) 300
  145. #define SET_OPENTIMEOUT (long) 301
  146. #define GET_READTIMEOUT (long) 302
  147. #define SET_READTIMEOUT (long) 303
  148. #define GET_WRITETIMEOUT (long) 304
  149. #define SET_WRITETIMEOUT (long) 305
  150. #define GET_CLOSETIMEOUT (long) 306
  151. #define SET_CLOSETIMEOUT (long) 307
  152. #define GET_TIMEOUT (long) 308
  153. #define SET_TIMEOUT (long) 309
  154. #define GET_RSHTIMEOUT (long) 310
  155. #define SET_RSHTIMEOUT (long) 311
  156. #define GET_ALLOWREVERSEDNS (long) 312
  157. #define SET_ALLOWREVERSEDNS (long) 313
  158. #define GET_RSHCOMMAND (long) 314
  159. #define SET_RSHCOMMAND (long) 315
  160. #define GET_RSHPATH (long) 316
  161. #define SET_RSHPATH (long) 317
  162. #define GET_SSHTIMEOUT (long) 318
  163. #define SET_SSHTIMEOUT (long) 319
  164. #define GET_SSHCOMMAND (long) 320
  165. #define SET_SSHCOMMAND (long) 321
  166. #define GET_SSHPATH (long) 322
  167. #define SET_SSHPATH (long) 323
  169. /* 4xx: network drivers */
  170. #define GET_MAXLOGINTRIALS (long) 400
  171. #define SET_MAXLOGINTRIALS (long) 401
  172. #define GET_LOOKAHEAD (long) 402
  173. #define SET_LOOKAHEAD (long) 403
  174. #define GET_IMAPPORT (long) 404
  175. #define SET_IMAPPORT (long) 405
  176. #define GET_PREFETCH (long) 406
  177. #define SET_PREFETCH (long) 407
  178. #define GET_CLOSEONERROR (long) 408
  179. #define SET_CLOSEONERROR (long) 409
  180. #define GET_POP3PORT (long) 410
  181. #define SET_POP3PORT (long) 411
  182. #define GET_UIDLOOKAHEAD (long) 412
  183. #define SET_UIDLOOKAHEAD (long) 413
  184. #define GET_NNTPPORT (long) 414
  185. #define SET_NNTPPORT (long) 415
  186. #define GET_IMAPENVELOPE (long) 416
  187. #define SET_IMAPENVELOPE (long) 417
  188. #define GET_IMAPREFERRAL (long) 418
  189. #define SET_IMAPREFERRAL (long) 419
  190. #define GET_ALTIMAPNAME (long) 420
  191. #define SET_ALTIMAPNAME (long) 421
  192. #define GET_ALTIMAPPORT (long) 422
  193. #define SET_ALTIMAPPORT (long) 423
  194. #define GET_ALTPOPNAME (long) 424
  195. #define SET_ALTPOPNAME (long) 425
  196. #define GET_ALTPOPPORT (long) 426
  197. #define SET_ALTPOPPORT (long) 427
  198. #define GET_ALTNNTPNAME (long) 428
  199. #define SET_ALTNNTPNAME (long) 429
  200. #define GET_ALTNNTPPORT (long) 430
  201. #define SET_ALTNNTPPORT (long) 431
  202. #define GET_ALTSMTPNAME (long) 432
  203. #define SET_ALTSMTPNAME (long) 433
  204. #define GET_ALTSMTPPORT (long) 434
  205. #define SET_ALTSMTPPORT (long) 435
  206. #define GET_SMTPPORT (long) 436
  207. #define SET_SMTPPORT (long) 437
  208. #define GET_IMAPEXTRAHEADERS (long) 438
  209. #define SET_IMAPEXTRAHEADERS (long) 439
  211. /* 5xx: local file drivers */
  212. #define GET_MBXPROTECTION (long) 500
  213. #define SET_MBXPROTECTION (long) 501
  214. #define GET_DIRPROTECTION (long) 502
  215. #define SET_DIRPROTECTION (long) 503
  216. #define GET_LOCKPROTECTION (long) 504
  217. #define SET_LOCKPROTECTION (long) 505
  218. #define GET_FROMWIDGET (long) 506
  219. #define SET_FROMWIDGET (long) 507
  220. #define GET_NEWSACTIVE (long) 508
  221. #define SET_NEWSACTIVE (long) 509
  222. #define GET_NEWSSPOOL (long) 510
  223. #define SET_NEWSSPOOL (long) 511
  224. #define GET_NEWSRC (long) 512
  225. #define SET_NEWSRC (long) 513
  226. #define GET_EXTENSION (long) 514
  227. #define SET_EXTENSION (long) 515
  228. #define GET_DISABLEFCNTLLOCK (long) 516
  229. #define SET_DISABLEFCNTLLOCK (long) 517
  230. #define GET_LOCKEACCESERROR (long) 518
  231. #define SET_LOCKEACCESERROR (long) 519
  232. #define GET_LISTMAXLEVEL (long) 520
  233. #define SET_LISTMAXLEVEL (long) 521
  234. #define GET_ANONYMOUSHOME (long) 522
  235. #define SET_ANONYMOUSHOME (long) 523
  236. #define GET_FTPHOME (long) 524
  237. #define SET_FTPHOME (long) 525
  238. #define GET_PUBLICHOME (long) 526
  239. #define SET_PUBLICHOME (long) 527
  240. #define GET_SHAREDHOME (long) 528
  241. #define SET_SHAREDHOME (long) 529
  242. #define GET_MHPROFILE (long) 530
  243. #define SET_MHPROFILE (long) 531
  244. #define GET_MHPATH (long) 532
  245. #define SET_MHPATH (long) 533
  246. #define GET_ONETIMEEXPUNGEATPING (long) 534
  247. #define SET_ONETIMEEXPUNGEATPING (long) 535
  248. #define GET_USERHASNOLIFE (long) 536
  249. #define SET_USERHASNOLIFE (long) 537
  250. #define GET_FTPPROTECTION (long) 538
  251. #define SET_FTPPROTECTION (long) 539
  252. #define GET_PUBLICPROTECTION (long) 540
  253. #define SET_PUBLICPROTECTION (long) 541
  254. #define GET_SHAREDPROTECTION (long) 542
  255. #define SET_SHAREDPROTECTION (long) 543
  256. #define GET_LOCKTIMEOUT (long) 544
  257. #define SET_LOCKTIMEOUT (long) 545
  258. #define GET_NOTIMEZONES (long) 546
  259. #define SET_NOTIMEZONES (long) 547
  261. /* Driver flags */
  263. #define DR_DISABLE (long) 1 /* driver is disabled */
  264. #define DR_LOCAL (long) 2 /* local file driver */
  265. #define DR_MAIL (long) 4 /* supports mail */
  266. #define DR_NEWS (long) 8 /* supports news */
  267. #define DR_READONLY (long) 16 /* driver only allows readonly access */
  268. #define DR_NOFAST (long) 32 /* "fast" data is slow (whole msg fetch) */
  269. #define DR_NAMESPACE (long) 64 /* driver has a special namespace */
  270. #define DR_LOWMEM (long) 128 /* low amounts of memory available */
  271. #define DR_LOCKING (long) 256 /* driver does locking */
  272. #define DR_CRLF (long) 512 /* driver internal form uses CRLF newlines */
  273. #define DR_NOSTICKY (long) 1024 /* driver does not support sticky UIDs */
  274. #define DR_RECYCLE (long) 2048 /* driver does stream recycling */
  277. /* Cache management function codes */
  279. #define CH_INIT (long) 10 /* initialize cache */
  280. #define CH_SIZE (long) 11 /* (re-)size the cache */
  281. #define CH_MAKEELT (long) 30 /* return elt, make if needed */
  282. #define CH_ELT (long) 31 /* return elt if exists */
  283. #define CH_SORTCACHE (long) 35 /* return sortcache entry, make if needed */
  284. #define CH_FREE (long) 40 /* free space used by elt */
  285. /* free space used by sortcache */
  286. #define CH_FREESORTCACHE (long) 43
  287. #define CH_EXPUNGE (long) 45 /* delete elt pointer from list */
  290. /* Open options */
  292. #define OP_DEBUG (long) 1 /* debug protocol negotiations */
  293. #define OP_READONLY (long) 2 /* read-only open */
  294. #define OP_ANONYMOUS (long) 4 /* anonymous open of newsgroup */
  295. #define OP_SHORTCACHE (long) 8 /* short (elt-only) caching */
  296. #define OP_SILENT (long) 16 /* don't pass up events (internal use) */
  297. #define OP_PROTOTYPE (long) 32 /* return driver prototype */
  298. #define OP_HALFOPEN (long) 64 /* half-open (IMAP connect but no select) */
  299. #define OP_EXPUNGE (long) 128 /* silently expunge recycle stream */
  300. #define OP_SECURE (long) 256 /* don't do non-secure authentication */
  301. #define OP_TRYALT (long) 512 /* try alternate first */
  304. /* Close options */
  306. #define CL_EXPUNGE (long) 1 /* expunge silently */
  309. /* Fetch options */
  311. #define FT_UID (long) 1 /* argument is a UID */
  312. #define FT_PEEK (long) 2 /* peek at data */
  313. #define FT_NOT (long) 4 /* NOT flag for header lines fetch */
  314. #define FT_INTERNAL (long) 8 /* text can be internal strings */
  315. #define FT_PREFETCHTEXT (long) 16 /* IMAP prefetch text when fetching header */
  318. /* Flagging options */
  320. #define ST_UID (long) 1 /* argument is a UID sequence */
  321. #define ST_SILENT (long) 2 /* don't return results */
  322. #define ST_SET (long) 4 /* set vs. clear */
  324. /* Copy options */
  326. #define CP_UID (long) 1 /* argument is a UID sequence */
  327. #define CP_MOVE (long) 2 /* delete from source after copying */
  330. /* Search/sort options */
  332. #define SE_UID (long) 1 /* return UID */
  333. #define SE_FREE (long) 2 /* free search program after finished */
  334. #define SE_NOPREFETCH (long) 4 /* no search prefetching */
  335. #define SO_FREE (long) 8 /* free sort program after finished */
  336. #define SO_NOSERVER (long) 16 /* don't do server-based sort */
  337. #define SE_RETAIN (long) 32 /* retain previous search results */
  338. #define SO_OVERVIEW (long) 64 /* use overviews in searching (NNTP only) */
  341. /* Status options */
  343. #define SA_MESSAGES (long) 1 /* number of messages */
  344. #define SA_RECENT (long) 2 /* number of recent messages */
  345. #define SA_UNSEEN (long) 4 /* number of unseen messages */
  346. #define SA_UIDNEXT (long) 8 /* next UID to be assigned */
  347. #define SA_UIDVALIDITY (long) 16/* UID validity value */
  350. /* Mailgets flags */
  352. #define MG_UID (long) 1 /* message number is a UID */
  353. #define MG_COPY (long) 2 /* must return copy of argument */
  356. /* Garbage collection flags */
  358. #define GC_ELT (long) 1 /* message cache elements */
  359. #define GC_ENV (long) 2 /* envelopes and bodies */
  360. #define GC_TEXTS (long) 4 /* cached texts */
  363. /* Bits for mm_list() and mm_lsub() */
  365. #define LATT_NOINFERIORS (long) 1
  366. #define LATT_NOSELECT (long) 2
  367. #define LATT_MARKED (long) 4
  368. #define LATT_UNMARKED (long) 8
  369. #define LATT_REFERRAL (long) 16
  372. /* Sort functions */
  374. #define SORTDATE 0 /* date */
  375. #define SORTARRIVAL 1 /* arrival date */
  376. #define SORTFROM 2 /* from */
  377. #define SORTSUBJECT 3 /* subject */
  378. #define SORTTO 4 /* to */
  379. #define SORTCC 5 /* cc */
  380. #define SORTSIZE 6 /* size */
  382. /* imapreferral_t codes */
  384. #define REFAUTHFAILED (long) 0 /* authentication referral -- not logged in */
  385. #define REFAUTH (long) 1 /* authentication referral -- logged in */
  386. #define REFSELECT (long) 2 /* select referral */
  387. #define REFCREATE (long) 3
  388. #define REFDELETE (long) 4
  389. #define REFRENAME (long) 5
  390. #define REFSUBSCRIBE (long) 6
  391. #define REFUNSUBSCRIBE (long) 7
  392. #define REFSTATUS (long) 8
  393. #define REFCOPY (long) 9
  394. #define REFAPPEND (long) 10
  397. /* Block notification codes */
  399. #define BLOCK_NONE 0 /* not blocked */
  400. #define BLOCK_SENSITIVE 1 /* sensitive code, disallow alarms */
  401. #define BLOCK_NONSENSITIVE 2 /* non-sensitive code, allow alarms */
  402. #define BLOCK_DNSLOOKUP 10 /* blocked on DNS lookup */
  403. #define BLOCK_TCPOPEN 11 /* blocked on TCP open */
  404. #define BLOCK_TCPREAD 12 /* blocked on TCP read */
  405. #define BLOCK_TCPWRITE 13 /* blocked on TCP write */
  406. #define BLOCK_TCPCLOSE 14 /* blocked on TCP close */
  407. #define BLOCK_FILELOCK 20 /* blocked on file locking */
  409. /* In-memory sized-text */
  411. #define SIZEDTEXT struct mail_sizedtext
  413. SIZEDTEXT {
  414.   unsigned char *data; /* text */
  415.   unsigned long size; /* size of text in octets */
  416. };
  419. /* String list */
  421. #define STRINGLIST struct string_list
  423. STRINGLIST {
  424.   SIZEDTEXT text; /* string text */
  425.   STRINGLIST *next;
  426. };
  429. /* Parse results from mail_valid_net_parse */
  431. #define NETMAXHOST 65
  432. #define NETMAXUSER 65
  433. #define NETMAXMBX 256
  434. #define NETMAXSRV 21
  435. typedef struct net_mailbox {
  436.   char host[NETMAXHOST]; /* host name (may be canonicalized) */
  437.   char orighost[NETMAXHOST]; /* host name before canonicalization */
  438.   char user[NETMAXUSER]; /* user name */
  439.   char mailbox[NETMAXMBX]; /* mailbox name */
  440.   char service[NETMAXSRV]; /* service name */
  441.   unsigned long port; /* TCP port number */
  442.   unsigned int anoflag : 1; /* anonymous */
  443.   unsigned int dbgflag : 1; /* debug flag */
  444.   unsigned int secflag : 1; /* secure flag */
  445.   unsigned int altflag : 1; /* alt driver flag */
  446.   unsigned int tryaltflag : 1; /* (internal) try alt driver first flag */
  447. } NETMBX;
  449. /* Item in an address list */
  451. #define ADDRESS struct mail_address
  453. ADDRESS {
  454.   char *personal; /* personal name phrase */
  455.   char *adl; /* at-domain-list source route */
  456.   char *mailbox; /* mailbox name */
  457.   char *host; /* domain name of mailbox's host */
  458.   char *error; /* error in address from SMTP module */
  459.   ADDRESS *next; /* pointer to next address in list */
  460. };
  463. /* Message envelope */
  465. typedef struct mail_envelope {
  466.   unsigned int ngbogus : 1; /* newsgroups may be bogus */
  467.   unsigned int incomplete : 1; /* envelope may be incomplete */
  468.   char *remail; /* remail header if any */
  469.   ADDRESS *return_path; /* error return address */
  470.   char *date; /* message composition date string */
  471.   ADDRESS *from; /* originator address list */
  472.   ADDRESS *sender; /* sender address list */
  473.   ADDRESS *reply_to; /* reply address list */
  474.   char *subject; /* message subject string */
  475.   ADDRESS *to; /* primary recipient list */
  476.   ADDRESS *cc; /* secondary recipient list */
  477.   ADDRESS *bcc; /* blind secondary recipient list */
  478.   char *in_reply_to; /* replied message ID */
  479.   char *message_id; /* message ID */
  480.   char *newsgroups; /* USENET newsgroups */
  481.   char *followup_to; /* USENET reply newsgroups */
  482.   char *references; /* USENET references */
  483.   void *sparep; /* spare pointer reserved for main program */
  484. } ENVELOPE;
  486. /* Primary body types */
  487. /* If you change any of these you must also change body_types in rfc822.c */
  489. #define TYPETEXT 0 /* unformatted text */
  490. #define TYPEMULTIPART 1 /* multiple part */
  491. #define TYPEMESSAGE 2 /* encapsulated message */
  492. #define TYPEAPPLICATION 3 /* application data */
  493. #define TYPEAUDIO 4 /* audio */
  494. #define TYPEIMAGE 5 /* static image */
  495. #define TYPEVIDEO 6 /* video */
  496. #define TYPEMODEL 7 /* model */
  497. #define TYPEOTHER 8 /* unknown */
  498. #define TYPEMAX 15 /* maximum type code */
  501. /* Body encodings */
  502. /* If you change any of these you must also change body_encodings in rfc822.c
  503.  */
  505. #define ENC7BIT 0 /* 7 bit SMTP semantic data */
  506. #define ENC8BIT 1 /* 8 bit SMTP semantic data */
  507. #define ENCBINARY 2 /* 8 bit binary data */
  508. #define ENCBASE64 3 /* base-64 encoded data */
  509. #define ENCQUOTEDPRINTABLE 4 /* human-readable 8-as-7 bit data */
  510. #define ENCOTHER 5 /* unknown */
  511. #define ENCMAX 10 /* maximum encoding code */
  514. /* Body contents */
  516. #define BODY struct mail_bodystruct
  517. #define MESSAGE struct mail_body_message
  518. #define PARAMETER struct mail_body_parameter
  519. #define PART struct mail_body_part
  520. #define PARTTEXT struct mail_body_text
  522. /* Message body text */
  524. PARTTEXT {
  525.   unsigned long offset; /* offset from body origin */
  526.   SIZEDTEXT text; /* text */
  527. };
  530. /* Message body structure */
  532. BODY {
  533.   unsigned short type; /* body primary type */
  534.   unsigned short encoding; /* body transfer encoding */
  535.   char *subtype; /* subtype string */
  536.   PARAMETER *parameter; /* parameter list */
  537.   char *id; /* body identifier */
  538.   char *description; /* body description */
  539.   struct { /* body disposition */
  540.     char *type; /* disposition type */
  541.     PARAMETER *parameter; /* disposition parameters */
  542.   } disposition;
  543.   STRINGLIST *language; /* body language */
  544.   PARTTEXT mime; /* MIME header */
  545.   PARTTEXT contents; /* body part contents */
  546.   union { /* different ways of accessing contents */
  547.     PART *part; /* body part list */
  548.     MESSAGE *msg; /* body encapsulated message */
  549.   } nested;
  550.   struct {
  551.     unsigned long lines; /* size of text in lines */
  552.     unsigned long bytes; /* size of text in octets */
  553.   } size;
  554.   char *md5; /* MD5 checksum */
  555. };
  558. /* Parameter list */
  560. PARAMETER {
  561.   char *attribute; /* parameter attribute name */
  562.   char *value; /* parameter value */
  563.   PARAMETER *next; /* next parameter in list */
  564. };
  567. /* Multipart content list */
  569. PART {
  570.   BODY body; /* body information for this part */
  571.   PART *next; /* next body part */
  572. };
  575. /* RFC-822 Message */
  577. MESSAGE {
  578.   ENVELOPE *env; /* message envelope */
  579.   BODY *body; /* message body */
  580.   PARTTEXT full; /* full message */
  581.   STRINGLIST *lines; /* lines used to filter header */
  582.   PARTTEXT header; /* header text */
  583.   PARTTEXT text; /* body text */
  584. };
  586. /* Entry in the message cache array */
  588. typedef struct message_cache {
  589.   unsigned long msgno; /* message number */
  590.   unsigned int lockcount : 8; /* non-zero if multiple references */
  591.   unsigned long rfc822_size; /* # of bytes of message as raw RFC822 */
  592.   struct { /* c-client internal use only */
  593.     unsigned long uid; /* message unique ID */
  594.     PARTTEXT special; /* special text pointers */
  595.     MESSAGE msg; /* internal message pointers */
  596.     unsigned int sequence : 1; /* saved sequence bit */
  597.     unsigned int dirty : 1; /* driver internal use */
  598.     unsigned long data; /* driver internal use */
  599.   } private;
  600. /* internal date */
  601.   unsigned int day : 5; /* day of month (1-31) */
  602.   unsigned int month : 4; /* month of year (1-12) */
  603.   unsigned int year : 7; /* year since BASEYEAR (expires in 127 yrs) */
  604.   unsigned int hours: 5; /* hours (0-23) */
  605.   unsigned int minutes: 6; /* minutes (0-59) */
  606.   unsigned int seconds: 6; /* seconds (0-59) */
  607.   unsigned int zoccident : 1; /* non-zero if west of UTC */
  608.   unsigned int zhours : 4; /* hours from UTC (0-12) */
  609.   unsigned int zminutes: 6; /* minutes (0-59) */
  610. /* system flags */
  611.   unsigned int seen : 1; /* system Seen flag */
  612.   unsigned int deleted : 1; /* system Deleted flag */
  613.   unsigned int flagged : 1;  /* system Flagged flag */
  614.   unsigned int answered : 1; /* system Answered flag */
  615.   unsigned int draft : 1; /* system Draft flag */
  616.   unsigned int recent : 1; /* system Recent flag */
  617. /* message status */
  618.   unsigned int valid : 1; /* elt has valid flags */
  619.   unsigned int searched : 1; /* message was searched */
  620.   unsigned int sequence : 1; /* message is in sequence */
  621. /* reserved for use by main program */
  622.   unsigned int spare : 1; /* first spare bit */
  623.   unsigned int spare2 : 1; /* second spare bit */
  624.   unsigned int spare3 : 1; /* third spare bit */
  625.   void *sparep; /* spare pointer */
  626.   unsigned long user_flags; /* user-assignable flags */
  627. } MESSAGECACHE;
  629. /* String structure */
  631. #define STRINGDRIVER struct string_driver
  633. typedef struct mailstring {
  634.   void *data; /* driver-dependent data */
  635.   unsigned long data1; /* driver-dependent data */
  636.   unsigned long size; /* total length of string */
  637.   char *chunk; /* base address of chunk */
  638.   unsigned long chunksize; /* size of chunk */
  639.   unsigned long offset; /* offset of this chunk in base */
  640.   char *curpos; /* current position in chunk */
  641.   unsigned long cursize; /* number of bytes remaining in chunk */
  642.   STRINGDRIVER *dtb; /* driver that handles this type of string */
  643. } STRING;
  646. /* Dispatch table for string driver */
  648. STRINGDRIVER {
  649. /* initialize string driver */
  650.   void (*init) (STRING *s,void *data,unsigned long size);
  651. /* get next character in string */
  652.   char (*next) (STRING *s);
  653. /* set position in string */
  654.   void (*setpos) (STRING *s,unsigned long i);
  655. };
  658. /* Stringstruct access routines */
  660. #define INIT(s,d,data,size) ((*((s)->dtb = &d)->init) (s,data,size))
  661. #define SIZE(s) ((s)->size - GETPOS (s))
  662. #define CHR(s) (*(s)->curpos)
  663. #define SNX(s) (--(s)->cursize ? *(s)->curpos++ : (*(s)->dtb->next) (s))
  664. #define GETPOS(s) ((s)->offset + ((s)->curpos - (s)->chunk))
  665. #define SETPOS(s,i) (*(s)->dtb->setpos) (s,i)
  667. /* Search program */
  669. #define SEARCHPGM struct search_program
  670. #define SEARCHHEADER struct search_header
  671. #define SEARCHSET struct search_set
  672. #define SEARCHOR struct search_or
  673. #define SEARCHPGMLIST struct search_pgm_list
  676. SEARCHHEADER { /* header search */
  677.   SIZEDTEXT line; /* header line */
  678.   SIZEDTEXT text; /* text in header */
  679.   SEARCHHEADER *next; /* next in list */
  680. };
  683. SEARCHSET { /* message set */
  684.   unsigned long first; /* sequence number */
  685.   unsigned long last; /* last value, if a range */
  686.   SEARCHSET *next; /* next in list */
  687. };
  690. SEARCHOR {
  691.   SEARCHPGM *first; /* first program */
  692.   SEARCHPGM *second; /* second program */
  693.   SEARCHOR *next; /* next in list */
  694. };
  697. SEARCHPGMLIST {
  698.   SEARCHPGM *pgm; /* search program */
  699.   SEARCHPGMLIST *next; /* next in list */
  700. };
  702. SEARCHPGM { /* search program */
  703.   SEARCHSET *msgno; /* message numbers */
  704.   SEARCHSET *uid; /* unique identifiers */
  705.   SEARCHOR *or; /* or'ed in programs */
  706.   SEARCHPGMLIST *not; /* and'ed not program */
  707.   SEARCHHEADER *header; /* list of headers */
  708.   STRINGLIST *bcc; /* bcc recipients */
  709.   STRINGLIST *body; /* text in message body */
  710.   STRINGLIST *cc; /* cc recipients */
  711.   STRINGLIST *from; /* originator */
  712.   STRINGLIST *keyword; /* keywords */
  713.   STRINGLIST *unkeyword; /* unkeywords */
  714.   STRINGLIST *subject; /* text in subject */
  715.   STRINGLIST *text; /* text in headers and body */
  716.   STRINGLIST *to; /* to recipients */
  717.   unsigned long larger; /* larger than this size */
  718.   unsigned long smaller; /* smaller than this size */
  719.   unsigned short sentbefore; /* sent before this date */
  720.   unsigned short senton; /* sent on this date */
  721.   unsigned short sentsince; /* sent since this date */
  722.   unsigned short before; /* before this date */
  723.   unsigned short on; /* on this date */
  724.   unsigned short since; /* since this date */
  725.   unsigned int answered : 1; /* answered messages */
  726.   unsigned int unanswered : 1; /* unanswered messages */
  727.   unsigned int deleted : 1; /* deleted messages */
  728.   unsigned int undeleted : 1; /* undeleted messages */
  729.   unsigned int draft : 1; /* message draft */
  730.   unsigned int undraft : 1; /* message undraft */
  731.   unsigned int flagged : 1; /* flagged messages */
  732.   unsigned int unflagged : 1; /* unflagged messages */
  733.   unsigned int recent : 1; /* recent messages */
  734.   unsigned int old : 1; /* old messages */
  735.   unsigned int seen : 1; /* seen messages */
  736.   unsigned int unseen : 1; /* unseen messages */
  737.   /* These must be simulated in IMAP */
  738.   STRINGLIST *return_path; /* error return address */
  739.   STRINGLIST *sender; /* sender address list */
  740.   STRINGLIST *reply_to; /* reply address list */
  741.   STRINGLIST *in_reply_to; /* replied message ID */
  742.   STRINGLIST *message_id; /* message ID */
  743.   STRINGLIST *newsgroups; /* USENET newsgroups */
  744.   STRINGLIST *followup_to; /* USENET reply newsgroups */
  745.   STRINGLIST *references; /* USENET references */
  746. };
  749. /* Mailbox status */
  751. typedef struct mbx_status {
  752.   long flags; /* validity flags */
  753.   unsigned long messages; /* number of messages */
  754.   unsigned long recent; /* number of recent messages */
  755.   unsigned long unseen; /* number of unseen messages */
  756.   unsigned long uidnext; /* next UID to be assigned */
  757.   unsigned long uidvalidity; /* UID validity value */
  758. } MAILSTATUS;
  760. /* Sort program */
  762. typedef void (*postsort_t) (void *sc);
  764. #define SORTPGM struct sort_program
  766. SORTPGM {
  767.   unsigned int reverse : 1; /* sort function is to be reversed */
  768.   unsigned int abort : 1; /* abort sorting */
  769.   short function; /* sort function */
  770.   unsigned long nmsgs; /* number of messages being sorted */
  771.   struct {
  772.     unsigned long cached; /* number of messages cached so far */
  773.     unsigned long sorted; /* number of messages sorted so far */
  774.     unsigned long postsorted; /* number of postsorted messages so far */
  775.   } progress;
  776.   postsort_t postsort; /* post sorter */
  777.   SORTPGM *next; /* next function */
  778. };
  781. /* Sort cache */
  783. #define SORTCACHE struct sort_cache
  785. SORTCACHE {
  786.   unsigned int sorted : 1; /* message has been sorted */
  787.   unsigned int postsorted : 1; /* message has been postsorted */
  788.   SORTPGM *pgm; /* sort program */
  789.   unsigned long num; /* message number (sequence or UID) */
  790.   unsigned long date; /* delivery date */
  791.   unsigned long arrival; /* arrival date */
  792.   unsigned long size; /* message size */
  793.   char *from; /* from string */
  794.   char *to; /* to string */
  795.   char *cc; /* cc string */
  796.   char *subject; /* subject string */
  797. };
  799. /* Mail Access I/O stream */
  802. /* Structure for mail driver dispatch */
  804. #define DRIVER struct driver
  807. /* Mail I/O stream */
  809. typedef struct mail_stream {
  810.   DRIVER *dtb; /* dispatch table for this driver */
  811.   void *local; /* pointer to driver local data */
  812.   char *mailbox; /* mailbox name */
  813.   unsigned short use; /* stream use count */
  814.   unsigned short sequence; /* stream sequence */
  815.   unsigned int inbox : 1; /* stream open on an INBOX */
  816.   unsigned int lock : 1; /* stream lock flag */
  817.   unsigned int debug : 1; /* stream debug flag */
  818.   unsigned int silent : 1; /* don't pass events to main program */
  819.   unsigned int rdonly : 1; /* stream read-only flag */
  820.   unsigned int anonymous : 1; /* stream anonymous access flag */
  821.   unsigned int scache : 1; /* stream short cache flag */
  822.   unsigned int halfopen : 1; /* stream half-open flag */
  823.   unsigned int secure : 1; /* stream secure flag */
  824.   unsigned int tryalt : 1; /* stream tryalt flag */
  825.   unsigned int perm_seen : 1; /* permanent Seen flag */
  826.   unsigned int perm_deleted : 1;/* permanent Deleted flag */
  827.   unsigned int perm_flagged : 1;/* permanent Flagged flag */
  828.   unsigned int perm_answered :1;/* permanent Answered flag */
  829.   unsigned int perm_draft : 1; /* permanent Draft flag */
  830.   unsigned int kwd_create : 1; /* can create new keywords */
  831.   unsigned int uid_nosticky : 1;/* UIDs are not preserved */
  832.   unsigned long perm_user_flags;/* mask of permanent user flags */
  833.   unsigned long gensym; /* generated tag */
  834.   unsigned long nmsgs; /* # of associated msgs */
  835.   unsigned long recent; /* # of recent msgs */
  836.   unsigned long uid_validity; /* UID validity sequence */
  837.   unsigned long uid_last; /* last assigned UID */
  838.   char *user_flags[NUSERFLAGS]; /* pointers to user flags in bit order */
  839.   unsigned long cachesize; /* size of message cache */
  840.   MESSAGECACHE **cache; /* message cache array */
  841.   SORTCACHE **sc; /* sort cache array */
  842.   unsigned long msgno; /* message number of `current' message */
  843.   ENVELOPE *env; /* scratch buffer for envelope */
  844.   BODY *body; /* scratch buffer for body */
  845.   SIZEDTEXT text; /* scratch buffer for text */
  846.   union { /* internal use only */
  847.     struct { /* search temporaries */
  848.       STRINGLIST *string; /* string(s) to search */
  849.       long result; /* search result */
  850.       char *text; /* cache of fetched text */
  851.     } search;
  852.   } private;
  853. } MAILSTREAM;
  856. /* Mail I/O stream handle */
  858. typedef struct mail_stream_handle {
  859.   MAILSTREAM *stream; /* pointer to mail stream */
  860.   unsigned short sequence; /* sequence of what we expect stream to be */
  861. } MAILHANDLE;
  863. /* Message overview */
  865. typedef struct mail_overview {
  866.   char *subject; /* message subject string */
  867.   ADDRESS *from; /* originator address list */
  868.   char *date; /* message composition date string */
  869.   char *message_id; /* message ID */
  870.   char *references; /* USENET references */
  871.   struct { /* may be 0 or NUL if unknown/undefined */
  872.     unsigned long octets; /* message octets (probably LF-newline form) */
  873.     unsigned long lines; /* message lines */
  874.     char *xref; /* cross references */
  875.   } optional;
  876. } OVERVIEW;
  878. /* Network access I/O stream */
  881. /* Structure for network driver dispatch */
  883. #define NETDRIVER struct net_driver
  886. /* Network transport I/O stream */
  888. typedef struct net_stream {
  889.   void *stream; /* driver's I/O stream */
  890.   NETDRIVER *dtb; /* network driver */
  891. } NETSTREAM;
  894. /* Network transport driver dispatch */
  896. NETDRIVER {
  897.   void *(*open) (char *host,char *service,unsigned long port);
  898.   void *(*aopen) (NETMBX *mb,char *service,char *usrbuf);
  899.   char *(*getline) (void *stream);
  900.   long (*getbuffer) (void *stream,unsigned long size,char *buffer);
  901.   long (*soutr) (void *stream,char *string);
  902.   long (*sout) (void *stream,char *string,unsigned long size);
  903.   void (*close) (void *stream);
  904.   char *(*host) (void *stream);
  905.   char *(*remotehost) (void *stream);
  906.   unsigned long (*port) (void *stream);
  907.   char *(*localhost) (void *stream);
  908. };
  911. /* Mailgets data identifier */
  913. typedef struct GETS_DATA {
  914.   MAILSTREAM *stream;
  915.   unsigned long msgno;
  916.   char *what;
  917.   STRINGLIST *stl;
  918.   unsigned long first;
  919.   unsigned long last;
  920.   long flags;
  921. } GETS_DATA;
  924. #define INIT_GETS(md,s,m,w,f,l) 
  925.   md.stream = s, md.msgno = m, md.what = w, md.first = f, md.last = l, 
  926.   md.stl = NIL, md.flags = NIL;
  928. /* Mail delivery I/O stream */
  930. typedef struct send_stream {
  931.   NETSTREAM *netstream; /* network I/O stream */
  932.   char *reply; /* last reply string */
  933.   long replycode; /* last reply code */
  934.   unsigned int debug : 1; /* stream debug flag */
  935.   union { /* protocol specific */
  936.     struct { /* SMTP specific */
  937.       unsigned int ok : 1; /* supports ESMTP */
  938.       struct { /* service extensions */
  939. unsigned int send : 1; /* supports SEND */
  940. unsigned int soml : 1; /* supports SOML */
  941. unsigned int saml : 1; /* supports SAML */
  942. unsigned int expn : 1; /* supports EXPN */
  943. unsigned int help : 1; /* supports HELP */
  944. unsigned int turn : 1; /* supports TURN */
  945. unsigned int etrn : 1; /* supports ETRN */
  946. unsigned int relay : 1; /* supports relaying */
  947. unsigned int pipe : 1; /* supports pipelining */
  948. unsigned int ensc : 1; /* supports enhanced status codes */
  949.       } service;
  950.       struct { /* 8-bit MIME transport */
  951. unsigned int ok : 1; /* supports 8-bit MIME */
  952. unsigned int want : 1; /* want 8-bit MIME */
  953.       } eightbit;
  954.       struct { /* delivery status notification */
  955. unsigned int ok : 1; /* supports DSN */
  956. unsigned int want : 1; /* want DSN */
  957. struct { /* notification options */
  958. /* notify on failure */
  959.   unsigned int failure : 1;
  960. /* notify on delay */
  961.   unsigned int delay : 1;
  962. /* notify on success */
  963.   unsigned int success : 1;
  964. } notify;
  965. unsigned int full : 1; /* return full headers */
  966.       } dsn;
  967.       struct { /* size declaration */
  968. unsigned int ok : 1; /* supports SIZE */
  969. unsigned long limit; /* maximum size supported */
  970.       } size;
  971.       unsigned long auth; /* supported SASL authenticators */
  972.     } esmtp;
  973.     struct { /* NNTP specific */
  974.       unsigned int post : 1; /* supports POST */
  975.     } nntp;
  976.   } protocol;
  977. } SENDSTREAM;
  979. /* Jacket into external interfaces */
  981. typedef long (*readfn_t) (void *stream,unsigned long size,char *buffer);
  982. typedef char *(*mailgets_t) (readfn_t f,void *stream,unsigned long size,
  983.      GETS_DATA *md);
  984. typedef char *(*readprogress_t) (GETS_DATA *md,unsigned long octets);
  985. typedef void *(*mailcache_t) (MAILSTREAM *stream,unsigned long msgno,long op);
  986. typedef long (*mailproxycopy_t) (MAILSTREAM *stream,char *sequence,
  987.  char *mailbox,long options);
  988. typedef long (*tcptimeout_t) (long overall,long last);
  989. typedef void *(*authchallenge_t) (void *stream,unsigned long *len);
  990. typedef long (*authrespond_t) (void *stream,char *s,unsigned long size);
  991. typedef long (*authcheck_t) (void);
  992. typedef long (*authclient_t) (authchallenge_t challenger,
  993.       authrespond_t responder,NETMBX *mb,void *s,
  994.       unsigned long *trial,char *user);
  995. typedef char *(*authresponse_t) (void *challenge,unsigned long clen,
  996.  unsigned long *rlen);
  997. typedef char *(*authserver_t) (authresponse_t responder,int argc,char *argv[]);
  998. typedef void (*smtpverbose_t) (char *buffer);
  999. typedef void (*imapenvelope_t) (MAILSTREAM *stream,unsigned long msgno,
  1000. ENVELOPE *env);
  1001. typedef char *(*imapreferral_t) (MAILSTREAM *stream,char *url,long code);
  1002. typedef void (*overview_t) (MAILSTREAM *stream,unsigned long uid,OVERVIEW *ov);
  1003. typedef unsigned long *(*sorter_t) (MAILSTREAM *stream,char *charset,
  1004.     SEARCHPGM *spg,SORTPGM *pgm,long flags);
  1005. typedef void (*parseline_t) (ENVELOPE *env,char *hdr,char *data,char *host);
  1006. typedef ADDRESS *(*parsephrase_t) (char *phrase,char *end,char *host);
  1007. typedef void *(*blocknotify_t) (int reason,void *data);
  1008. typedef void (*sortresults_t) (MAILSTREAM *stream,unsigned long *list,
  1009.        unsigned long size);
  1010. typedef char *(*userprompt_t) (void);
  1012. /* Globals */
  1014. extern char *body_types[]; /* defined body type strings */
  1015. extern char *body_encodings[]; /* defined body encoding strings */
  1016. extern const char *days[]; /* day name strings */
  1017. extern const char *months[]; /* month name strings */
  1019. /* Threading */
  1021. /* Thread node */
  1023. #define THREADNODE struct thread_node
  1025. THREADNODE {
  1026.   unsigned long num; /* message number */
  1027.   SORTCACHE *sc; /* (internal use) sortcache entry */
  1028.   THREADNODE *branch; /* branch at this point in tree */
  1029.   THREADNODE *next; /* next node */
  1030. };
  1032. typedef void (*threadresults_t) (MAILSTREAM *stream,THREADNODE *tree);
  1035. /* Thread dispatch */
  1037. #define THREADER struct threader_list
  1039. THREADER {
  1040.   char *name; /* name of threader */
  1041.   THREADNODE *(*dispatch) (MAILSTREAM *stream,char *charset,SEARCHPGM *spg,
  1042.    long flags,sorter_t sorter);
  1043.   THREADER *next;
  1044. };
  1047. /* Namespaces */
  1049. #define NAMESPACE struct mail_namespace
  1051. NAMESPACE {
  1052.   char *name; /* name of this namespace */
  1053.   int delimiter; /* hierarchy delimiter */
  1054.   PARAMETER *param; /* namespace parameters */
  1055.   NAMESPACE *next; /* next namespace */
  1056. };
  1059. /* Authentication */
  1061. #define AUTHENTICATOR struct mail_authenticator
  1063. AUTHENTICATOR {
  1064.   unsigned int secflag : 1; /* secure authenticator */
  1065.   char *name; /* name of this authenticator */
  1066.   authcheck_t valid; /* authenticator valid on this system */
  1067.   authclient_t client; /* client function that supports it */
  1068.   authserver_t server; /* server function that supports it */
  1069.   AUTHENTICATOR *next; /* next authenticator */
  1070. };
  1072. /* Mail driver dispatch */
  1074. /* normal dispatching */
  1075. #define SAFE_DISPATCH(dtb,ret,dsp,args) 
  1076.   if (dtb) SAFE_FUNCTION(dtb,ret,(*dtb->dsp),args)
  1077. #define SAFE_FUNCTION(dtb,ret,func,args) ret = func args;
  1079. DRIVER {
  1080.   char *name; /* driver name */
  1081.   unsigned long flags; /* driver flags */
  1082.   DRIVER *next; /* next driver */
  1083. /* mailbox is valid for us */
  1084.   DRIVER *(*valid) (char *mailbox);
  1085. /* manipulate driver parameters */
  1086.   void *(*parameters) (long function,void *value);
  1087. /* scan mailboxes */
  1088.   void (*scan) (MAILSTREAM *stream,char *ref,char *pat,char *contents);
  1089. /* list mailboxes */
  1090.   void (*list) (MAILSTREAM *stream,char *ref,char *pat);
  1091. /* list subscribed mailboxes */
  1092.   void (*lsub) (MAILSTREAM *stream,char *ref,char *pat);
  1093. /* subscribe to mailbox */
  1094.   long (*subscribe) (MAILSTREAM *stream,char *mailbox);
  1095. /* unsubscribe from mailbox */
  1096.   long (*unsubscribe) (MAILSTREAM *stream,char *mailbox);
  1097. /* create mailbox */
  1098.   long (*create) (MAILSTREAM *stream,char *mailbox);
  1099. /* delete mailbox */
  1100.   long (*mbxdel) (MAILSTREAM *stream,char *mailbox);
  1101. /* rename mailbox */
  1102.   long (*mbxren) (MAILSTREAM *stream,char *old,char *newname);
  1103. /* status of mailbox */
  1104.   long (*status) (MAILSTREAM *stream,char *mbx,long flags);
  1106. /* open mailbox */
  1107.   MAILSTREAM *(*open) (MAILSTREAM *stream);
  1108. /* close mailbox */
  1109.   void (*close) (MAILSTREAM *stream,long options);
  1110. /* fetch message "fast" attributes */
  1111.   void (*fast) (MAILSTREAM *stream,char *sequence,long flags);
  1112. /* fetch message flags */
  1113.   void (*msgflags) (MAILSTREAM *stream,char *sequence,long flags);
  1114. /* fetch message overview */
  1115.   long (*overview) (MAILSTREAM *stream,char *sequence,overview_t ofn);
  1116. /* fetch message envelopes */
  1117.   ENVELOPE *(*structure) (MAILSTREAM *stream,unsigned long msgno,BODY **body,
  1118.   long flags);
  1119. /* return RFC-822 header */
  1120.   char *(*header) (MAILSTREAM *stream,unsigned long msgno,
  1121.    unsigned long *length,long flags);
  1122. /* return RFC-822 text */
  1123.   long (*text) (MAILSTREAM *stream,unsigned long msgno,STRING *bs,long flags);
  1124. /* load cache */
  1125.   long (*msgdata) (MAILSTREAM *stream,unsigned long msgno,char *section,
  1126.    unsigned long first,unsigned long last,STRINGLIST *lines,
  1127.    long flags);
  1128. /* return UID for message */
  1129.   unsigned long (*uid) (MAILSTREAM *stream,unsigned long msgno);
  1130. /* return message number from UID */
  1131.   unsigned long (*msgno) (MAILSTREAM *stream,unsigned long uid);
  1132. /* modify flags */
  1133.   void (*flag) (MAILSTREAM *stream,char *sequence,char *flag,long flags);
  1134. /* per-message modify flags */
  1135.   void (*flagmsg) (MAILSTREAM *stream,MESSAGECACHE *elt);
  1136. /* search for message based on criteria */
  1137.   void (*search) (MAILSTREAM *stream,char *charset,SEARCHPGM *pgm,long flags);
  1138. /* sort messages */
  1139.   unsigned long *(*sort) (MAILSTREAM *stream,char *charset,SEARCHPGM *spg,
  1140.   SORTPGM *pgm,long flags);
  1141. /* thread messages */
  1142.   THREADNODE *(*thread) (MAILSTREAM *stream,char *type,char *charset,
  1143.  SEARCHPGM *spg,long flag);
  1144. /* ping mailbox to see if still alive */
  1145.   long (*ping) (MAILSTREAM *stream);
  1146. /* check for new messages */
  1147.   void (*check) (MAILSTREAM *stream);
  1148. /* expunge deleted messages */
  1149.   void (*expunge) (MAILSTREAM *stream);
  1150. /* copy messages to another mailbox */
  1151.   long (*copy) (MAILSTREAM *stream,char *sequence,char *mailbox,long options);
  1152. /* append string message to mailbox */
  1153.   long (*append) (MAILSTREAM *stream,char *mailbox,char *flags,char *date,
  1154.   STRING *message);
  1155. /* garbage collect stream */
  1156.   void (*gc) (MAILSTREAM *stream,long gcflags);
  1157. };
  1160. #include "linkage.h"
  1162. /* Compatibility support names for old interfaces */
  1164. #define mail_close(stream) 
  1165.   mail_close_full (stream,NIL)
  1166. #define mail_fetchfast(stream,sequence) 
  1167.   mail_fetch_fast (stream,sequence,NIL)
  1168. #define mail_fetchfast_full mail_fetch_fast
  1169. #define mail_fetchflags(stream,sequence) 
  1170.   mail_fetch_flags (stream,sequence,NIL)
  1171. #define mail_fetchflags_full mail_fetch_flags
  1172. #define mail_fetchenvelope(stream,msgno) 
  1173.   mail_fetch_structure (stream,msgno,NIL,NIL)
  1174. #define mail_fetchstructure(stream,msgno,body) 
  1175.   mail_fetch_structure (stream,msgno,body,NIL)
  1176. #define mail_fetchstructure_full mail_fetch_structure
  1177. #define mail_fetchheader(stream,msgno) 
  1178.   mail_fetch_header (stream,msgno,NIL,NIL,NIL,FT_PEEK)
  1179. #define mail_fetchheader_full(stream,msgno,lines,len,flags) 
  1180.   mail_fetch_header (stream,msgno,NIL,lines,len,FT_PEEK | (flags))
  1181. #define mail_fetchtext(stream,msgno) 
  1182.   mail_fetch_text (stream,msgno,NIL,NIL,NIL)
  1183. #define mail_fetchtext_full(stream,msgno,length,flags) 
  1184.   mail_fetch_text (stream,msgno,NIL,length,flags)
  1185. #define mail_fetchbody(stream,msgno,section,length) 
  1186.   mail_fetch_body (stream,msgno,section,length,NIL)
  1187. #define mail_fetchbody_full mail_fetch_body
  1188. #define mail_setflag(stream,sequence,flag) 
  1189.   mail_flag (stream,sequence,flag,ST_SET)
  1190. #define mail_setflag_full(stream,sequence,flag,flags) 
  1191.   mail_flag (stream,sequence,flag,ST_SET | (flags))
  1192. #define mail_clearflag(stream,sequence,flag) 
  1193.   mail_flag (stream,sequence,flag,NIL)
  1194. #define mail_clearflag_full mail_flag
  1195. #define mail_search(stream,criteria) 
  1196.   mail_search_full (stream,NIL,mail_criteria (criteria),SE_FREE);
  1197. #define mail_copy(stream,sequence,mailbox) 
  1198.   mail_copy_full (stream,sequence,mailbox,NIL)
  1199. #define mail_move(stream,sequence,mailbox) 
  1200.   mail_copy_full (stream,sequence,mailbox,CP_MOVE)
  1201. #define mail_append(stream,mailbox,message) 
  1202.   mail_append_full (stream,mailbox,NIL,NIL,message)
  1204. /* Function prototypes */
  1206. void mm_searched (MAILSTREAM *stream,unsigned long number);
  1207. void mm_exists (MAILSTREAM *stream,unsigned long number);
  1208. void mm_expunged (MAILSTREAM *stream,unsigned long number);
  1209. void mm_flags (MAILSTREAM *stream,unsigned long number);
  1210. void mm_notify (MAILSTREAM *stream,char *string,long errflg);
  1211. void mm_list (MAILSTREAM *stream,int delimiter,char *name,long attributes);
  1212. void mm_lsub (MAILSTREAM *stream,int delimiter,char *name,long attributes);
  1213. void mm_status (MAILSTREAM *stream,char *mailbox,MAILSTATUS *status);
  1214. void mm_log (char *string,long errflg);
  1215. void mm_dlog (char *string);
  1216. void mm_login (NETMBX *mb,char *user,char *pwd,long trial);
  1217. void mm_critical (MAILSTREAM *stream);
  1218. void mm_nocritical (MAILSTREAM *stream);
  1219. long mm_diskerror (MAILSTREAM *stream,long errcode,long serious);
  1220. void mm_fatal (char *string);
  1221. void *mm_cache (MAILSTREAM *stream,unsigned long msgno,long op);
  1223. extern STRINGDRIVER mail_string;
  1224. void mail_string_init (STRING *s,void *data,unsigned long size);
  1225. char mail_string_next (STRING *s);
  1226. void mail_string_setpos (STRING *s,unsigned long i);
  1227. void mail_link (DRIVER *driver);
  1228. void *mail_parameters (MAILSTREAM *stream,long function,void *value);
  1229. DRIVER *mail_valid (MAILSTREAM *stream,char *mailbox,char *purpose);
  1230. DRIVER *mail_valid_net (char *name,DRIVER *drv,char *host,char *mailbox);
  1231. long mail_valid_net_parse (char *name,NETMBX *mb);
  1232. void mail_scan (MAILSTREAM *stream,char *ref,char *pat,char *contents);
  1233. void mail_list (MAILSTREAM *stream,char *ref,char *pat);
  1234. void mail_lsub (MAILSTREAM *stream,char *ref,char *pat);
  1235. long mail_subscribe (MAILSTREAM *stream,char *mailbox);
  1236. long mail_unsubscribe (MAILSTREAM *stream,char *mailbox);
  1237. long mail_create (MAILSTREAM *stream,char *mailbox);
  1238. long mail_delete (MAILSTREAM *stream,char *mailbox);
  1239. long mail_rename (MAILSTREAM *stream,char *old,char *newname);
  1240. long mail_status (MAILSTREAM *stream,char *mbx,long flags);
  1241. long mail_status_default (MAILSTREAM *stream,char *mbx,long flags);
  1242. MAILSTREAM *mail_open (MAILSTREAM *oldstream,char *name,long options);
  1243. MAILSTREAM *mail_close_full (MAILSTREAM *stream,long options);
  1244. MAILHANDLE *mail_makehandle (MAILSTREAM *stream);
  1245. void mail_free_handle (MAILHANDLE **handle);
  1246. MAILSTREAM *mail_stream (MAILHANDLE *handle);
  1248. void mail_fetch_fast (MAILSTREAM *stream,char *sequence,long flags);
  1249. void mail_fetch_flags (MAILSTREAM *stream,char *sequence,long flags);
  1250. void mail_fetch_overview (MAILSTREAM *stream,char *sequence,overview_t ofn);
  1251. ENVELOPE *mail_fetch_structure (MAILSTREAM *stream,unsigned long msgno,
  1252. BODY **body,long flags);
  1253. char *mail_fetch_message (MAILSTREAM *stream,unsigned long msgno,
  1254.   unsigned long *len,long flags);
  1255. char *mail_fetch_header (MAILSTREAM *stream,unsigned long msgno,char *section,
  1256.  STRINGLIST *lines,unsigned long *len,long flags);
  1257. char *mail_fetch_text (MAILSTREAM *stream,unsigned long msgno,char *section,
  1258.        unsigned long *len,long flags);
  1259. char *mail_fetch_mime (MAILSTREAM *stream,unsigned long msgno,char *section,
  1260.        unsigned long *len,long flags);
  1261. char *mail_fetch_body (MAILSTREAM *stream,unsigned long msgno,char *section,
  1262.        unsigned long *len,long flags);
  1263. long mail_partial_text (MAILSTREAM *stream,unsigned long msgno,char *section,
  1264. unsigned long first,unsigned long last,long flags);
  1265. long mail_partial_body (MAILSTREAM *stream,unsigned long msgno,char *section,
  1266. unsigned long first,unsigned long last,long flags);
  1267. char *mail_fetch_text_return (GETS_DATA *md,SIZEDTEXT *t,unsigned long *len);
  1268. char *mail_fetch_string_return (GETS_DATA *md,STRING *bs,unsigned long i,
  1269. unsigned long *len);
  1270. long mail_read (void *stream,unsigned long size,char *buffer);
  1271. unsigned long mail_uid (MAILSTREAM *stream,unsigned long msgno);
  1272. unsigned long mail_msgno (MAILSTREAM *stream,unsigned long uid);
  1273. void mail_fetchfrom (char *s,MAILSTREAM *stream,unsigned long msgno,
  1274.      long length);
  1275. void mail_fetchsubject (char *s,MAILSTREAM *stream,unsigned long msgno,
  1276. long length);
  1277. MESSAGECACHE *mail_elt (MAILSTREAM *stream,unsigned long msgno);
  1279. void mail_flag (MAILSTREAM *stream,char *sequence,char *flag,long flags);
  1280. void mail_search_full (MAILSTREAM *stream,char *charset,SEARCHPGM *pgm,
  1281.        long flags);
  1282. void mail_search_default (MAILSTREAM *stream,char *charset,SEARCHPGM *pgm,
  1283.   long flags);
  1284. long mail_ping (MAILSTREAM *stream);
  1285. void mail_check (MAILSTREAM *stream);
  1286. void mail_expunge (MAILSTREAM *stream);
  1287. long mail_copy_full (MAILSTREAM *stream,char *sequence,char *mailbox,
  1288.      long options);
  1289. long mail_append_full (MAILSTREAM *stream,char *mailbox,char *flags,char *date,
  1290.        STRING *message);
  1291. void mail_gc (MAILSTREAM *stream,long gcflags);
  1292. void mail_gc_msg (MESSAGE *msg,long gcflags);
  1293. void mail_gc_body (BODY *body);
  1295. BODY *mail_body (MAILSTREAM *stream,unsigned long msgno,char *section);
  1296. char *mail_date (char *string,MESSAGECACHE *elt);
  1297. char *mail_cdate (char *string,MESSAGECACHE *elt);
  1298. long mail_parse_date (MESSAGECACHE *elt,char *string);
  1299. void mail_exists (MAILSTREAM *stream,unsigned long nmsgs);
  1300. void mail_recent (MAILSTREAM *stream,unsigned long recent);
  1301. void mail_expunged (MAILSTREAM *stream,unsigned long msgno);
  1302. void mail_lock (MAILSTREAM *stream);
  1303. void mail_unlock (MAILSTREAM *stream);
  1304. void mail_debug (MAILSTREAM *stream);
  1305. void mail_nodebug (MAILSTREAM *stream);
  1306. long mail_match_lines (STRINGLIST *lines,STRINGLIST *msglines,long flags);
  1307. unsigned long mail_filter (char *text,unsigned long len,STRINGLIST *lines,
  1308.    long flags);
  1309. long mail_search_msg (MAILSTREAM *stream,unsigned long msgno,char *section,
  1310.       SEARCHPGM *pgm);
  1311. long mail_search_header_text (char *s,STRINGLIST *st);
  1312. long mail_search_header (SIZEDTEXT *hdr,STRINGLIST *st);
  1313. long mail_search_text (MAILSTREAM *stream,unsigned long msgno,char *section,
  1314.        STRINGLIST *st,long flags);
  1315. long mail_search_body (MAILSTREAM *stream,unsigned long msgno,BODY *body,
  1316.        char *prefix,unsigned long section,long flags);
  1317. long mail_search_string (SIZEDTEXT *s,char *charset,STRINGLIST **st);
  1318. long mail_search_keyword (MAILSTREAM *stream,MESSAGECACHE *elt,STRINGLIST *st);
  1319. long mail_search_addr (ADDRESS *adr,STRINGLIST *st);
  1320. char *mail_search_gets (readfn_t f,void *stream,unsigned long size,
  1321. GETS_DATA *md);
  1322. SEARCHPGM *mail_criteria (char *criteria);
  1323. int mail_criteria_date (unsigned short *date);
  1324. int mail_criteria_string (STRINGLIST **s);
  1325. unsigned long *mail_sort (MAILSTREAM *stream,char *charset,SEARCHPGM *spg,
  1326.   SORTPGM *pgm,long flags);
  1327. unsigned long *mail_sort_cache (MAILSTREAM *stream,SORTPGM *pgm,SORTCACHE **sc,
  1328. long flags);
  1329. unsigned long *mail_sort_msgs (MAILSTREAM *stream,char *charset,SEARCHPGM *spg,
  1330.        SORTPGM *pgm,long flags);
  1331. SORTCACHE **mail_sort_loadcache (MAILSTREAM *stream,SORTPGM *pgm);
  1332. char *mail_strip_subject (char *t);
  1333. int mail_sort_compare (const void *a1,const void *a2);
  1334. int mail_compare_ulong (unsigned long l1,unsigned long l2);
  1335. int mail_compare_cstring (char *s1,char *s2);
  1336. unsigned long mail_longdate (MESSAGECACHE *elt);
  1337. THREADNODE *mail_thread (MAILSTREAM *stream,char *type,char *charset,
  1338.  SEARCHPGM *spg,long flags);
  1339. THREADNODE *mail_thread_msgs (MAILSTREAM *stream,char *type,char *charset,
  1340.       SEARCHPGM *spg,long flags,sorter_t sorter);
  1341. THREADNODE *mail_thread_orderedsubject (MAILSTREAM *stream,char *charset,
  1342. SEARCHPGM *spg,long flags,
  1343. sorter_t sorter);
  1344. int mail_thread_compare_date (const void *a1,const void *a2);
  1345. long mail_sequence (MAILSTREAM *stream,char *sequence);
  1346. long mail_uid_sequence (MAILSTREAM *stream,char *sequence);
  1347. long mail_parse_flags (MAILSTREAM *stream,char *flag,unsigned long *uf);
  1348. long mail_usable_network_stream (MAILSTREAM *stream,char *name);
  1350. MESSAGECACHE *mail_new_cache_elt (unsigned long msgno);
  1351. ENVELOPE *mail_newenvelope (void);
  1352. ADDRESS *mail_newaddr (void);
  1353. BODY *mail_newbody (void);
  1354. BODY *mail_initbody (BODY *body);
  1355. PARAMETER *mail_newbody_parameter (void);
  1356. PART *mail_newbody_part (void);
  1357. MESSAGE *mail_newmsg (void);
  1358. STRINGLIST *mail_newstringlist (void);
  1359. SEARCHPGM *mail_newsearchpgm (void);
  1360. SEARCHHEADER *mail_newsearchheader (char *line,char *text);
  1361. SEARCHSET *mail_newsearchset (void);
  1362. SEARCHOR *mail_newsearchor (void);
  1363. SEARCHPGMLIST *mail_newsearchpgmlist (void);
  1364. SORTPGM *mail_newsortpgm (void);
  1365. THREADNODE *mail_newthreadnode (SORTCACHE *sc);
  1366. void mail_free_body (BODY **body);
  1367. void mail_free_body_data (BODY *body);
  1368. void mail_free_body_parameter (PARAMETER **parameter);
  1369. void mail_free_body_part (PART **part);
  1370. void mail_free_cache (MAILSTREAM *stream);
  1371. void mail_free_elt (MESSAGECACHE **elt);
  1372. void mail_free_envelope (ENVELOPE **env);
  1373. void mail_free_address (ADDRESS **address);
  1374. void mail_free_stringlist (STRINGLIST **string);
  1375. void mail_free_searchpgm (SEARCHPGM **pgm);
  1376. void mail_free_searchheader (SEARCHHEADER **hdr);
  1377. void mail_free_searchset (SEARCHSET **set);
  1378. void mail_free_searchor (SEARCHOR **orl);
  1379. void mail_free_searchpgmlist (SEARCHPGMLIST **pgl);
  1380. void mail_free_namespace (NAMESPACE **n);
  1381. void mail_free_sortpgm (SORTPGM **pgm);
  1382. void mail_free_threadnode (THREADNODE **thr);
  1383. void auth_link (AUTHENTICATOR *auth);
  1384. char *mail_auth (char *mechanism,authresponse_t resp,int argc,char *argv[]);
  1385. AUTHENTICATOR *mail_lookup_auth (unsigned long i);
  1386. unsigned int mail_lookup_auth_name (char *mechanism,long secflag);
  1388. NETSTREAM *net_open (NETMBX *mb,NETDRIVER *dv,unsigned long port,
  1389.      NETDRIVER *altd,char *alts,unsigned long altp);
  1390. NETSTREAM *net_open_work (NETDRIVER *dv,char *host,char *service,
  1391.   unsigned long port,unsigned long portoverride,
  1392.   long flags);
  1393. NETSTREAM *net_aopen (NETDRIVER *dv,NETMBX *mb,char *service,char *usrbuf);
  1394. char *net_getline (NETSTREAM *stream);
  1395. /* stream must be void* for use as readfn_t */
  1396. long net_getbuffer (void *stream,unsigned long size,char *buffer);
  1397. long net_soutr (NETSTREAM *stream,char *string);
  1398. long net_sout (NETSTREAM *stream,char *string,unsigned long size);
  1399. void net_close (NETSTREAM *stream);
  1400. char *net_host (NETSTREAM *stream);
  1401. char *net_remotehost (NETSTREAM *stream);
  1402. unsigned long net_port (NETSTREAM *stream);
  1403. char *net_localhost (NETSTREAM *stream);
  1405. long sm_subscribe (char *mailbox);
  1406. long sm_unsubscribe (char *mailbox);
  1407. char *sm_read (void **sdb);