unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
9d78ff64d7c71de9f0b50b2372e21c481736f894 blob 97314 bytes (raw)

   1
   2
   3
   4
   5
   6
   7
   8
   9
  10
  11
  12
  13
  14
  15
  16
  17
  18
  19
  20
  21
  22
  23
  24
  25
  26
  27
  28
  29
  30
  31
  32
  33
  34
  35
  36
  37
  38
  39
  40
  41
  42
  43
  44
  45
  46
  47
  48
  49
  50
  51
  52
  53
  54
  55
  56
  57
  58
  59
  60
  61
  62
  63
  64
  65
  66
  67
  68
  69
  70
  71
  72
  73
  74
  75
  76
  77
  78
  79
  80
  81
  82
  83
  84
  85
  86
  87
  88
  89
  90
  91
  92
  93
  94
  95
  96
  97
  98
  99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170
 171
 172
 173
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184
 185
 186
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197
 198
 199
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220
 221
 222
 223
 224
 225
 226
 227
 228
 229
 230
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374
 375
 376
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427
 428
 429
 430
 431
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470
 471
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489
 490
 491
 492
 493
 494
 495
 496
 497
 498
 499
 500
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
 
/* notmuch - Not much of an email library, (just index and search)
 *
 * Copyright © 2009 Carl Worth
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see https://www.gnu.org/licenses/ .
 *
 * Author: Carl Worth <cworth@cworth.org>
 */

/**
 * The notmuch API
 *
 * Not much of an email library, (just index and search)
 */

/**/
#ifndef NOTMUCH_H
#define NOTMUCH_H

#ifdef  __cplusplus
# define NOTMUCH_BEGIN_DECLS  extern "C" {
# define NOTMUCH_END_DECLS    }
#else
# define NOTMUCH_BEGIN_DECLS
# define NOTMUCH_END_DECLS
#endif

NOTMUCH_BEGIN_DECLS

#include <time.h>

#pragma GCC visibility push(default)

#ifndef FALSE
#define FALSE 0
#endif

#ifndef TRUE
#define TRUE 1
#endif

/*
 * The library version number.  This must agree with the soname
 * version in Makefile.local.
 */
#define LIBNOTMUCH_MAJOR_VERSION        5
#define LIBNOTMUCH_MINOR_VERSION        4
#define LIBNOTMUCH_MICRO_VERSION        0


#if defined (__clang_major__) && __clang_major__ >= 3 \
    || defined (__GNUC__) && __GNUC__ >= 5 \
    || defined (__GNUC__) && __GNUC__ == 4 && __GNUC_MINOR__ >= 5
#define NOTMUCH_DEPRECATED(major, minor) \
    __attribute__ ((deprecated ("function deprecated as of libnotmuch " #major "." #minor)))
#else
#define NOTMUCH_DEPRECATED(major, minor) __attribute__ ((deprecated))
#endif

/**
 * Check the version of the notmuch library being compiled against.
 *
 * :param major: major version
 * :param minor: minor version
 * :param micro: micro version
 *
 * :return: true if the library being compiled against is of the
 *          specified version or above.
 *
 * For example::
 *
 *   #if LIBNOTMUCH_CHECK_VERSION(3, 1, 0)
 *       // (code requiring libnotmuch 3.1.0 or above)
 *   #endif
 *
 * LIBNOTMUCH_CHECK_VERSION has been defined since version 3.1.0; to
 * check for versions prior to that, use::
 *
 *   #if !defined(NOTMUCH_CHECK_VERSION)
 *       // (code requiring libnotmuch prior to 3.1.0)
 *   #endif
 */
#define LIBNOTMUCH_CHECK_VERSION(major, minor, micro)                   \
    (LIBNOTMUCH_MAJOR_VERSION > (major) ||                                      \
     (LIBNOTMUCH_MAJOR_VERSION == (major) && LIBNOTMUCH_MINOR_VERSION > (minor)) || \
     (LIBNOTMUCH_MAJOR_VERSION == (major) && LIBNOTMUCH_MINOR_VERSION == (minor) && \
      LIBNOTMUCH_MICRO_VERSION >= (micro)))

/**
 * Notmuch boolean type.
 */
typedef int notmuch_bool_t;

/**
 * Status codes used for the return values of most functions.
 *
 * A zero value (:c:enumerator:`NOTMUCH_STATUS_SUCCESS`) indicates
 * that the function completed without error. Any other value
 * indicates an error.
 */
typedef enum {
    /**
     * No error occurred.
     */
    NOTMUCH_STATUS_SUCCESS = 0,
    /**
     * Out of memory.
     */
    NOTMUCH_STATUS_OUT_OF_MEMORY,
    /**
     * An attempt was made to write to a database opened in read-only
     * mode.
     */
    NOTMUCH_STATUS_READ_ONLY_DATABASE,
    /**
     * A Xapian exception occurred.
     *
     * .. note::
     *
     *   We don't really want to expose this lame
     *   :c:enumerator:`NOTMUCH_STATUS_XAPIAN_EXCEPTION`
     *   value. Instead we should map to things like
     *   :c:enumerator:`NOTMUCH_STATUS_READ_ONLY_DATABASE` or
     *   whatever.
     */
    NOTMUCH_STATUS_XAPIAN_EXCEPTION,
    /**
     * An error occurred trying to read or write to a file (this could
     * be file not found, permission denied, etc.)
     */
    NOTMUCH_STATUS_FILE_ERROR,
    /**
     * A file was presented that doesn't appear to be an email
     * message.
     */
    NOTMUCH_STATUS_FILE_NOT_EMAIL,
    /**
     * A file contains a message ID that is identical to a message
     * already in the database.
     */
    NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID,
    /**
     * The user erroneously passed a ``NULL`` pointer to a notmuch
     * function.
     */
    NOTMUCH_STATUS_NULL_POINTER,
    /**
     * A tag value is too long (exceeds :c:macro:`NOTMUCH_TAG_MAX`).
     */
    NOTMUCH_STATUS_TAG_TOO_LONG,
    /**
     * The :c:func:`notmuch_message_thaw` function has been called
     * more times than :c:func:`notmuch_message_freeze`.
     */
    NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
    /**
     * :c:func:`notmuch_database_end_atomic` has been called more
     * times than :c:func:`notmuch_database_begin_atomic`.
     */
    NOTMUCH_STATUS_UNBALANCED_ATOMIC,
    /**
     * The operation is not supported.
     */
    NOTMUCH_STATUS_UNSUPPORTED_OPERATION,
    /**
     * The operation requires a database upgrade.
     */
    NOTMUCH_STATUS_UPGRADE_REQUIRED,
    /**
     * There is a problem with the proposed path, e.g. a relative path
     * passed to a function expecting an absolute path.
     */
    NOTMUCH_STATUS_PATH_ERROR,
    /**
     * The requested operation was ignored. Depending on the function,
     * this may not be an actual error.
     */
    NOTMUCH_STATUS_IGNORED,
    /**
     * One of the arguments violates the preconditions for the
     * function, in a way not covered by a more specific argument.
     */
    NOTMUCH_STATUS_ILLEGAL_ARGUMENT,
    /**
     * A MIME object claimed to have cryptographic protection which
     * notmuch tried to handle, but the protocol was not specified in
     * an intelligible way.
     */
    NOTMUCH_STATUS_MALFORMED_CRYPTO_PROTOCOL,
    /**
     * Notmuch attempted to do crypto processing, but could not
     * initialize the engine needed to do so.
     */
    NOTMUCH_STATUS_FAILED_CRYPTO_CONTEXT_CREATION,
    /**
     * A MIME object claimed to have cryptographic protection, and
     * notmuch attempted to process it, but the specific protocol was
     * something that notmuch doesn't know how to handle.
     */
    NOTMUCH_STATUS_UNKNOWN_CRYPTO_PROTOCOL,
    /**
     * Unable to load a config file
     */
    NOTMUCH_STATUS_NO_CONFIG,
    /**
     * Unable to load a database
     */
    NOTMUCH_STATUS_NO_DATABASE,
    /**
     * Database exists, so not (re)-created
     */
    NOTMUCH_STATUS_DATABASE_EXISTS,
    /**
     * Syntax error in query
     */
    NOTMUCH_STATUS_BAD_QUERY_SYNTAX,
    /**
     * Not an actual status value. Just a way to find out how many
     * valid status values there are.
     */
    NOTMUCH_STATUS_LAST_STATUS
} notmuch_status_t;

/**
 * Get a string representation of a :c:type:`notmuch_status_t` value.
 *
 * The result is read-only.
 */
const char *
notmuch_status_to_string (notmuch_status_t status);

/* Various opaque data types. For each notmuch_<foo>_t see the various
 * notmuch_<foo> functions below. */
/** Notmuch opaque database type. */
typedef struct _notmuch_database notmuch_database_t;
/** Notmuch opaque query type. */
typedef struct _notmuch_query notmuch_query_t;
/** Notmuch opaque threads type. */
typedef struct _notmuch_threads notmuch_threads_t;
/** Notmuch opaque thread type. */
typedef struct _notmuch_thread notmuch_thread_t;
/** Notmuch opaque messages type. */
typedef struct _notmuch_messages notmuch_messages_t;
/** Notmuch opaque message type. */
typedef struct _notmuch_message notmuch_message_t;
/** Notmuch opaque tags type. */
typedef struct _notmuch_tags notmuch_tags_t;
/** Notmuch opaque directory type. */
typedef struct _notmuch_directory notmuch_directory_t;
/** Notmuch opaque filenames type. */
typedef struct _notmuch_filenames notmuch_filenames_t;
/** Notmuch opaque config list type. */
typedef struct _notmuch_config_list notmuch_config_list_t;
/** Notmuch opaque type. */
typedef struct _notmuch_config_values notmuch_config_values_t;
/** Notmuch opaque config values type. */
typedef struct _notmuch_config_pairs notmuch_config_pairs_t;
/** Notmuch opaque indexing options type. */
typedef struct _notmuch_indexopts notmuch_indexopts_t;

/**
 * Create a new, empty notmuch database located at ``path``.
 *
 * The path should be a top-level directory to a collection of
 * plain-text email messages (one message per file). This call will
 * create a new ".notmuch" directory within ``path`` where notmuch
 * will store its data.
 *
 * After a successful call to :c:func:`notmuch_database_create`, the
 * returned database will be open so the caller should call
 * :c:func:`notmuch_database_destroy` when finished with it.
 *
 * The database will not yet have any data in it
 * (:c:func:`notmuch_database_create` itself is a very cheap
 * function). Messages contained within ``path`` can be added to the
 * database by calling :c:func:`notmuch_database_index_file`.
 *
 * In case of any failure, this function returns an error status and
 * sets ``*database`` to ``NULL`` (after printing an error message on
 * ``stderr``).
 *
 * :return:
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_SUCCESS`: Successfully created
 *     the database.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_NULL_POINTER`: The given ``path``
 *     argument is ``NULL``.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_OUT_OF_MEMORY`: Out of memory.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_FILE_ERROR`: An error occurred
 *     trying to create the database file (such as permission denied,
 *     or file not found, etc.), or the database already exists.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_XAPIAN_EXCEPTION`: A Xapian
 *     exception occurred.
 */
notmuch_status_t
notmuch_database_create (const char *path, notmuch_database_t **database);

/**
 * Like :c:func:`notmuch_database_create`, except optionally return an
 * error message. This message is allocated by malloc and should be
 * freed by the caller.
 */
notmuch_status_t
notmuch_database_create_verbose (const char *path,
				 notmuch_database_t **database,
				 char **error_message);

/**
 * Database open mode for :c:func:`notmuch_database_open`.
 */
typedef enum {
    /**
     * Open database for reading only.
     */
    NOTMUCH_DATABASE_MODE_READ_ONLY = 0,
    /**
     * Open database for reading and writing.
     */
    NOTMUCH_DATABASE_MODE_READ_WRITE
} notmuch_database_mode_t;

/**
 * Deprecated alias for :c:func:`notmuch_database_open_with_config`
 * with config_path="" and error_message=NULL
 *
 * :deprecated: Deprecated as of libnotmuch 5.4 (notmuch 0.32)
 */
notmuch_status_t
notmuch_database_open (const char *path,
		       notmuch_database_mode_t mode,
		       notmuch_database_t **database);
/**
 * Deprecated alias for :c:func:`notmuch_database_open_with_config` with
 * config_path=""
 *
 * :deprecated: Deprecated as of libnotmuch 5.4 (notmuch 0.32)
 */
notmuch_status_t
notmuch_database_open_verbose (const char *path,
			       notmuch_database_mode_t mode,
			       notmuch_database_t **database,
			       char **error_message);

/**
 * Open an existing notmuch database located at 'database_path', using
 * configuration in 'config_path'.
 *
 * :param database_path:
 *   Path to existing database.
 *
 *   A notmuch database is a Xapian database containing appropriate
 *   metadata.
 *
 *   The database should have been created at some time in the past,
 *   (not necessarily by this process), by calling
 *   notmuch_database_create.
 *
 *   If 'database_path' is ``NULL``, use the location specified
 *
 *     - in the environment variable ``NOTMUCH_DATABASE``, if non-empty
 *
 *     - in a configuration file, located as described under ``config_path``
 *
 *     - by ``$XDG_DATA_HOME/notmuch/$PROFILE`` where
 *       ``XDG_DATA_HOME`` defaults to ``$HOME/.local/share`` and
 *       ``PROFILE`` as as discussed in 'profile'
 *
 *   If ``database_path`` is non-``NULL``, but does not appear to be a
 *   Xapian database, check for a directory ``.notmuch/xapian`` below
 *   ``database_path`` (this is the behavior of
 *   :c:func:`notmuch_database_open_verbose` pre-0.32).
 *
 * :param mode: Mode to open database. Use one of
 *   :c:enumerator:`NOTMUCH_DATABASE_MODE_READ_WRITE` or
 *   :c:enumerator:`NOTMUCH_DATABASE_MODE_READ_ONLY`
 *
 * :param config_path:
 *   Path to config file.
 *
 *   Config file is key-value, with mandatory sections. See
 *   :any:`notmuch-config(1)` for more information. The key-value pair
 *   overrides the corresponding configuration data stored in the
 *   database (see :c:func:`notmuch_database_get_config`).
 *
 *   If ``config_path`` is ``NULL`` use the path specified
 *
 *     - in environment variable ``NOTMUCH_CONFIG``, if non-empty.
 *
 *     - by ``XDG_CONFIG_HOME/notmuch/`` where ``XDG_CONFIG_HOME``
 *       defaults to ``$HOME/.config``.
 *
 *     - by ``$HOME/.notmuch-config``.
 *
 *   If ``config_path`` is "" (empty string) then do not open any
 *   configuration file.
 *
 * :param profile:
 *   Name of profile (configuration/database variant).
 *
 *   If non-``NULL``, append to the directory / file path determined
 *   for ``config_path`` and ``database_path``.
 *
 *   If ``NULL`` then use
 *
 *     - environment variable ``NOTMUCH_PROFILE`` if defined,
 *
 *     - otherwise "default" for directories and "" (empty string) for paths.
 *
 * :param database:
 *   Pointer to database object. May not be ``NULL``.
 *
 *   The caller should call :c:func:`notmuch_database_destroy` when
 *   finished with this database.
 *
 *   In case of any failure, this function returns an error status and
 *   sets ``*database`` to ``NULL``.
 *
 * :param error_message:
 *   If non-``NULL``, store error message from opening the database.
 *   Any such message is allocated by **malloc(3)** and should be freed
 *   by the caller.
 *
 * :return:
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_SUCCESS`: Successfully opened the
 *     database.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_NULL_POINTER`: The given database
 *     argument is ``NULL``.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_OUT_OF_MEMORY`: Out of memory.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_FILE_ERROR`: An error occurred
 *     trying to open the database or config file (such as permission
 *     denied, or file not found, etc.), or the database version is
 *     unknown.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_XAPIAN_EXCEPTION`: A Xapian
 *     exception occurred.
 *
 * :since: libnotmuch 5.4 (notmuch 0.32)
 */

notmuch_status_t
notmuch_database_open_with_config (const char *database_path,
				   notmuch_database_mode_t mode,
				   const char *config_path,
				   const char *profile,
				   notmuch_database_t **database,
				   char **error_message);


/**
 * Loads configuration from config file, database, and/or defaults
 *
 * For description of arguments, see
 * :c:func:`notmuch_database_open_with_config`
 *
 * :return:
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_SUCCESS`: Successfully loaded
 *     configuration.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_NO_CONFIG`: No config file was
 *     loaded. Not fatal.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_NO_DATABASE`: No config
 *     information was loaded from a database. Not fatal.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_OUT_OF_MEMORY`: Out of memory.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_FILE_ERROR`: An error occurred
 *     trying to open the database or config file (such as permission
 *     denied, or file not found, etc.)
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_XAPIAN_EXCEPTION`: A Xapian
 *     exception occurred.
 *
 * :since: libnotmuch 5.4 (notmuch 0.32)
 */
notmuch_status_t
notmuch_database_load_config (const char *database_path,
			      const char *config_path,
			      const char *profile,
			      notmuch_database_t **database,
			      char **error_message);

/**
 * Create a new notmuch database located at 'database_path', using
 * configuration in 'config_path'.
 *
 * For description of arguments, see :c:func:`notmuch_database_open_with_config`
 *
 * :return:
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_SUCCESS`: Successfully
 *     created the database.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_DATABASE_EXISTS`: Database
 *     already exists, not created
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_OUT_OF_MEMORY`: Out of
 *     memory.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_FILE_ERROR`: An error
 *     occurred trying to open the database or config file (such as
 *     permission denied, or file not found, etc.)
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_XAPIAN_EXCEPTION`: A Xapian
 *     exception occurred.
 *
 * :since: libnotmuch 5.4 (notmuch 0.32)
 */

notmuch_status_t
notmuch_database_create_with_config (const char *database_path,
				     const char *config_path,
				     const char *profile,
				     notmuch_database_t **database,
				     char **error_message);

/**
 * Retrieve last status string for given database.
 */
const char *
notmuch_database_status_string (const notmuch_database_t *notmuch);

/**
 * Commit changes and close the given notmuch database.
 *
 * After :c:func:`notmuch_database_close` has been called, calls to other
 * functions on objects derived from this database may either behave
 * as if the database had not been closed (e.g., if the required data
 * has been cached) or may fail with a
 * :c:enumerator:`NOTMUCH_STATUS_XAPIAN_EXCEPTION`. The only further operation
 * permitted on the database itself is to call
 * :c:func:`notmuch_database_destroy`.
 *
 * :c:func:`notmuch_database_close` can be called multiple times.
 * Later calls have no effect.
 *
 * For writable databases, :c:func:`notmuch_database_close` commits all changes
 * to disk before closing the database, unless the caller is currently
 * in an atomic section (there was a :c:func:`notmuch_database_begin_atomic`
 * without a matching :c:func:`notmuch_database_end_atomic`). In this case
 * changes since the last commit are discarded. See
 * :c:func:`notmuch_database_end_atomic` for more information.
 *
 * :return:
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_SUCCESS`: Successfully closed the
 *     database.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_XAPIAN_EXCEPTION`: A Xapian
 *     exception occurred; the database has been closed but there are
 *     no guarantees the changes to the database, if any, have been
 *     flushed to disk.
 */
notmuch_status_t
notmuch_database_close (notmuch_database_t *database);

/**
 * A callback invoked by :c:func:`notmuch_database_compact` to notify the user
 * of the progress of the compaction process.
 */
typedef void (*notmuch_compact_status_cb_t)(const char *message, void *closure);

/**
 * Compact a notmuch database, backing up the original database to the
 * given path.
 *
 * The database will be opened with
 * :c:enumerator:`NOTMUCH_DATABASE_MODE_READ_WRITE` during the
 * compaction process to ensure no writes are made.
 *
 * If the optional callback function ``status_cb`` is non-``NULL``, it
 * will be called with diagnostic and informational messages. The
 * argument ``closure`` is passed verbatim to any callback invoked.
 */
notmuch_status_t
notmuch_database_compact (const char *path,
			  const char *backup_path,
			  notmuch_compact_status_cb_t status_cb,
			  void *closure);

/**
 * Like notmuch_database_compact, but take an open database as a
 * parameter.
 *
 * :since: libnnotmuch 5.4 (notmuch 0.32)
 */
notmuch_status_t
notmuch_database_compact_db (notmuch_database_t *database,
			     const char *backup_path,
			     notmuch_compact_status_cb_t status_cb,
			     void *closure);

/**
 * Destroy the notmuch database, closing it if necessary and freeing
 * all associated resources.
 *
 * Return value as in :c:func:`notmuch_database_close` if the database
 * was open; :c:func:`notmuch_database_destroy` itself has no failure
 * modes.
 */
notmuch_status_t
notmuch_database_destroy (notmuch_database_t *database);

/**
 * Return the database path of the given database.
 *
 * The return value is a string owned by notmuch so should not be
 * modified nor freed by the caller.
 */
const char *
notmuch_database_get_path (notmuch_database_t *database);

/**
 * Return the database format version of the given database.
 *
 * :return: Database format version, or 0 on error.
 */
unsigned int
notmuch_database_get_version (notmuch_database_t *database);

/**
 * Can the database be upgraded to a newer database version?
 *
 * If this function returns ``TRUE``, then the caller may call
 * :c:func:`notmuch_database_upgrade` to upgrade the database. If the
 * caller does not upgrade an out-of-date database, then some
 * functions may fail with
 * :c:enumerator:`NOTMUCH_STATUS_UPGRADE_REQUIRED`. This always
 * returns ``FALSE`` for a read-only database because there's no way
 * to upgrade a read-only database.
 *
 * Also returns ``FALSE`` if an error occurs accessing the database.
 */
notmuch_bool_t
notmuch_database_needs_upgrade (notmuch_database_t *database);

/**
 * Upgrade the current database to the latest supported version.
 *
 * This ensures that all current notmuch functionality will be
 * available on the database.  After opening a database in read-write
 * mode, it is recommended that clients check if an upgrade is needed
 * (:c:func:`notmuch_database_needs_upgrade`) and if so, upgrade with
 * this function before making any modifications.  If
 * :c:func:`notmuch_database_needs_upgrade` returns ``FALSE``, this
 * will be a no-op.
 *
 * The optional progress_notify callback can be used by the caller to
 * provide progress indication to the user. If non-``NULL`` it will be
 * called periodically with ``progress`` as a floating-point value in
 * the range of [0.0 .. 1.0] indicating the progress made so far in
 * the upgrade process.  The argument ``closure`` is passed verbatim
 * to any callback invoked.
 */
notmuch_status_t
notmuch_database_upgrade (notmuch_database_t *database,
			  void (*progress_notify)(void *closure,
						  double progress),
			  void *closure);

/**
 * Begin an atomic database operation.
 *
 * Any modifications performed between a successful begin and a
 * :c:func:`notmuch_database_end_atomic` will be applied to the
 * database atomically.  Note that, unlike a typical database
 * transaction, this only ensures atomicity, not durability; neither
 * begin nor end necessarily flush modifications to disk.
 *
 * Atomic sections may be nested.  begin_atomic and end_atomic must
 * always be called in pairs.
 *
 * :return:
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_SUCCESS`: Successfully
 *     entered atomic section.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_XAPIAN_EXCEPTION`: A Xapian
 *     exception occurred; atomic section not entered.
 */
notmuch_status_t
notmuch_database_begin_atomic (notmuch_database_t *notmuch);

/**
 * Indicate the end of an atomic database operation.  If repeated
 * (with matching notmuch_database_begin_atomic) "database.autocommit"
 * times, commit the the transaction and all previous (non-cancelled)
 * transactions to the database.
 *
 * :return:
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_SUCCESS`: Successfully
 *     completed atomic section.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_XAPIAN_EXCEPTION`: A Xapian
 *     exception occurred; atomic section not ended.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_UNBALANCED_ATOMIC`: The
 *     database is not currently in an atomic section.
 */
notmuch_status_t
notmuch_database_end_atomic (notmuch_database_t *notmuch);

/**
 * Return the committed database revision and UUID.
 *
 * The database revision number increases monotonically with each
 * commit to the database.  Hence, all messages and message changes
 * committed to the database (that is, visible to readers) have a last
 * modification revision <= the committed database revision.  Any
 * messages committed in the future will be assigned a modification
 * revision > the committed database revision.
 *
 * The UUID is a ``NUL``-terminated opaque string that uniquely
 * identifies this database. Two revision numbers are only comparable
 * if they have the same database UUID.
 */
unsigned long
notmuch_database_get_revision (notmuch_database_t *notmuch,
			       const char **uuid);

/**
 * Retrieve a directory object from the database for ``path``.
 *
 * Here, ``path`` should be a path relative to the path of
 * ``database`` (see :c:func:`notmuch_database_get_path`), or else
 * should be an absolute path with initial components that match the
 * path of ``database``.
 *
 * If this directory object does not exist in the database, this
 * returns :c:enumerator:`NOTMUCH_STATUS_SUCCESS` and sets
 * ``*directory`` to ``NULL``.
 *
 * Otherwise the returned directory object is owned by the database
 * and as such, will only be valid until
 * :c:func:`notmuch_database_destroy` is called.
 *
 * :return:
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_SUCCESS`: Successfully retrieved
 *     directory.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_NULL_POINTER`: The given
 *     ``directory`` argument is ``NULL``.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_XAPIAN_EXCEPTION`: A Xapian
 *     exception occurred; directory not retrieved.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_UPGRADE_REQUIRED`: The caller
 *     must upgrade the database to use this function.
 */
notmuch_status_t
notmuch_database_get_directory (notmuch_database_t *database,
				const char *path,
				notmuch_directory_t **directory);

/**
 * Add a message file to a database, indexing it for retrieval by
 * future searches.  If a message already exists with the same message
 * ID as the specified file, their indexes will be merged, and this
 * new filename will also be associated with the existing message.
 *
 * Here, ``filename`` should be a path relative to the path of
 * ``database`` (see :c:func:`notmuch_database_get_path`), or else
 * should be an absolute filename with initial components that match
 * the path of ``database``.
 *
 * The file should be a single mail message (not a multi-message mbox)
 * that is expected to remain at its current location, (since the
 * notmuch database will reference the filename, and will not copy the
 * entire contents of the file.
 *
 * If another message with the same message ID already exists in the
 * database, rather than creating a new message, this adds the search
 * terms from the identified file to the existing message's index, and
 * adds ``filename`` to the list of filenames known for the message.
 *
 * The ``indexopts`` parameter can be ``NULL`` (meaning, use the indexing
 * defaults from the database), or can be an explicit choice of
 * indexing options that should govern the indexing of this specific
 * ``filename``.
 *
 * If ``message`` is not ``NULL``, then, on successful return
 * (:c:enumerator:`NOTMUCH_STATUS_SUCCESS` or
 * :c:enumerator:`NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID`) ``*message``
 * will be initialized to a message object that can be used for things
 * such as adding tags to the just-added message. The user should call
 * :c:func:`notmuch_message_destroy` when done with the message. On
 * any failure ``*message`` will be set to ``NULL``.
 *
 * :return:
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_SUCCESS`: Message successfully
 *     added to database.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_XAPIAN_EXCEPTION`: A Xapian
 *     exception occurred, message not added.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID`: Message
 *     has the same message ID as another message already in the
 *     database. The new filename was successfully added to the
 *     message in the database (if not already present) and the
 *     existing message is returned.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_FILE_ERROR`: an error occurred
 *     trying to open the file, (such as permission denied, or file
 *     not found, etc.). Nothing added to the database.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_FILE_NOT_EMAIL`: the contents of
 *     filename don't look like an email message. Nothing added to the
 *     database.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_READ_ONLY_DATABASE`: Database was
 *     opened in read-only mode so no message can be added.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_UPGRADE_REQUIRED`: The caller
 *     must upgrade the database to use this function.
 *
 * :since: libnotmuch 5.1 (notmuch 0.26)
 */
notmuch_status_t
notmuch_database_index_file (notmuch_database_t *database,
			     const char *filename,
			     notmuch_indexopts_t *indexopts,
			     notmuch_message_t **message);

/**
 * Deprecated alias for :c:func:`notmuch_database_index_file` called
 * with ``NULL`` indexopts.
 *
 * :deprecated: Deprecated as of libnotmuch 5.1 (notmuch 0.26). Please
 *   use :c:func:`notmuch_database_index_file` instead.
 *
 */
NOTMUCH_DEPRECATED (5, 1)
notmuch_status_t
notmuch_database_add_message (notmuch_database_t *database,
			      const char *filename,
			      notmuch_message_t **message);

/**
 * Remove a message filename from the given notmuch database. If the
 * message has no more filenames, remove the message.
 *
 * If the same message (as determined by the message ID) is still
 * available via other filenames, then the message will persist in the
 * database for those filenames. When the last filename is removed for
 * a particular message, the database content for that message will be
 * entirely removed.
 *
 * :return:
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_SUCCESS`: The last filename
 *     was removed and the message was removed from the database.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_XAPIAN_EXCEPTION`: A Xapian
 *     exception occurred, message not removed.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID`: This
 *     filename was removed but the message persists in the database
 *     with at least one other filename.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_READ_ONLY_DATABASE`:
 *     Database was opened in read-only mode so no message can be
 *     removed.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_UPGRADE_REQUIRED`: The caller
 *     must upgrade the database to use this function.
 */
notmuch_status_t
notmuch_database_remove_message (notmuch_database_t *database,
				 const char *filename);

/**
 * Find a message with the given message_id.
 *
 * If a message with the given message_id is found then, on successful
 * return (:c:enumerator:`NOTMUCH_STATUS_SUCCESS`) ``*message`` will
 * be initialized to a message object.  The caller should call
 * :c:func:`notmuch_message_destroy` when done with the message.
 *
 * On any failure or when the message is not found, this function
 * initializes ``*message`` to ``NULL``. This means, when
 * :c:enumerator:`NOTMUCH_STATUS_SUCCESS` is returned, the caller is
 * supposed to check ``*message`` for ``NULL`` to find out whether the
 * message with the given message_id was found.
 *
 * :return:
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_SUCCESS`: Successful return,
 *     check ``*message``.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_NULL_POINTER`: The given
 *     ``message`` argument is ``NULL``
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_OUT_OF_MEMORY`: Out of
 *     memory, creating message object
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_XAPIAN_EXCEPTION`: A Xapian
 *     exception occurred
 */
notmuch_status_t
notmuch_database_find_message (notmuch_database_t *database,
			       const char *message_id,
			       notmuch_message_t **message);

/**
 * Find a message with the given filename.
 *
 * If the database contains a message with the given filename then, on
 * successful return (:c:enumerator:`NOTMUCH_STATUS_SUCCESS`)
 * ``*message`` will be initialized to a message object. The caller
 * should call :c:func:`notmuch_message_destroy` when done with the
 * message.
 *
 * On any failure or when the message is not found, this function
 * initializes ``*message`` to ``NULL``. This means, when
 * :c:enumerator:`NOTMUCH_STATUS_SUCCESS` is returned, the caller is
 * supposed to check ``*message`` for ``NULL`` to find out whether the
 * message with the given filename is found.
 *
 * :return:
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_SUCCESS`: Successful return,
 *     check ``*message``
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_NULL_POINTER`: The given
 *     ``message`` argument is ``NULL``
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_OUT_OF_MEMORY`: Out of
 *     memory, creating the message object
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_XAPIAN_EXCEPTION`: A Xapian
 *     exception occurred
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_UPGRADE_REQUIRED`: The
 *     caller must upgrade the database to use this function.
 */
notmuch_status_t
notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
					   const char *filename,
					   notmuch_message_t **message);

/**
 * Return a list of all tags found in the database.
 *
 * This function creates a list of all tags found in the database. The
 * resulting list contains all tags from all messages found in the
 * database.
 *
 * On error this function returns ``NULL``.
 */
notmuch_tags_t *
notmuch_database_get_all_tags (notmuch_database_t *db);

/**
 * Reopen an open notmuch database.
 *
 * :param db:	open notmuch database
 * :param mode:	mode (read only or read-write) for reopened database.
 *
 * :return:
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_SUCCESS`
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_ILLEGAL_ARGUMENT`: The passed
 *     database was not open.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_XAPIAN_EXCEPTION`: A Xapian
 *     exception occured.
 */
notmuch_status_t
notmuch_database_reopen (notmuch_database_t *db, notmuch_database_mode_t mode);

/**
 * Create a new query for 'database'.
 *
 * Here, ``database`` should be an open database, (see
 * :c:func:`notmuch_database_open` and
 * :c:func:`notmuch_database_create`).
 *
 * For the query string, we'll document the syntax here more
 * completely in the future, but it's likely to be a specialized
 * version of the general Xapian query syntax:
 *
 * https://xapian.org/docs/queryparser.html
 *
 * As a special case, passing either a length-zero string, (that is
 * ""), or a string consisting of a single asterisk (that is "*"),
 * will result in a query that returns all messages in the database.
 *
 * See :c:func:`notmuch_query_set_sort` for controlling the order of
 * results.  See :c:func:`notmuch_query_search_messages` and
 * :c:func:`notmuch_query_search_threads` to actually execute the
 * query.
 *
 * User should call :c:func:`notmuch_query_destroy` when finished with
 * this query.
 *
 * Will return ``NULL`` if insufficient memory is available.
 */
notmuch_query_t *
notmuch_query_create (notmuch_database_t *database,
		      const char *query_string);

typedef enum {
    NOTMUCH_QUERY_SYNTAX_XAPIAN,
    NOTMUCH_QUERY_SYNTAX_SEXP
} notmuch_query_syntax_t;

notmuch_status_t
notmuch_query_create_with_syntax (notmuch_database_t *database,
				  const char *query_string,
				  notmuch_query_syntax_t syntax,
				  notmuch_query_t **output);
/**
 * Sort values for :c:func:`notmuch_query_set_sort`.
 */
typedef enum {
    /**
     * Oldest first.
     */
    NOTMUCH_SORT_OLDEST_FIRST,
    /**
     * Newest first.
     */
    NOTMUCH_SORT_NEWEST_FIRST,
    /**
     * Sort by message-id.
     */
    NOTMUCH_SORT_MESSAGE_ID,
    /**
     * Do not sort.
     */
    NOTMUCH_SORT_UNSORTED
} notmuch_sort_t;

/**
 * Return the query_string of this query. See
 * :c:func:`notmuch_query_create`.
 */
const char *
notmuch_query_get_query_string (const notmuch_query_t *query);

/**
 * Return the notmuch database of this query. See notmuch_query_create.
 */
notmuch_database_t *
notmuch_query_get_database (const notmuch_query_t *query);

/**
 * Exclude values for :c:func:`notmuch_query_set_omit_excluded`. The
 * strange order is to maintain backward compatibility: the old
 * ``FALSE``/``TRUE`` options correspond to the new
 * :c:enumerator:`NOTMUCH_EXCLUDE_FLAG`/:c:enumerator:`NOTMUCH_EXCLUDE_TRUE`
 * options.
 */
typedef enum {
    /** See :c:func:`notmuch_query_set_omit_excluded`. */
    NOTMUCH_EXCLUDE_FLAG,
    /** See :c:func:`notmuch_query_set_omit_excluded`. */
    NOTMUCH_EXCLUDE_TRUE,
    /** See :c:func:`notmuch_query_set_omit_excluded`. */
    NOTMUCH_EXCLUDE_FALSE,
    /** See :c:func:`notmuch_query_set_omit_excluded`. */
    NOTMUCH_EXCLUDE_ALL
} notmuch_exclude_t;

/**
 * Specify whether to omit excluded results or simply flag them.  By
 * default, this is set to :c:enumerator:`NOTMUCH_EXCLUDE_TRUE`.
 *
 * If set to :c:enumerator:`NOTMUCH_EXCLUDE_TRUE` or
 * :c:enumerator:`NOTMUCH_EXCLUDE_ALL`,
 * :c:func:`notmuch_query_search_messages` will omit excluded messages
 * from the results, and :c:func:`notmuch_query_search_threads` will
 * omit threads that match only in excluded messages.  If set to
 * :c:enumerator:`NOTMUCH_EXCLUDE_TRUE`,
 * :c:func:`notmuch_query_search_threads` will include all messages in
 * threads that match in at least one non-excluded message.
 * Otherwise, if set to :c:enumerator:`NOTMUCH_EXCLUDE_ALL`,
 * :c:func:`notmuch_query_search_threads` will omit excluded messages
 * from all threads.
 *
 * If set to :c:enumerator:`NOTMUCH_EXCLUDE_FALSE` or
 * :c:enumerator:`NOTMUCH_EXCLUDE_FLAG` then both
 * :c:func:`notmuch_query_search_messages` and
 * :c:func:`notmuch_query_search_threads` will return all matching
 * messages/threads regardless of exclude status. If set to
 * :c:enumerator:`NOTMUCH_EXCLUDE_FLAG` then the exclude flag will be
 * set for any excluded message that is returned by
 * :c:func:`notmuch_query_search_messages`, and the thread counts for
 * threads returned by :c:func:`notmuch_query_search_threads` will be
 * the number of non-excluded messages/matches. Otherwise, if set to
 * :c:enumerator:`NOTMUCH_EXCLUDE_FALSE`, then the exclude status is
 * completely ignored.
 *
 * The performance difference when calling
 * :c:func:`notmuch_query_search_messages` should be relatively small
 * (and both should be very fast).  However, in some cases,
 * :c:func:`notmuch_query_search_threads` is very much faster when
 * omitting excluded messages as it does not need to construct the
 * threads that only match in excluded messages.
 */
void
notmuch_query_set_omit_excluded (notmuch_query_t *query,
				 notmuch_exclude_t omit_excluded);

/**
 * Specify the sorting desired for this query.
 */
void
notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);

/**
 * Return the sort specified for this query. See
 * :c:func:`notmuch_query_set_sort`.
 */
notmuch_sort_t
notmuch_query_get_sort (const notmuch_query_t *query);

/**
 * Add a tag that will be excluded from the query results by default.
 * This exclusion will be ignored if this tag appears explicitly in
 * the query.
 *
 * :return:
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_SUCCESS`: excluded was added
 *     successfully.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_XAPIAN_EXCEPTION`: a Xapian
 *     exception occurred. Most likely a problem lazily parsing the
 *     query string.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_IGNORED`: tag is explicitly
 *     present in the query, so not excluded.
 */
notmuch_status_t
notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag);

/**
 * Execute a query for threads, returning a
 * :c:type:`notmuch_threads_t` object which can be used to iterate
 * over the results. The returned threads object is owned by the query
 * and as such, will only be valid until
 * :c:func:`notmuch_query_destroy`.
 *
 * Typical usage might be::
 *
 *     notmuch_query_t *query;
 *     notmuch_threads_t *threads;
 *     notmuch_thread_t *thread;
 *     notmuch_status_t stat;
 *
 *     query = notmuch_query_create (database, query_string);
 *
 *     for (stat = notmuch_query_search_threads (query, &threads);
 *	    stat == NOTMUCH_STATUS_SUCCESS &&
 *          notmuch_threads_valid (threads);
 *          notmuch_threads_move_to_next (threads))
 *     {
 *         thread = notmuch_threads_get (threads);
 *         ....
 *         notmuch_thread_destroy (thread);
 *     }
 *
 *     notmuch_query_destroy (query);
 *
 * Note: If you are finished with a thread before its containing
 * query, you can call :c:func:`notmuch_thread_destroy` to clean up
 * some memory sooner (as in the above example). Otherwise, if your
 * thread objects are long-lived, then you don't need to call
 * :c:func:`notmuch_thread_destroy` and all the memory will still be
 * reclaimed when the query is destroyed.
 *
 * Note that there's no explicit destructor needed for the
 * :c:type:`notmuch_threads_t` object. (For consistency, we do provide
 * a :c:func:`notmuch_threads_destroy` function, but there's no good
 * reason to call it if the query is about to be destroyed).
 *
 * :since: libnotmuch 5.0 (notmuch 0.25)
 */
notmuch_status_t
notmuch_query_search_threads (notmuch_query_t *query,
			      notmuch_threads_t **out);

/**
 * Deprecated alias for :c:func:`notmuch_query_search_threads`.
 *
 * :deprecated: Deprecated as of libnotmuch 5 (notmuch 0.25). Please
 *   use :c:func:`notmuch_query_search_threads` instead.
 *
 */
NOTMUCH_DEPRECATED (5, 0)
notmuch_status_t
notmuch_query_search_threads_st (notmuch_query_t *query, notmuch_threads_t **out);

/**
 * Execute a query for messages, returning a
 * :c:type:`notmuch_messages_t` object which can be used to iterate
 * over the results. The returned messages object is owned by the
 * query and as such, will only be valid until
 * :c:func:`notmuch_query_destroy`.
 *
 * Typical usage might be::
 *
 *     notmuch_query_t *query;
 *     notmuch_messages_t *messages;
 *     notmuch_message_t *message;
 *
 *     query = notmuch_query_create (database, query_string);
 *
 *     for (messages = notmuch_query_search_messages (query);
 *          notmuch_messages_valid (messages);
 *          notmuch_messages_move_to_next (messages))
 *     {
 *         message = notmuch_messages_get (messages);
 *         ....
 *         notmuch_message_destroy (message);
 *     }
 *
 *     notmuch_query_destroy (query);
 *
 * Note: If you are finished with a message before its containing
 * query, you can call :c:func:`notmuch_message_destroy` to clean up
 * some memory sooner (as in the above example). Otherwise, if your
 * message objects are long-lived, then you don't need to call
 * :c:func:`notmuch_message_destroy` and all the memory will still be
 * reclaimed when the query is destroyed.
 *
 * Note that there's no explicit destructor needed for the
 * :c:type:`notmuch_messages_t` object. (For consistency, we do
 * provide a :c:func:`notmuch_messages_destroy` function, but there's
 * no good reason to call it if the query is about to be destroyed).
 *
 * If a Xapian exception occurs this function will return ``NULL``.
 *
 * :since: libnotmuch 5 (notmuch 0.25)
 */
notmuch_status_t
notmuch_query_search_messages (notmuch_query_t *query,
			       notmuch_messages_t **out);
/**
 * Deprecated alias for :c:func:`notmuch_query_search_messages`
 *
 * :deprecated: Deprecated as of libnotmuch 5 (notmuch 0.25). Please
 *   use :c:func:`notmuch_query_search_messages` instead.
 *
 */

NOTMUCH_DEPRECATED (5, 0)
notmuch_status_t
notmuch_query_search_messages_st (notmuch_query_t *query,
				  notmuch_messages_t **out);

/**
 * Destroy a :c:type:`notmuch_query_t` along with any associated
 * resources.
 *
 * This will in turn destroy any :c:type:`notmuch_threads_t` and
 * :c:type:`notmuch_messages_t` objects generated by this query, (and
 * in turn any :c:type:`notmuch_thread_t` and
 * :c:type:`notmuch_message_t` objects generated from those results,
 * etc.), if such objects haven't already been destroyed.
 */
void
notmuch_query_destroy (notmuch_query_t *query);

/**
 * Is the given ``threads`` iterator pointing at a valid thread.
 *
 * When this function returns ``TRUE``, :c:func:`notmuch_threads_get`
 * will return a valid object. Whereas when this function returns
 * ``FALSE``, :c:func:`notmuch_threads_get` will return ``NULL``.
 *
 * If passed a ``NULL`` pointer, this function returns ``FALSE``
 *
 * See the documentation of :c:func:`notmuch_query_search_threads` for
 * example code showing how to iterate over a
 * :c:type:`notmuch_threads_t` object.
 */
notmuch_bool_t
notmuch_threads_valid (notmuch_threads_t *threads);

/**
 * Get the current thread from ``threads`` as a
 * :c:type:`notmuch_thread_t`.
 *
 * Note: The returned thread belongs to ``threads`` and has a lifetime
 * identical to it (and the query to which it belongs).
 *
 * See the documentation of :c:func:`notmuch_query_search_threads` for
 * example code showing how to iterate over a
 * :c:type:`notmuch_threads_t` object.
 *
 * If an out-of-memory situation occurs, this function will return
 * ``NULL``.
 */
notmuch_thread_t *
notmuch_threads_get (notmuch_threads_t *threads);

/**
 * Move the ``threads`` iterator to the next thread.
 *
 * If ``threads`` is already pointing at the last thread then the
 * iterator will be moved to a point just beyond that last thread,
 * (where :c:func:`notmuch_threads_valid` will return ``FALSE`` and
 * :c:func:`notmuch_threads_get` will return ``NULL``).
 *
 * See the documentation of :c:func:`notmuch_query_search_threads` for
 * example code showing how to iterate over a
 * :c:type:`notmuch_threads_t` object.
 */
void
notmuch_threads_move_to_next (notmuch_threads_t *threads);

/**
 * Destroy a :c:type:`notmuch_threads_t` object.
 *
 * It's not strictly necessary to call this function. All memory from
 * the :c:type:`notmuch_threads_t` object will be reclaimed when the
 * containing query object is destroyed.
 */
void
notmuch_threads_destroy (notmuch_threads_t *threads);

/**
 * Return the number of messages matching a search.
 *
 * This function performs a search and returns the number of matching
 * messages.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_SUCCESS`: query completed
 *     successfully.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_XAPIAN_EXCEPTION`: a Xapian
 *     exception occurred. The value of ``*count`` is not defined.
 *
 * :since: libnotmuch 5 (notmuch 0.25)
 */
notmuch_status_t
notmuch_query_count_messages (notmuch_query_t *query, unsigned int *count);

/**
 * Deprecated alias for :c:func:`notmuch_query_count_messages`
 *
 * :deprecated: Deprecated since libnotmuch 5.0 (notmuch 0.25). Please
 *   use :c:func:`notmuch_query_count_messages` instead.
 */
NOTMUCH_DEPRECATED (5, 0)
notmuch_status_t
notmuch_query_count_messages_st (notmuch_query_t *query, unsigned int *count);

/**
 * Return the number of threads matching a search.
 *
 * This function performs a search and returns the number of unique
 * thread IDs in the matching messages. This is the same as number of
 * threads matching a search.
 *
 * Note that this is a significantly heavier operation than
 * :c:func:`notmuch_query_count_messages` or
 * :c:func:`notmuch_query_count_messages_st`.
 *
 * :return:
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_OUT_OF_MEMORY`: Memory allocation
 *     failed. The value of ``*count`` is not defined
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_SUCCESS`: Query completed
 *     successfully.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_XAPIAN_EXCEPTION`: A Xapian
 *     exception occurred. The value of ``*count`` is not defined.
 *
 * :since: libnotmuch 5 (notmuch 0.25)
 */
notmuch_status_t
notmuch_query_count_threads (notmuch_query_t *query, unsigned *count);

/**
 * Deprecated alias for :c:func:`notmuch_query_count_threads`
 *
 * :deprecated: Deprecated as of libnotmuch 5.0 (notmuch 0.25). Please
 *   use :c:func:`notmuch_query_count_threads_st` instead.
 */
NOTMUCH_DEPRECATED (5, 0)
notmuch_status_t
notmuch_query_count_threads_st (notmuch_query_t *query, unsigned *count);

/**
 * Get the thread ID of ``thread``.
 *
 * The returned string belongs to ``thread`` and as such, should not
 * be modified by the caller and will only be valid for as long as the
 * thread is valid, (which is until :c:func:`notmuch_thread_destroy`
 * or until the query from which it derived is destroyed).
 */
const char *
notmuch_thread_get_thread_id (notmuch_thread_t *thread);

/**
 * Get the total number of messages in ``thread``.
 *
 * This count consists of all messages in the database belonging to
 * this thread. Contrast with
 * :c:func:`notmuch_thread_get_matched_messages`.
 */
int
notmuch_thread_get_total_messages (notmuch_thread_t *thread);

/**
 * Get the total number of files in ``thread``.
 *
 * This sums :c:func:`notmuch_message_count_files` over all messages
 * in the thread
 *
 * :return: Non-negative integer
 *
 * :since: libnotmuch 5.0 (notmuch 0.25)
 */

int
notmuch_thread_get_total_files (notmuch_thread_t *thread);

/**
 * Get a :c:type:`notmuch_messages_t` iterator for the top-level
 * messages in ``thread`` in oldest-first order.
 *
 * This iterator will not necessarily iterate over all of the messages
 * in the thread. It will only iterate over the messages in the thread
 * which are not replies to other messages in the thread.
 *
 * The returned list will be destroyed when the thread is destroyed.
 */
notmuch_messages_t *
notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);

/**
 * Get a :c:type:`notmuch_thread_t` iterator for all messages in
 * ``thread`` in oldest-first order.
 *
 * The returned list will be destroyed when the thread is destroyed.
 */
notmuch_messages_t *
notmuch_thread_get_messages (notmuch_thread_t *thread);

/**
 * Get the number of messages in ``thread`` that matched the search.
 *
 * This count includes only the messages in this thread that were
 * matched by the search from which the thread was created and were
 * not excluded by any exclude tags passed in with the query (see
 * :c:func:`notmuch_query_add_tag_exclude`). Contrast with
 * :c:func:`notmuch_thread_get_total_messages`.
 */
int
notmuch_thread_get_matched_messages (notmuch_thread_t *thread);

/**
 * Get the authors of ``thread`` as a UTF-8 string.
 *
 * The returned string is a comma-separated list of the names of the
 * authors of mail messages in the query results that belong to this
 * thread.
 *
 * The string contains authors of messages matching the query first,
 * then non-matched authors (with the two groups separated by
 * '|'). Within each group, authors are ordered by date.
 *
 * The returned string belongs to ``thread`` and as such, should not
 * be modified by the caller and will only be valid for as long as the
 * thread is valid, (which is until :c:func:`notmuch_thread_destroy`
 * or until the query from which it derived is destroyed).
 */
const char *
notmuch_thread_get_authors (notmuch_thread_t *thread);

/**
 * Get the subject of ``thread`` as a UTF-8 string.
 *
 * The subject is taken from the first message (according to the query
 * order---see :c:func:`notmuch_query_set_sort`) in the query results
 * that belongs to this thread.
 *
 * The returned string belongs to ``thread`` and as such, should not
 * be modified by the caller and will only be valid for as long as the
 * thread is valid, (which is until :c:func:`notmuch_thread_destroy`
 * or until the query from which it derived is destroyed).
 */
const char *
notmuch_thread_get_subject (notmuch_thread_t *thread);

/**
 * Get the date of the oldest message in ``thread`` as a time_t value.
 */
time_t
notmuch_thread_get_oldest_date (notmuch_thread_t *thread);

/**
 * Get the date of the newest message in ``thread`` as a time_t value.
 */
time_t
notmuch_thread_get_newest_date (notmuch_thread_t *thread);

/**
 * Get the tags for ``thread``, returning a :c:type:`notmuch_tags_t`
 * object which can be used to iterate over all tags.
 *
 * Note: In the Notmuch database, tags are stored on individual
 * messages, not on threads. So the tags returned here will be all
 * tags of the messages which matched the search and which belong to
 * this thread.
 *
 * The tags object is owned by the thread and as such, will only be
 * valid for as long as the thread is valid, (for example, until
 * :c:func:`notmuch_thread_destroy` or until the query from which it
 * derived is destroyed).
 *
 * Typical usage might be::
 *
 *     notmuch_thread_t *thread;
 *     notmuch_tags_t *tags;
 *     const char *tag;
 *
 *     thread = notmuch_threads_get (threads);
 *
 *     for (tags = notmuch_thread_get_tags (thread);
 *          notmuch_tags_valid (tags);
 *          notmuch_tags_move_to_next (tags))
 *     {
 *         tag = notmuch_tags_get (tags);
 *         ....
 *     }
 *
 *     notmuch_thread_destroy (thread);
 *
 * Note that there's no explicit destructor needed for the
 * :c:type:`notmuch_tags_t` object. (For consistency, we do provide a
 * :c:func:`notmuch_tags_destroy` function, but there's no good reason
 * to call it if the message is about to be destroyed).
 */
notmuch_tags_t *
notmuch_thread_get_tags (notmuch_thread_t *thread);

/**
 * Destroy a :c:type:`notmuch_thread_t` object.
 */
void
notmuch_thread_destroy (notmuch_thread_t *thread);

/**
 * Is the given ``messages`` iterator pointing at a valid message.
 *
 * When this function returns ``TRUE``, :c:func:`notmuch_messages_get`
 * will return a valid object. Whereas when this function returns
 * ``FALSE``, :c:func:`notmuch_messages_get` will return ``NULL``.
 *
 * See the documentation of :c:func:`notmuch_query_search_messages`
 * for example code showing how to iterate over a
 * :c:type:`notmuch_messages_t` object.
 */
notmuch_bool_t
notmuch_messages_valid (notmuch_messages_t *messages);

/**
 * Get the current message from ``messages`` as a
 * :c:type:`notmuch_message_t`.
 *
 * Note: The returned message belongs to ``messages`` and has a
 * lifetime identical to it (and the query to which it belongs).
 *
 * See the documentation of :c:func:`notmuch_query_search_messages`
 * for example code showing how to iterate over a
 * :c:type:`notmuch_messages_t` object.
 *
 * If an out-of-memory situation occurs, this function will return
 * ``NULL``.
 */
notmuch_message_t *
notmuch_messages_get (notmuch_messages_t *messages);

/**
 * Move the ``messages`` iterator to the next message.
 *
 * If ``messages`` is already pointing at the last message then the
 * iterator will be moved to a point just beyond that last message,
 * (where :c:func:`notmuch_messages_valid` will return ``FALSE`` and
 * :c:func:`notmuch_messages_get` will return ``NULL``).
 *
 * See the documentation of :c:func:`notmuch_query_search_messages`
 * for example code showing how to iterate over a
 * :c:type:`notmuch_messages_t` object.
 */
void
notmuch_messages_move_to_next (notmuch_messages_t *messages);

/**
 * Destroy a :c:type:`notmuch_messages_t` object.
 *
 * It's not strictly necessary to call this function. All memory from
 * the :c:type:`notmuch_messages_t` object will be reclaimed when the
 * containing query object is destroyed.
 */
void
notmuch_messages_destroy (notmuch_messages_t *messages);

/**
 * Return a list of tags from all messages.
 *
 * The resulting list is guaranteed not to contain duplicated tags.
 *
 * .. warning::
 *
 *   You can no longer iterate over messages after calling this
 *   function, because the iterator will point at the end of the list.
 *   We do not have a function to reset the iterator yet and the only
 *   way how you can iterate over the list again is to recreate the
 *   message list.
 *
 * The function returns ``NULL`` on error.
 */
notmuch_tags_t *
notmuch_messages_collect_tags (notmuch_messages_t *messages);

/**
 * Get the database associated with this message.
 *
 * :since: libnotmuch 5.2 (notmuch 0.27)
 */
notmuch_database_t *
notmuch_message_get_database (const notmuch_message_t *message);

/**
 * Get the message ID of ``message``.
 *
 * The returned string belongs to ``message`` and as such, should not
 * be modified by the caller and will only be valid for as long as the
 * message is valid, (which is until the query from which it derived
 * is destroyed).
 *
 * This function will return ``NULL`` if triggers an unhandled Xapian
 * exception.
 */
const char *
notmuch_message_get_message_id (notmuch_message_t *message);

/**
 * Get the thread ID of ``message``.
 *
 * The returned string belongs to ``message`` and as such, should not
 * be modified by the caller and will only be valid for as long as the
 * message is valid, (for example, until the user calls
 * :c:func:`notmuch_message_destroy` on ``message`` or until a query
 * from which it derived is destroyed).
 *
 * This function will return ``NULL`` if triggers an unhandled Xapian
 * exception.
 */
const char *
notmuch_message_get_thread_id (notmuch_message_t *message);

/**
 * Get a :c:type:`notmuch_messages_t` iterator for all of the replies to
 * ``message``.
 *
 * Note: This call only makes sense if ``message`` was ultimately
 * obtained from a :c:type:`notmuch_thread_t` object, (such as by
 * coming directly from the result of calling
 * :c:func:`notmuch_thread_get_toplevel_messages` or by any number of
 * subsequent calls to :c:func:`notmuch_message_get_replies`).
 *
 * If ``message`` was obtained through some non-thread means, (such as
 * by a call to :c:func:`notmuch_query_search_messages`), then this
 * function will return ``NULL``.
 *
 * If there are no replies to ``message``, this function will return
 * ``NULL``. (Note that :c:func:`notmuch_messages_valid` will accept
 * that ``NULL`` value as legitimate, and simply return ``FALSE`` for
 * it.)
 *
 * This function also returns ``NULL`` if it triggers a Xapian
 * exception.
 *
 * The returned list will be destroyed when the thread is destroyed.
 */
notmuch_messages_t *
notmuch_message_get_replies (notmuch_message_t *message);

/**
 * Get the total number of files associated with a message.
 *
 * :return: Non-negative integer for file count, negative integer for
 *   error.
 *
 * :since: libnotmuch 5.0 (notmuch 0.25)
 */
int
notmuch_message_count_files (notmuch_message_t *message);

/**
 * Get a filename for the email corresponding to ``message``.
 *
 * The returned filename is an absolute filename, (the initial
 * component will match :c:func:`notmuch_database_get_path`).
 *
 * The returned string belongs to the message so should not be
 * modified or freed by the caller (nor should it be referenced after
 * the message is destroyed).
 *
 * Note: If this message corresponds to multiple files in the mail
 * store, (that is, multiple files contain identical message IDs),
 * this function will arbitrarily return a single one of those
 * filenames. See :c:func:`notmuch_message_get_filenames` for
 * returning the complete list of filenames.
 *
 * This function returns ``NULL`` if it triggers a Xapian exception.
 */
const char *
notmuch_message_get_filename (notmuch_message_t *message);

/**
 * Get all filenames for the email corresponding to ``message``.
 *
 * Returns a :c:type:`notmuch_filenames_t` iterator listing all the
 * filenames associated with ``message``. These files may not have
 * identical content, but each will have the identical Message-ID.
 *
 * Each filename in the iterator is an absolute filename, (the initial
 * component will match :c:func:`notmuch_database_get_path`).
 *
 * This function returns ``NULL`` if it triggers a Xapian exception.
 */
notmuch_filenames_t *
notmuch_message_get_filenames (notmuch_message_t *message);

/**
 * Re-index the e-mail corresponding to ``message`` using the supplied
 * index options
 *
 * Returns the status of the re-index operation.  (see the return
 * codes documented in :c:func:`notmuch_database_index_file`)
 *
 * After reindexing, the user should discard the message object passed
 * in here by calling :c:func:`notmuch_message_destroy`, since it
 * refers to the original message, not to the reindexed message.
 */
notmuch_status_t
notmuch_message_reindex (notmuch_message_t *message,
			 notmuch_indexopts_t *indexopts);

/**
 * Message flags.
 */
typedef enum {
    NOTMUCH_MESSAGE_FLAG_MATCH,
    NOTMUCH_MESSAGE_FLAG_EXCLUDED,

    /* This message is a "ghost message", meaning it has no filenames
     * or content, but we know it exists because it was referenced by
     * some other message.  A ghost message has only a message ID and
     * thread ID.
     */
    NOTMUCH_MESSAGE_FLAG_GHOST,
} notmuch_message_flag_t;

/**
 * Get a value of a flag for the email corresponding to ``message``.
 *
 * returns ``FALSE`` in case of errors.
 *
 * :deprecated: Deprecated as of libnotmuch 5.3 (notmuch 0.31). Please
 *   use :c:func:`notmuch_message_get_flag_st` instead.
 */
NOTMUCH_DEPRECATED (5, 3)
notmuch_bool_t
notmuch_message_get_flag (notmuch_message_t *message,
			  notmuch_message_flag_t flag);

/**
 * Get a value of a flag for the email corresponding to ``message``.
 *
 * :param message: a message object
 * :param flag: flag to check
 * :param is_set: pointer to boolean to store flag value.
 *
 * :return:
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_SUCCESS`

 *   - :c:enumerator:`NOTMUCH_STATUS_NULL_POINTER`: is_set is
 *     ``NULL``
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_XAPIAN_EXCEPTION`: Accessing
 *     the database triggered an exception.
 *
 * :since: libnotmuch 5.3 (notmuch 0.31)
 */
notmuch_status_t
notmuch_message_get_flag_st (notmuch_message_t *message,
			     notmuch_message_flag_t flag,
			     notmuch_bool_t *is_set);

/**
 * Set a value of a flag for the email corresponding to ``message``.
 */
void
notmuch_message_set_flag (notmuch_message_t *message,
			  notmuch_message_flag_t flag, notmuch_bool_t value);

/**
 * Get the date of ``message`` as a time_t value.
 *
 * For the original textual representation of the Date header from the
 * message call :c:func:`notmuch_message_get_header` with a header
 * value of "date".
 *
 * Returns 0 in case of error.
 */
time_t
notmuch_message_get_date (notmuch_message_t *message);

/**
 * Get the value of the specified header from ``message`` as a UTF-8
 * string.
 *
 * Common headers are stored in the database when the message is
 * indexed and will be returned from the database.  Other headers will
 * be read from the actual message file.
 *
 * The header name is case insensitive.
 *
 * The returned string belongs to the message so should not be
 * modified or freed by the caller (nor should it be referenced after
 * the message is destroyed).
 *
 * Returns an empty string ("") if the message does not contain a
 * header line matching ``header``. Returns ``NULL`` if any error
 * occurs.
 */
const char *
notmuch_message_get_header (notmuch_message_t *message, const char *header);

/**
 * Get the tags for ``message``, returning a :c:type:`notmuch_tags_t`
 * object which can be used to iterate over all tags.
 *
 * The tags object is owned by the message and as such, will only be
 * valid for as long as the message is valid, (which is until the
 * query from which it derived is destroyed).
 *
 * Typical usage might be::
 *
 *     notmuch_message_t *message;
 *     notmuch_tags_t *tags;
 *     const char *tag;
 *
 *     message = notmuch_database_find_message (database, message_id);
 *
 *     for (tags = notmuch_message_get_tags (message);
 *          notmuch_tags_valid (tags);
 *          notmuch_tags_move_to_next (tags))
 *     {
 *         tag = notmuch_tags_get (tags);
 *         ....
 *     }
 *
 *     notmuch_message_destroy (message);
 *
 * Note that there's no explicit destructor needed for the
 * :c:type:`notmuch_tags_t` object. (For consistency, we do provide a
 * :c:func:`notmuch_tags_destroy` function, but there's no good reason
 * to call it if the message is about to be destroyed).
 */
notmuch_tags_t *
notmuch_message_get_tags (notmuch_message_t *message);

/**
 * The longest possible tag value.
 */
#define NOTMUCH_TAG_MAX 200

/**
 * Add a tag to the given message.
 *
 * :return:
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_SUCCESS`: Tag successfully
 *     added to message
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_NULL_POINTER`: The ``tag``
 *     argument is ``NULL``
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_TAG_TOO_LONG`: The length of
 *     ``tag`` is too long (exceeds :c:macro:`NOTMUCH_TAG_MAX`)
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_READ_ONLY_DATABASE`:
 *     Database was opened in read-only mode so message cannot be
 *     modified.
 */
notmuch_status_t
notmuch_message_add_tag (notmuch_message_t *message, const char *tag);

/**
 * Remove a tag from the given message.
 *
 * :return:
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_SUCCESS`: Tag successfully
 *     removed from message
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_NULL_POINTER`: The ``tag``
 *     argument is ``NULL``
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_TAG_TOO_LONG`: The length of
 *     ``tag`` is too long (exceeds :c:macro:`NOTMUCH_TAG_MAX`)
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_READ_ONLY_DATABASE`:
 *     Database was opened in read-only mode so message cannot be
 *     modified.
 */
notmuch_status_t
notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);

/**
 * Remove all tags from the given message.
 *
 * See :c:func:`notmuch_message_freeze` for an example showing how to
 * safely replace tag values.
 *
 * :return:
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_READ_ONLY_DATABASE`:
 *     Database was opened in read-only mode so message cannot be
 *     modified.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_XAPIAN_EXCEPTION`: An
 *     exception was thrown accessing the database.
 */
notmuch_status_t
notmuch_message_remove_all_tags (notmuch_message_t *message);

/**
 * Add/remove tags according to maildir flags in the message filename(s).
 *
 * This function examines the filenames of ``message`` for maildir
 * flags, and adds or removes tags on ``message`` as follows when
 * these flags are present:
 *
 * =====   ==============================================
 * Flag    Action if present
 * =====   ==============================================
 * ``D``   Adds the "draft" tag to the message
 * ``F``   Adds the "flagged" tag to the message
 * ``P``   Adds the "passed" tag to the message
 * ``R``   Adds the "replied" tag to the message
 * ``S``   Removes the "unread" tag from the message
 * =====   ==============================================
 *
 * For each flag that is not present, the opposite action (add/remove)
 * is performed for the corresponding tags.
 *
 * Flags are identified as trailing components of the filename after a
 * sequence of ``:2,``.
 *
 * If there are multiple filenames associated with this message, the
 * flag is considered present if it appears in one or more
 * filenames. (That is, the flags from the multiple filenames are
 * combined with the logical OR operator.)
 *
 * A client can ensure that notmuch database tags remain synchronized
 * with maildir flags by calling this function after each call to
 * :c:func:`notmuch_database_index_file`. See also
 * :c:func:`notmuch_message_tags_to_maildir_flags` for synchronizing
 * tag changes back to maildir flags.
 */
notmuch_status_t
notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);

/**
 * return ``TRUE`` if any filename of ``message`` has maildir flag
 * ``flag``, ``FALSE`` otherwise.
 *
 * Deprecated wrapper for
 * :c:func:`notmuch_message_has_maildir_flag_st`
 *
 * :return: ``FALSE`` in case of error
 *
 * :deprecated: libnotmuch 5.3 (notmuch 0.31)
 */
NOTMUCH_DEPRECATED (5, 3)
notmuch_bool_t
notmuch_message_has_maildir_flag (notmuch_message_t *message, char flag);

/**
 * check message for maildir flag
 *
 * :param message: message message to check
 * :param flag: flag to check for
 * :param is_set: pointer to boolean
 *
 * :return:
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_SUCCESS`.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_NULL_POINTER`: ``is_set`` is
 *     ``NULL``.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_XAPIAN_EXCEPTION`: Accessing the
 *     database triggered an exception.
 */
notmuch_status_t
notmuch_message_has_maildir_flag_st (notmuch_message_t *message,
				     char flag,
				     notmuch_bool_t *is_set);

/**
 * Rename message filename(s) to encode tags as maildir flags.
 *
 * Specifically, for each filename corresponding to this message:
 *
 * If the filename is not in a maildir directory, do nothing.  (A
 * maildir directory is determined as a directory named ``new`` or
 * ``cur``.) Similarly, if the filename has invalid maildir info,
 * (repeated or outof-ASCII-order flag characters after ``:2,``), then
 * do nothing.
 *
 * If the filename is in a maildir directory, rename the file so that
 * its filename ends with the sequence ``:2,`` followed by zero or
 * more of the following single-character flags (in ASCII order):
 *
 *   * flag ``D`` iff the message has the "draft" tag
 *   * flag ``F`` iff the message has the "flagged" tag
 *   * flag ``P`` iff the message has the "passed" tag
 *   * flag ``R`` iff the message has the "replied" tag
 *   * flag ``S`` iff the message does not have the "unread" tag
 *
 * Any existing flags unmentioned in the list above will be preserved
 * in the renaming.
 *
 * Also, if this filename is in a directory named ``new``, rename it
 * to be within the neighboring directory named ``cur``.
 *
 * A client can ensure that maildir filename flags remain synchronized
 * with notmuch database tags by calling this function after changing
 * tags, (after calls to :c:func:`notmuch_message_add_tag`,
 * :c:func:`notmuch_message_remove_tag`, or
 * :c:func:`notmuch_message_freeze`/
 * :c:func:`notmuch_message_thaw`). See also
 * :c:func:`notmuch_message_maildir_flags_to_tags` for synchronizing
 * maildir flag changes back to tags.
 */
notmuch_status_t
notmuch_message_tags_to_maildir_flags (notmuch_message_t *message);

/**
 * Freeze the current state of ``message`` within the database.
 *
 * This means that changes to the message state, (via
 * :c:func:`notmuch_message_add_tag`,
 * :c:func:`notmuch_message_remove_tag`, and
 * :c:func:`notmuch_message_remove_all_tags`), will not be committed
 * to the database until the message is thawed with
 * :c:func:`notmuch_message_thaw`.
 *
 * Multiple calls to freeze/thaw are valid and these calls will
 * "stack". That is there must be as many calls to thaw as to freeze
 * before a message is actually thawed.
 *
 * The ability to do freeze/thaw allows for safe transactions to
 * change tag values. For example, explicitly setting a message to
 * have a given set of tags might look like this::
 *
 *    notmuch_message_freeze (message);
 *
 *    notmuch_message_remove_all_tags (message);
 *
 *    for (i = 0; i < NUM_TAGS; i++)
 *        notmuch_message_add_tag (message, tags[i]);
 *
 *    notmuch_message_thaw (message);
 *
 * With freeze/thaw used like this, the message in the database is
 * guaranteed to have either the full set of original tag values, or
 * the full set of new tag values, but nothing in between.
 *
 * Imagine the example above without freeze/thaw and the operation
 * somehow getting interrupted. This could result in the message being
 * left with no tags if the interruption happened after
 * :c:func:`notmuch_message_remove_all_tags` but before
 * :c:func:`notmuch_message_add_tag`.
 *
 * :return:
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_SUCCESS`: Message successfully
 *     frozen.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_READ_ONLY_DATABASE`: Database was
 *     opened in read-only mode so message cannot be modified.
 */
notmuch_status_t
notmuch_message_freeze (notmuch_message_t *message);

/**
 * Thaw the current ``message``, synchronizing any changes that may have
 * occurred while ``message`` was frozen into the notmuch database.
 *
 * See :c:func:`notmuch_message_freeze` for an example of how to use
 * this function to safely provide tag changes.
 *
 * Multiple calls to freeze/thaw are valid and these calls with
 * "stack". That is there must be as many calls to thaw as to freeze
 * before a message is actually thawed.
 *
 * :return:
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_SUCCESS`: Message
 *     successfully thawed, (or at least its frozen count has
 *     successfully been reduced by 1).
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW`: An
 *     attempt was made to thaw an unfrozen message. That is, there have
 *     been an unbalanced number of calls to
 *     :c:func:`notmuch_message_freeze` and
 *     :c:func:`notmuch_message_thaw`.
 */
notmuch_status_t
notmuch_message_thaw (notmuch_message_t *message);

/**
 * Destroy a :c:type:`notmuch_message_t` object.
 *
 * It can be useful to call this function in the case of a single
 * query object with many messages in the result, (such as iterating
 * over the entire database). Otherwise, it's fine to never call this
 * function and there will still be no memory leaks. (The memory from
 * the messages get reclaimed when the containing query is destroyed.)
 */
void
notmuch_message_destroy (notmuch_message_t *message);

/**
 * Message Properties
 *
 * This interface provides the ability to attach arbitrary (key,value)
 * string pairs to a message, to remove such pairs, and to iterate
 * over them.  The caller should take some care as to what keys they
 * add or delete values for, as other subsystems or extensions may
 * depend on these properties.
 *
 * Please see :any:`notmuch-properties(7)` for more details about specific
 * properties and conventions around their use.
 *
 */

/**
 * Retrieve the value for a single property key
 *
 * ``value`` is set to a string owned by the message or ``NULL`` if there is
 * no such key. In the case of multiple values for the given key, the
 * first one is retrieved.
 *
 * :return:
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_NULL_POINTER`: ``value`` may
 *     not be ``NULL``.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_SUCCESS`: No error occurred.
 *
 * :since: libnotmuch 4.4 (notmuch 0.23)
 */
notmuch_status_t
notmuch_message_get_property (notmuch_message_t *message, const char *key, const char **value);

/**
 * Add a (key,value) pair to a message
 *
 * :return:
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_ILLEGAL_ARGUMENT`: ``key`` may
 *     not contain an '=' character.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_NULL_POINTER`: Neither
 *     ``key`` nor ``value`` may be ``NULL``.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_SUCCESS`: No error occurred.
 *
 * :since: libnotmuch 4.4 (notmuch 0.23)
 */
notmuch_status_t
notmuch_message_add_property (notmuch_message_t *message, const char *key, const char *value);

/**
 * Remove a (key,value) pair from a message.
 *
 * It is not an error to remove a non-existent (key,value) pair
 *
 * :return:
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_ILLEGAL_ARGUMENT`: ``key``
 *     may not contain an '=' character.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_NULL_POINTER`: Neither
 *     ``key`` nor ``value`` may be ``NULL``.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_SUCCESS`: No error occurred.
 *
 * :since: libnotmuch 4.4 (notmuch 0.23)
 */
notmuch_status_t
notmuch_message_remove_property (notmuch_message_t *message, const char *key, const char *value);

/**
 * Remove all (key,value) pairs from the given message.
 *
 * :param message: message to operate on.
 * :param key: key to delete properties for. If ``NULL``, delete
 *             properties for all keys
 *
 * :return:
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_READ_ONLY_DATABASE`:
 *     Database was opened in read-only mode so message cannot be
 *     modified.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_SUCCESS`: No error occurred.
 *
 * :since: libnotmuch 4.4 (notmuch 0.23)
 */
notmuch_status_t
notmuch_message_remove_all_properties (notmuch_message_t *message, const char *key);

/**
 * Remove all (prefix*,value) pairs from the given message
 *
 * :param message: message to operate on.
 * :param prefix: delete properties with keys that start with prefix.
 *                If ``NULL``, delete all properties
 *
 * :return:
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_READ_ONLY_DATABASE`: Database was
 *     opened in read-only mode so message cannot be modified.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_SUCCESS`: No error occurred.
 *
 * :since: libnotmuch 5.1 (notmuch 0.26)
 */
notmuch_status_t
notmuch_message_remove_all_properties_with_prefix (notmuch_message_t *message, const char *prefix);

/**
 * Opaque message property iterator
 */
typedef struct _notmuch_string_map_iterator notmuch_message_properties_t;

/**
 * Get the properties for ``message``, returning a
 * :c:type:`notmuch_message_properties_t` object which can be used to
 * iterate over all properties.
 *
 * The :c:type:`notmuch_message_properties_t` object is owned by the
 * message and as such, will only be valid for as long as the message
 * is valid, (which is until the query from which it derived is
 * destroyed).
 *
 * :param message: The message to examine
 * :param key: key or key prefix
 * :param exact: if ``TRUE``, require exact match with key. Otherwise
 *		 treat as prefix.
 *
 * Typical usage might be::
 *
 *     notmuch_message_properties_t *list;
 *
 *     for (list = notmuch_message_get_properties (message, "testkey1", TRUE);
 *          notmuch_message_properties_valid (list); notmuch_message_properties_move_to_next (list)) {
 *        printf("%s\n", notmuch_message_properties_value(list));
 *     }
 *
 *     notmuch_message_properties_destroy (list);
 *
 * Note that there's no explicit destructor needed for the
 * :c:type:`notmuch_message_properties_t` object. (For consistency, we
 * do provide a :c:func:`notmuch_message_properties_destroy` function,
 * but there's no good reason to call it if the message is about to be
 * destroyed).
 *
 * :since: libnotmuch 4.4 (notmuch 0.23)
 */
notmuch_message_properties_t *
notmuch_message_get_properties (notmuch_message_t *message, const char *key, notmuch_bool_t exact);

/**
 * Return the number of properties named "key" belonging to the specific message.
 *
 * :param message: The message to examine
 * :param key: key to count
 * :param count: The number of matching properties associated with this message.
 *
 * :return:
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_SUCCESS`: successful count,
 *     possibly some other error.
 *
 * :since: libnotmuch 5.2 (notmuch 0.27)
 */
notmuch_status_t
notmuch_message_count_properties (notmuch_message_t *message, const char *key, unsigned int *count);

/**
 * Is the given ``properties`` iterator pointing at a valid (key,value)
 * pair.
 *
 * When this function returns ``TRUE``,
 * notmuch_message_properties_{key,value} will return a valid string,
 * and :c:func:`notmuch_message_properties_move_to_next` will do what
 * it says. Whereas when this function returns ``FALSE``, calling any
 * of these functions results in undefined behaviour.
 *
 * See the documentation of :c:func:`notmuch_message_get_properties`
 * for example code showing how to iterate over a
 * :c:type:`notmuch_message_properties_t` object.
 *
 * :since: libnotmuch 4.4 (notmuch 0.23)
 */
notmuch_bool_t
notmuch_message_properties_valid (notmuch_message_properties_t *properties);

/**
 * Move the ``properties`` iterator to the next (key,value) pair
 *
 * If ``properties`` is already pointing at the last pair then the
 * iterator will be moved to a point just beyond that last pair,
 * (where :c:func:`notmuch_message_properties_valid` will return
 * ``FALSE``).
 *
 * See the documentation of :c:func:`notmuch_message_get_properties`
 * for example code showing how to iterate over a
 * :c:type:`notmuch_message_properties_t` object.
 *
 * :since: libnotmuch 4.4 (notmuch 0.23)
 */
void
notmuch_message_properties_move_to_next (notmuch_message_properties_t *properties);

/**
 * Return the key from the current (key,value) pair.
 *
 * this could be useful if iterating for a prefix
 *
 * :since: libnotmuch 4.4 (notmuch 0.23)
 */
const char *
notmuch_message_properties_key (notmuch_message_properties_t *properties);

/**
 * Return the value from the current (key,value) pair.
 *
 * This could be useful if iterating for a prefix.
 *
 * :since: libnotmuch 4.4 (notmuch 0.23)
 */
const char *
notmuch_message_properties_value (notmuch_message_properties_t *properties);


/**
 * Destroy a :c:type:`notmuch_message_properties_t` object.
 *
 * It's not strictly necessary to call this function. All memory from
 * the :c:type:`notmuch_message_properties_t` object will be reclaimed
 * when the containing message object is destroyed.
 *
 * :since: libnotmuch 4.4 (notmuch 0.23)
 */
void
notmuch_message_properties_destroy (notmuch_message_properties_t *properties);

/**
 * Is the given ``tags`` iterator pointing at a valid tag.
 *
 * When this function returns ``TRUE``, :c:func:`notmuch_tags_get`
 * will return a valid string. Whereas when this function returns
 * ``FALSE``, :c:func:`notmuch_tags_get` will return ``NULL``.
 *
 * See the documentation of :c:func:`notmuch_message_get_tags` for
 * example code showing how to iterate over a :c:type:`notmuch_tags_t`
 * object.
 */
notmuch_bool_t
notmuch_tags_valid (notmuch_tags_t *tags);

/**
 * Get the current tag from ``tags`` as a string.
 *
 * Note: The returned string belongs to ``tags`` and has a lifetime
 * identical to it (and the query to which it ultimately belongs).
 *
 * See the documentation of :c:func:`notmuch_message_get_tags` for
 * example code showing how to iterate over a :c:type:`notmuch_tags_t`
 * object.
 */
const char *
notmuch_tags_get (notmuch_tags_t *tags);

/**
 * Move the ``tags`` iterator to the next tag.
 *
 * If ``tags`` is already pointing at the last tag then the iterator
 * will be moved to a point just beyond that last tag, (where
 * :c:func:`notmuch_tags_valid` will return ``FALSE`` and
 * :c:func:`notmuch_tags_get` will return ``NULL``).
 *
 * See the documentation of :c:func:`notmuch_message_get_tags` for
 * example code showing how to iterate over a :c:type:`notmuch_tags_t`
 * object.
 */
void
notmuch_tags_move_to_next (notmuch_tags_t *tags);

/**
 * Destroy a :c:type:`notmuch_tags_t` object.
 *
 * It's not strictly necessary to call this function. All memory from
 * the :c:type:`notmuch_tags_t` object will be reclaimed when the
 * containing message or query objects are destroyed.
 */
void
notmuch_tags_destroy (notmuch_tags_t *tags);

/**
 * Store an mtime within the database for ``directory``.
 *
 * The ``directory`` should be an object retrieved from the database
 * with :c:func:`notmuch_database_get_directory` for a particular
 * path.
 *
 * The intention is for the caller to use the mtime to allow efficient
 * identification of new messages to be added to the database. The
 * recommended usage is as follows:
 *
 *   o Read the mtime of a directory from the filesystem
 *
 *   o Call index_file for all mail files in the directory
 *
 *   o Call :c:func:`notmuch_directory_set_mtime` with the mtime read from the
 *     filesystem.
 *
 * Then, when wanting to check for updates to the directory in the
 * future, the client can call :c:func:`notmuch_directory_get_mtime`
 * and know that it only needs to add files if the mtime of the
 * directory and files are newer than the stored timestamp.
 *
 * Note: The :c:func:`notmuch_directory_get_mtime` function does not
 * allow the caller to distinguish a timestamp of 0 from a
 * non-existent timestamp. So don't store a timestamp of 0 unless you
 * are comfortable with that.
 *
 * :return:
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_SUCCESS`: mtime successfully
 *     stored in database.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_XAPIAN_EXCEPTION`: A Xapian
 *     exception occurred, mtime not stored.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_READ_ONLY_DATABASE`: Database was
 *     opened in read-only mode so directory mtime cannot be modified.
 */
notmuch_status_t
notmuch_directory_set_mtime (notmuch_directory_t *directory,
			     time_t mtime);

/**
 * Get the mtime of a directory, (as previously stored with
 * :c:func:`notmuch_directory_set_mtime`).
 *
 * Returns 0 if no mtime has previously been stored for this
 * directory.
 */
time_t
notmuch_directory_get_mtime (notmuch_directory_t *directory);

/**
 * Get a :c:type:`notmuch_filenames_t` iterator listing all the
 * filenames of messages in the database within the given directory.
 *
 * The returned filenames will be the basename-entries only (not
 * complete paths).
 *
 * Returns ``NULL`` if it triggers a Xapian exception
 */
notmuch_filenames_t *
notmuch_directory_get_child_files (notmuch_directory_t *directory);

/**
 * Get a :c:type:`notmuch_filenames_t` iterator listing all the
 * filenames of sub-directories in the database within the given
 * directory.
 *
 * The returned filenames will be the basename-entries only (not
 * complete paths).
 *
 * Returns ``NULL`` if it triggers a Xapian exception
 */
notmuch_filenames_t *
notmuch_directory_get_child_directories (notmuch_directory_t *directory);

/**
 * Delete directory document from the database, and destroy the
 * :c:type:`notmuch_directory_t` object. Assumes any child directories
 * and files have been deleted by the caller.
 *
 * :since: libnotmuch 4.3 (notmuch 0.21)
 */
notmuch_status_t
notmuch_directory_delete (notmuch_directory_t *directory);

/**
 * Destroy a :c:type:`notmuch_directory_t` object.
 */
void
notmuch_directory_destroy (notmuch_directory_t *directory);

/**
 * Is the given ``filenames`` iterator pointing at a valid filename.
 *
 * When this function returns ``TRUE``,
 * :c:func:`notmuch_filenames_get` will return a valid string. Whereas
 * when this function returns ``FALSE``,
 * :c:func:`notmuch_filenames_get` will return ``NULL``.
 *
 * It is acceptable to pass ``NULL`` for ``filenames``, in which case
 * this function will always return ``FALSE``.
 */
notmuch_bool_t
notmuch_filenames_valid (notmuch_filenames_t *filenames);

/**
 * Get the current filename from ``filenames`` as a string.
 *
 * Note: The returned string belongs to ``filenames`` and has a
 * lifetime identical to it (and the directory to which it ultimately
 * belongs).
 *
 * It is acceptable to pass ``NULL`` for ``filenames``, in which case
 * this function will always return ``NULL``.
 */
const char *
notmuch_filenames_get (notmuch_filenames_t *filenames);

/**
 * Move the ``filenames`` iterator to the next filename.
 *
 * If ``filenames`` is already pointing at the last filename then the
 * iterator will be moved to a point just beyond that last filename,
 * (where :c:func:`notmuch_filenames_valid` will return ``FALSE`` and
 * :c:func:`notmuch_filenames_get` will return ``NULL``).
 *
 * It is acceptable to pass ``NULL`` for ``filenames``, in which case this
 * function will do nothing.
 */
void
notmuch_filenames_move_to_next (notmuch_filenames_t *filenames);

/**
 * Destroy a :c:type:`notmuch_filenames_t` object.
 *
 * It's not strictly necessary to call this function. All memory from
 * the :c:type:`notmuch_filenames_t` object will be reclaimed when the
 * containing directory object is destroyed.
 *
 * It is acceptable to pass ``NULL`` for ``filenames``, in which case this
 * function will do nothing.
 */
void
notmuch_filenames_destroy (notmuch_filenames_t *filenames);


/**
 * set config ``key`` to ``value``
 *
 * :return:
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_SUCCESS`
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_READ_ONLY_DATABASE`: Database was
 *     opened in read-only mode so message cannot be modified.
 *
 *   - :c:enumerator:`NOTMUCH_STATUS_XAPIAN_EXCEPTION`: an exception
 *     was thrown accessing the database.
 *
 * :since: libnotmuch 4.4 (notmuch 0.23)
 */
notmuch_status_t
notmuch_database_set_config (notmuch_database_t *db, const char *key, const char *value);

/**
 * retrieve config item ``key``, assign to  ``value``
 *
 * keys which have not been previously set with
 * :c:func:`notmuch_database_set_config` will return an empty string.
 *
 * return value is allocated by malloc and should be freed by the
 * caller.
 *
 * :since: libnotmuch 4.4 (notmuch 0.23)
 */
notmuch_status_t
notmuch_database_get_config (notmuch_database_t *db, const char *key, char **value);

/**
 * Create an iterator for all config items with keys matching a given prefix
 *
 * :since: libnotmuch 4.4 (notmuch 0.23)
 */
notmuch_status_t
notmuch_database_get_config_list (notmuch_database_t *db, const char *prefix,
				  notmuch_config_list_t **out);

/**
 * Is ``config_list`` iterator valid (i.e. _key, _value, _move_to_next can be called).
 *
 * :since: libnotmuch 4.4 (notmuch 0.23)
 */
notmuch_bool_t
notmuch_config_list_valid (notmuch_config_list_t *config_list);

/**
 * return key for current config pair
 *
 * return value is owned by the iterator, and will be destroyed by the
 * next call to :c:func:`notmuch_config_list_key` or
 * :c:func:`notmuch_config_list_destroy`.
 *
 * :since: libnotmuch 4.4 (notmuch 0.23)
 */
const char *
notmuch_config_list_key (notmuch_config_list_t *config_list);

/**
 * return ``value`` for current config pair
 *
 * return value is owned by the iterator, and will be destroyed by the
 * next call to :c:func:`notmuch_config_list_value` or
 * :c:func:`notmuch_config_list_destroy`
 *
 * :return: ``NULL`` for errors
 *
 * :since: libnotmuch 4.4 (notmuch 0.23)
 */
const char *
notmuch_config_list_value (notmuch_config_list_t *config_list);


/**
 * move ``config_list`` iterator to the next pair
 *
 * :since: libnotmuch 4.4 (notmuch 0.23)
 */
void
notmuch_config_list_move_to_next (notmuch_config_list_t *config_list);

/**
 * free any resources held by ``config_list``
 *
 * :since: libnotmuch 4.4 (notmuch 0.23)
 */
void
notmuch_config_list_destroy (notmuch_config_list_t *config_list);

/**
 * Configuration keys known to libnotmuch
 */
typedef enum {
    NOTMUCH_CONFIG_FIRST,
    NOTMUCH_CONFIG_DATABASE_PATH = NOTMUCH_CONFIG_FIRST,
    NOTMUCH_CONFIG_MAIL_ROOT,
    NOTMUCH_CONFIG_HOOK_DIR,
    NOTMUCH_CONFIG_BACKUP_DIR,
    NOTMUCH_CONFIG_EXCLUDE_TAGS,
    NOTMUCH_CONFIG_NEW_TAGS,
    NOTMUCH_CONFIG_NEW_IGNORE,
    NOTMUCH_CONFIG_SYNC_MAILDIR_FLAGS,
    NOTMUCH_CONFIG_PRIMARY_EMAIL,
    NOTMUCH_CONFIG_OTHER_EMAIL,
    NOTMUCH_CONFIG_USER_NAME,
    NOTMUCH_CONFIG_AUTOCOMMIT,
    NOTMUCH_CONFIG_LAST
} notmuch_config_key_t;

/**
 * get a configuration value from an open database.
 *
 * This value reflects all configuration information given at the time
 * the database was opened.
 *
 * :param notmuch: database
 * :param key: configuration key
 *
 * :return: ``NULL`` if ``key`` unknown or if no value is known for
 *   ``key``.  Otherwise returns a string owned by notmuch which
 *   should not be modified nor freed by the caller.
 *
 * :since: libnotmuch 5.4 (notmuch 0.32)
 */
const char *
notmuch_config_get (notmuch_database_t *notmuch, notmuch_config_key_t key);

/**
 * set a configuration value from in an open database.
 *
 * This value reflects all configuration information given at the time
 * the database was opened.
 *
 * :param notmuch: database open read/write
 * :param key: configuration key
 * :param val: configuration value
 *
 * :return: returns any return value for notmuch_database_set_config.
 *
 * :since: libnotmuch 5.4 (notmuch 0.32)
 */
notmuch_status_t
notmuch_config_set (notmuch_database_t *notmuch, notmuch_config_key_t key, const char *val);

/**
 * Returns an iterator for a ';'-delimited list of configuration values
 *
 * These values reflect all configuration information given at the
 * time the database was opened.
 *
 * :param notmuch: database
 * :param key: configuration key
 *
 * :return: ``NULL`` in case of error.
 *
 * :since: libnotmuch 5.4 (notmuch 0.32)
 */
notmuch_config_values_t *
notmuch_config_get_values (notmuch_database_t *notmuch, notmuch_config_key_t key);

/**
 * Returns an iterator for a ';'-delimited list of configuration values
 *
 * These values reflect all configuration information given at the
 * time the database was opened.
 *
 * :param notmuch: database
 * :param key: configuration key
 *
 * :return: ``NULL`` in case of error.
 *
 * :since: libnotmuch 5.4 (notmuch 0.32)
 */
notmuch_config_values_t *
notmuch_config_get_values_string (notmuch_database_t *notmuch, const char *key);

/**
 * Is the given 'config_values' iterator pointing at a valid element.
 *
 * :param values: iterator
 *
 * :return: ``FALSE`` if passed a ``NULL`` pointer, or the iterator is
 *   exhausted.
 *
 * :since: libnotmuch 5.4 (notmuch 0.32)
 */
notmuch_bool_t
notmuch_config_values_valid (notmuch_config_values_t *values);

/**
 * Get the current value from the 'values' iterator
 *
 * :param values: iterator
 *
 * :return: a string with the same lifetime as the iterator
 *
 * :since: libnotmuch 5.4 (notmuch 0.32)
 */
const char *
notmuch_config_values_get (notmuch_config_values_t *values);

/**
 * Move the 'values' iterator to the next element
 *
 * :param values: iterator
 *
 * :since: libnotmuch 5.4 (notmuch 0.32)
 *
 */
void
notmuch_config_values_move_to_next (notmuch_config_values_t *values);


/**
 * reset the 'values' iterator to the first element
 *
 * :param values: iterator. A ``NULL`` value is ignored.
 *
 * :since: libnotmuch 5.4 (notmuch 0.32)
 */
void
notmuch_config_values_start (notmuch_config_values_t *values);

/**
 * Destroy a config values iterator, along with any associated
 * resources.
 *
 * :param values: iterator
 *
 * :since: libnotmuch 5.4 (notmuch 0.32)
 */
void
notmuch_config_values_destroy (notmuch_config_values_t *values);


/**
 * Returns an iterator for a (key, value) configuration pairs
 *
 * :param notmuch: database
 * :param prefix: prefix for keys. Pass "" for all keys.
 *
 * :return: ``NULL`` in case of error.
 *
 * :since: libnotmuch 5.4 (notmuch 0.32)
 */
notmuch_config_pairs_t *
notmuch_config_get_pairs (notmuch_database_t *notmuch,
			  const char *prefix);

/**
 * Is the given 'config_pairs' iterator pointing at a valid element.
 *
 * :param pairs: iterator
 *
 * :return: ``FALSE`` if passed a ``NULL`` pointer, or the iterator is
 *   exhausted.
 *
 * :since: libnotmuch 5.4 (notmuch 0.32)
 */
notmuch_bool_t
notmuch_config_pairs_valid (notmuch_config_pairs_t *pairs);

/**
 * Move the 'config_pairs' iterator to the next element
 *
 * :param pairs: iterator
 *
 * :since: libnotmuch 5.4 (notmuch 0.32)
 */
void
notmuch_config_pairs_move_to_next (notmuch_config_pairs_t *pairs);

/**
 * Get the current key from the 'config_pairs' iterator
 *
 * :param pairs: iterator
 *
 * :return: a string with the same lifetime as the iterator
 *
 * :since: libnotmuch 5.4 (notmuch 0.32)
 */
const char *
notmuch_config_pairs_key (notmuch_config_pairs_t *pairs);

/**
 * Get the current value from the 'config_pairs' iterator
 *
 * :param pairs: iterator
 *
 * :return: a string with the same lifetime as the iterator
 *
 * :since: libnotmuch 5.4 (notmuch 0.32)
 */
const char *
notmuch_config_pairs_value (notmuch_config_pairs_t *pairs);

/**
 * Destroy a config_pairs iterator, along with any associated
 * resources.
 *
 * :param pairs: iterator
 *
 * :since: libnotmuch 5.4 (notmuch 0.32)
 */
void
notmuch_config_pairs_destroy (notmuch_config_pairs_t *pairs);

/**
 * get a configuration value from an open database as Boolean
 *
 * This value reflects all configuration information given at the time
 * the database was opened.
 *
 * :param notmuch: database
 * :param key: configuration key
 * :param val: configuration value, converted to Boolean
 *
 * :return: :c:enumerator:`NOTMUCH_STATUS_ILLEGAL_ARGUMENT` if either key is unknown
 *   or the corresponding value does not convert to Boolean.
 *
 * :since: libnotmuch 5.4 (notmuch 0.32)
 */
notmuch_status_t
notmuch_config_get_bool (notmuch_database_t *notmuch,
			 notmuch_config_key_t key,
			 notmuch_bool_t *val);

/**
 * return the path of the config file loaded, if any
 *
 * :return: ``NULL`` if no config file was loaded
 */
const char *
notmuch_config_path (notmuch_database_t *notmuch);

/**
 * get the current default indexing options for a given database.
 *
 * This object will survive until the database itself is destroyed,
 * but the caller may also release it earlier with
 * :c:func:`notmuch_indexopts_destroy`.
 *
 * This object represents a set of options on how a message can be
 * added to the index.  At the moment it is a featureless stub.
 *
 * :return: ``NULL`` in case of error
 *
 * :since: libnotmuch 5.1 (notmuch 0.26)
 */
notmuch_indexopts_t *
notmuch_database_get_default_indexopts (notmuch_database_t *db);

/**
 * Stating a policy about how to decrypt messages.
 *
 * See ``index.decrypt`` in :any:`notmuch-config(1)` for more details.
 */
typedef enum {
    NOTMUCH_DECRYPT_FALSE,
    NOTMUCH_DECRYPT_TRUE,
    NOTMUCH_DECRYPT_AUTO,
    NOTMUCH_DECRYPT_NOSTASH,
} notmuch_decryption_policy_t;

/**
 * Specify whether to decrypt encrypted parts while indexing.
 *
 * .. warning::
 *
 *   Be aware that the index is likely sufficient to reconstruct the
 *   cleartext of the message itself, so please ensure that the
 *   notmuch message index is adequately protected. DO NOT SET THIS
 *   FLAG TO ``TRUE`` without considering the security of your index.
 *
 * :since: libnotmuch 5.1 (notmuch 0.26)
 */
notmuch_status_t
notmuch_indexopts_set_decrypt_policy (notmuch_indexopts_t *indexopts,
				      notmuch_decryption_policy_t decrypt_policy);

/**
 * Return whether to decrypt encrypted parts while indexing.
 * see :c:func:`notmuch_indexopts_set_decrypt_policy`.
 *
 * :since: libnotmuch 5.1 (notmuch 0.26)
 */
notmuch_decryption_policy_t
notmuch_indexopts_get_decrypt_policy (const notmuch_indexopts_t *indexopts);

/**
 * Destroy a :c:type:`notmuch_indexopts_t` object.
 *
 * :since: libnotmuch 5.1 (notmuch 0.26)
 */
void
notmuch_indexopts_destroy (notmuch_indexopts_t *options);


/**
 * interrogate the library for compile time features
 *
 * :since: libnotmuch 4.4 (notmuch 0.23)
 */
notmuch_bool_t
notmuch_built_with (const char *name);

#pragma GCC visibility pop

NOTMUCH_END_DECLS

#endif
debug log:

solving 9d78ff64d7c7 ...
found 9d78ff64d7c7 in https://yhetil.org/notmuch/20211012185127.198348-6-jani@nikula.org/
found 700e9b7b25c1 in https://yhetil.org/notmuch/20211012185127.198348-5-jani@nikula.org/
found abbc5ace9d1b in https://yhetil.org/notmuch/20211012185127.198348-4-jani@nikula.org/
found ca5878a949bc in https://yhetil.org/notmuch/20211013140217.219926-1-jani@nikula.org/ ||
	https://yhetil.org/notmuch/20211012185127.198348-3-jani@nikula.org/
found 546643e80cbb in notmuch.git
preparing index
index prepared:
100644 546643e80cbb66364b2502f6b8046291959d9d8b	lib/notmuch.h

applying [1/5] https://yhetil.org/notmuch/20211013140217.219926-1-jani@nikula.org/
diff --git a/lib/notmuch.h b/lib/notmuch.h
index 546643e80cbb..ca5878a949bc 100644

Checking patch lib/notmuch.h...
Applied patch lib/notmuch.h cleanly.

skipping https://yhetil.org/notmuch/20211012185127.198348-3-jani@nikula.org/ for ca5878a949bc
index at:
100644 ca5878a949bc0de86012fa9ef18360fd4bd669c2	lib/notmuch.h

applying [2/5] https://yhetil.org/notmuch/20211012185127.198348-4-jani@nikula.org/
diff --git a/lib/notmuch.h b/lib/notmuch.h
index ca5878a949bc..abbc5ace9d1b 100644


applying [3/5] https://yhetil.org/notmuch/20211012185127.198348-5-jani@nikula.org/
diff --git a/lib/notmuch.h b/lib/notmuch.h
index abbc5ace9d1b..700e9b7b25c1 100644


applying [4/5] https://yhetil.org/notmuch/20211012185127.198348-6-jani@nikula.org/
diff --git a/lib/notmuch.h b/lib/notmuch.h
index 700e9b7b25c1..9d78ff64d7c7 100644

Checking patch lib/notmuch.h...
Applied patch lib/notmuch.h cleanly.
Checking patch lib/notmuch.h...
Applied patch lib/notmuch.h cleanly.
Checking patch lib/notmuch.h...
Applied patch lib/notmuch.h cleanly.

index at:
100644 9d78ff64d7c71de9f0b50b2372e21c481736f894	lib/notmuch.h

Code repositories for project(s) associated with this inbox:

	notmuch.git.git (no URL configured)

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).