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
#![allow(dead_code, non_camel_case_types)]
//! Re-presentation of the notmuch C API.
use libc::{c_char, c_double, c_int, c_uint, c_ulong, c_void, time_t};
use error::{Error, Result};
use std::borrow::Cow;
use std::ffi::CStr;
use std::{error, fmt, ptr, str};
use utils::ToStr;
notmuch_enum! {
#[repr(C)]
#[derive(Debug, Eq, PartialEq, Clone, Copy)]
pub enum notmuch_status_t => Status {
NOTMUCH_STATUS_SUCCESS => Success,
NOTMUCH_STATUS_OUT_OF_MEMORY => OutOfMemory,
NOTMUCH_STATUS_READ_ONLY_DATABASE => ReadOnlyDatabase,
NOTMUCH_STATUS_XAPIAN_EXCEPTION => XapianException,
NOTMUCH_STATUS_FILE_ERROR => FileError,
NOTMUCH_STATUS_FILE_NOT_EMAIL => FileNotEmail,
NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID => DuplicateMessageID,
NOTMUCH_STATUS_NULL_POINTER => NullPointer,
NOTMUCH_STATUS_TAG_TOO_LONG => TagTooLong,
NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW => UnbalancedFreezeThaw,
NOTMUCH_STATUS_UNBALANCED_ATOMIC => UnbalancedAtomic,
NOTMUCH_STATUS_UNSUPPORTED_OPERATION => UnsupportedOperation,
NOTMUCH_STATUS_UPGRADE_REQUIRED => UpgradeRequired,
NOTMUCH_STATUS_PATH_ERROR => PathError,
NOTMUCH_STATUS_IGNORED => Ignored,
NOTMUCH_STATUS_ILLEGAL_ARGUMENT => IllegalArgument,
NOTMUCH_STATUS_MALFORMED_CRYPTO_PROTOCOL => MalformedCryptoProtocol,
NOTMUCH_STATUS_FAILED_CRYPTO_CONTEXT_CREATION => FailedCryptoContextCreation,
NOTMUCH_STATUS_UNKNOWN_CRYPTO_PROTOCOL => UnknownCryptoProtocol,
NOTMUCH_STATUS_NO_CONFIG => NoConfig,
NOTMUCH_STATUS_NO_DATABASE => NoDatabase,
NOTMUCH_STATUS_DATABASE_EXISTS => DatabaseExists,
NOTMUCH_STATUS_BAD_QUERY_SYNTAX => BadQuerySyntax,
NOTMUCH_STATUS_NO_MAIL_ROOT => NoMailRoot,
// Not an actual status value. Just a way to find out how many
// valid status values there are.
NOTMUCH_STATUS_LAST_STATUS => LastStatus
}
}
impl notmuch_status_t {
pub fn is_ok(self) -> bool {
match self {
notmuch_status_t::NOTMUCH_STATUS_SUCCESS
| notmuch_status_t::NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID => true,
_ => false,
}
}
pub fn is_err(self) -> bool {
!self.is_ok()
}
pub fn as_result(self) -> Result<()> {
if self.is_ok() {
Ok(())
} else {
Err(Error::NotmuchError(Status::from(self)))
}
}
pub fn as_verbose_result(self, error_message_cstr: *mut c_char) -> Result<()> {
let error_message = if error_message_cstr == ptr::null_mut() {
None
} else {
unsafe {
let msg = Some(
CStr::from_ptr(error_message_cstr)
.to_string_lossy()
.to_string(),
);
libc::free(error_message_cstr as *mut c_void);
msg
}
};
if self.is_ok() {
Ok(())
} else {
Err(Error::NotmuchVerboseError(
Status::from(self),
error_message.unwrap_or("[no info]".to_string()),
))
}
}
}
impl ToStr for Status {
fn to_str<'a>(&self) -> std::result::Result<&'a str, str::Utf8Error> {
unsafe { notmuch_status_to_string((*self).into()) }.to_str()
}
fn to_str_unchecked<'a>(&self) -> &'a str {
unsafe { notmuch_status_to_string((*self).into()) }.to_str_unchecked()
}
fn to_string_lossy<'a>(&self) -> Cow<'a, str> {
unsafe { notmuch_status_to_string((*self).into()) }.to_string_lossy()
}
}
impl fmt::Display for Status {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "{}", self.to_str().unwrap())
}
}
impl error::Error for Status {
fn description(&self) -> &str {
self.to_str().unwrap()
}
}
notmuch_enum! {
#[repr(C)]
#[derive(Debug, Eq, PartialEq, Clone, Copy)]
pub enum notmuch_database_mode_t => DatabaseMode {
NOTMUCH_DATABASE_MODE_READ_ONLY => ReadOnly,
NOTMUCH_DATABASE_MODE_READ_WRITE => ReadWrite
}
}
notmuch_enum! {
#[repr(C)]
#[derive(Debug, Eq, PartialEq, Clone, Copy)]
pub enum notmuch_sort_t => Sort {
NOTMUCH_SORT_OLDEST_FIRST => OldestFirst,
NOTMUCH_SORT_NEWEST_FIRST => NewestFirst,
NOTMUCH_SORT_MESSAGE_ID => MessageID,
NOTMUCH_SORT_UNSORTED => Unsorted
}
}
notmuch_enum! {
#[repr(C)]
#[derive(Copy, Clone, Debug)]
pub enum notmuch_exclude_t => Exclude {
NOTMUCH_EXCLUDE_FLAG => Flag,
NOTMUCH_EXCLUDE_TRUE => True,
NOTMUCH_EXCLUDE_FALSE => False,
NOTMUCH_EXCLUDE_ALL => All
}
}
notmuch_enum! {
#[repr(C)]
#[derive(Debug, Eq, PartialEq, Clone, Copy)]
pub enum notmuch_message_flag_t => MessageFlag {
NOTMUCH_MESSAGE_FLAG_MATCH => Match,
NOTMUCH_MESSAGE_FLAG_EXCLUDED => Excluded,
NOTMUCH_MESSAGE_FLAG_GHOST => Ghost
}
}
notmuch_enum! {
#[repr(C)]
#[derive(Debug, Eq, PartialEq, Clone, Copy)]
pub enum notmuch_decryption_policy_t => DecryptionPolicy {
NOTMUCH_DECRYPT_FALSE => False,
NOTMUCH_DECRYPT_TRUE => True,
NOTMUCH_DECRYPT_AUTO => Auto,
NOTMUCH_DECRYPT_NOSTASH => NoStash
}
}
notmuch_enum! {
#[repr(C)]
#[derive(Debug, Eq, PartialEq, Clone, Copy)]
pub enum notmuch_config_key_t => ConfigKey {
NOTMUCH_CONFIG_DATABASE_PATH => DatabasePath,
NOTMUCH_CONFIG_MAIL_ROOT => MailRoot,
NOTMUCH_CONFIG_HOOK_DIR => HookDir,
NOTMUCH_CONFIG_BACKUP_DIR => BackupDir,
NOTMUCH_CONFIG_EXCLUDE_TAGS => ExcludeTags,
NOTMUCH_CONFIG_NEW_TAGS => NewTags,
NOTMUCH_CONFIG_NEW_IGNORE => NewIgnore,
NOTMUCH_CONFIG_SYNC_MAILDIR_FLAGS => MaildirFlags,
NOTMUCH_CONFIG_PRIMARY_EMAIL => PrimaryEmail,
NOTMUCH_CONFIG_OTHER_EMAIL => OtherEmail,
NOTMUCH_CONFIG_USER_NAME => UserName,
NOTMUCH_CONFIG_AUTOCOMMIT => Autocommit,
NOTMUCH_CONFIG_EXTRA_HEADERS => ExtraHeaders
}
}
#[repr(C)]
pub struct notmuch_database_t(c_void);
#[repr(C)]
pub struct notmuch_query_t(c_void);
#[repr(C)]
pub struct notmuch_threads_t(c_void);
#[repr(C)]
pub struct notmuch_thread_t(c_void);
#[repr(C)]
pub struct notmuch_messages_t(c_void);
#[repr(C)]
pub struct notmuch_message_t(c_void);
#[repr(C)]
pub struct notmuch_tags_t(c_void);
#[repr(C)]
pub struct notmuch_directory_t(c_void);
#[repr(C)]
pub struct notmuch_filenames_t(c_void);
#[repr(C)]
pub struct notmuch_message_properties_t(c_void);
#[repr(C)]
pub struct notmuch_config_list_t(c_void);
#[repr(C)]
pub struct notmuch_config_values_t(c_void);
#[repr(C)]
pub struct notmuch_config_pairs_t(c_void);
#[repr(C)]
pub struct notmuch_indexopts_t(c_void);
pub type notmuch_compact_status_cb_t = extern "C" fn(message: *const c_char, closure: *mut c_void);
pub type notmuch_database_upgrade_cb_t = extern "C" fn(closure: *mut c_void, progress: c_double);
pub type notmuch_bool_t = c_int;
pub const TRUE: notmuch_bool_t = 1;
pub const FALSE: notmuch_bool_t = 0;
#[link(name = "notmuch")]
extern "C" {
/// Get a string representation of a `notmuch_status_t` value.
///
/// The result is read-only.
pub fn notmuch_status_to_string(status: notmuch_status_t) -> *const c_char;
/// 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 `notmuch_database_create`, the returned
/// database will be open so the caller should call
/// `notmuch_database_destroy` when finished with it.
///
/// The database will not yet have any data in it
/// (`notmuch_database_create` itself is a very cheap function). Messages
/// contained within 'path' can be added to the database by calling
/// `notmuch_database_add_message`.
///
/// In case of any failure, this function returns an error status and
/// sets *database to NULL (after printing an error message on stderr).
///
/// Return value:
///
/// * `notmuch_status_t::SUCCESS`: Successfully created the database.
///
/// * `notmuch_status_t::NULL_POINTER`: The given 'path' argument is NULL.
///
/// * `notmuch_status_t::OUT_OF_MEMORY`: Out of memory.
///
/// * `notmuch_status_t::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.
///
/// * `notmuch_status_t::XAPIAN_EXCEPTION`: A Xapian exception occurred.
pub fn notmuch_database_create(
path: *const c_char,
database: *mut *mut notmuch_database_t,
) -> notmuch_status_t;
/// Like `notmuch_database_create`, except optionally return an error
/// message. This message is allocated by malloc and should be freed by
/// the caller.
pub fn notmuch_database_create_verbose(
path: *const c_char,
database: *mut *mut notmuch_database_t,
error_message: *mut *const c_char,
) -> notmuch_status_t;
/// Open an existing notmuch database located at 'path'.
///
/// The database should have been created at some time in the past,
/// (not necessarily by this process), by calling
/// notmuch_database_create with 'path'. By default the database should be
/// opened for reading only. In order to write to the database you need to
/// pass the `notmuch_database_mode_t::READ_WRITE` mode.
///
/// An existing notmuch database can be identified by the presence of a
/// directory named ".notmuch" below 'path'.
///
/// The caller should call notmuch_database_destroy when finished with
/// this database.
///
/// In case of any failure, this function returns an error status and
/// sets *database to NULL (after printing an error message on stderr).
///
/// Return value:
///
/// * `notmuch_status_t::SUCCESS`: Successfully opened the database.
///
/// * `notmuch_status_t::NULL_POINTER`: The given 'path' argument is NULL.
///
/// * `notmuch_status_t::OUT_OF_MEMORY`: Out of memory.
///
/// * `notmuch_status_t::FILE_ERROR`: An error occurred trying to open the
/// database file (such as permission denied, or file not found,
/// etc.), or the database version is unknown.
///
/// * `notmuch_status_t::XAPIAN_EXCEPTION`: A Xapian exception occurred.
pub fn notmuch_database_open(
path: *const c_char,
mode: notmuch_database_mode_t,
database: *mut *mut notmuch_database_t,
) -> notmuch_status_t;
/// Like notmuch_database_open, except optionally return an error
/// message. This message is allocated by malloc and should be freed by
/// the caller.
pub fn notmuch_database_open_verbose(
path: *const c_char,
mode: notmuch_database_mode_t,
database: *mut *mut notmuch_database_t,
error_message: *mut *mut c_char,
) -> notmuch_status_t;
/// Open an existing notmuch database located at `database_path`, using
/// configuration in `config_path`.
///
/// * `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
/// `notmuch_database_open_verbose` pre-0.32).
///
/// * `mode`: Mode to open database. Use one of
/// `notmuch_database_mode_t::READ_WRITE` or
/// `notmuch_database_mode_t::READ_ONLY`.
///
/// * `config_path`: Path to config file.
///
/// Config file is key-value, with mandatory sections. See
/// `notmuch-config(5)` for more information. The key-value pair
/// overrides the corresponding configuration data stored in the
/// database (see `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.
///
/// * `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.
///
/// * `database`: Pointer to database object. May not be `NULL`.
///
/// The caller should call `notmuch_database_destroy` when finished with
/// this database.
///
/// In case of any failure, this function returns an error status and
/// sets `*database` to `NULL`.
///
/// * `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 Value:
///
/// * `notmuch_status_t::SUCCESS`: Successfully opened the database.
///
/// * `notmuch_status_t::NULL_POINTER`: The given `database` argument is
/// `NULL`.
///
/// * `notmuch_status_t::NO_CONFIG`: No config file was found. Fatal.
///
/// * `notmuch_status_t::OUT_OF_MEMORY`: Out of memory.
///
/// * `notmuch_status_t::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.
///
/// * `notmuch_status_t::XAPIAN_EXCEPTION`: A Xapian exception occurred.
///
/// Since libnotmuch 5.4 (notmuch 0.32)
pub fn notmuch_database_open_with_config(
database_path: *const c_char,
mode: notmuch_database_mode_t,
config_path: *const c_char,
profile: *const c_char,
database: *mut *mut notmuch_database_t,
error_message: *mut *mut c_char,
) -> notmuch_status_t;
/// Retrieve last status string for given database.
pub fn notmuch_database_status_string(notmuch: *mut notmuch_database_t) -> *const c_char;
/// Commit changes and close the given notmuch database.
///
/// After `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
/// `notmuch_status_t::XAPIAN_EXCEPTION`. The only further operation
/// permitted on the database itself is to call `notmuch_database_destroy`.
///
/// `notmuch_database_close` can be called multiple times. Later calls have
/// no effect.
///
/// For writable databases, `notmuch_database_close` commits all changes
/// to disk before closing the database. If the caller is currently in
/// an atomic section (there was a `notmuch_database_begin_atomic`
/// without a matching `notmuch_database_end_atomic`), this will discard
/// changes made in that atomic section (but still commit changes made
/// prior to entering the atomic section).
///
/// Return value:
///
/// * `notmuch_status_t::SUCCESS`: Successfully closed the database.
///
/// * `notmuch_status_t::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.
pub fn notmuch_database_close(database: *mut notmuch_database_t) -> notmuch_status_t;
/// Compact a notmuch database, backing up the original database to the
/// given path.
///
/// The database will be opened with notmuch_database_mode_t::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.
pub fn notmuch_database_compact(
path: *const c_char,
backup_path: *const c_char,
status_cb: Option<notmuch_compact_status_cb_t>,
closure: *mut c_void,
) -> notmuch_status_t;
/// Destroy the notmuch database, closing it if necessary and freeing
/// all associated resources.
///
/// Return value as in `notmuch_database_close` if the database was open;
/// `notmuch_database_destroy` itself has no failure modes.
pub fn notmuch_database_destroy(database: *mut notmuch_database_t) -> notmuch_status_t;
/// 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.
pub fn notmuch_database_get_path(database: *mut notmuch_database_t) -> *const c_char;
/// Return the database format version of the given database.
pub fn notmuch_database_get_version(database: *mut notmuch_database_t) -> c_uint;
/// Can the database be upgraded to a newer database version?
///
/// If this function returns TRUE, then the caller may call
/// `notmuch_database_upgrade` to upgrade the database. If the caller
/// does not upgrade an out-of-date database, then some functions may
/// fail with `notmuch_status_t::UPGRADE_REQUIRED`. This always returns
/// FALSE for a read-only database because there's no way to upgrade a
/// read-only database.
pub fn notmuch_database_needs_upgrade(database: *mut notmuch_database_t) -> notmuch_bool_t;
/// 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
/// (`notmuch_database_needs_upgrade`) and if so, upgrade with this
/// function before making any modifications. If
/// `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.
pub fn notmuch_database_upgrade(
database: *mut notmuch_database_t,
progress_notify: Option<extern "C" fn(closure: *mut c_void, progress: c_double)>,
closure: *mut c_void,
) -> notmuch_status_t;
/// Begin an atomic database operation.
///
/// Any modifications performed between a successful begin and a
/// `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 value:
///
/// * `notmuch_status_t::SUCCESS`: Successfully entered atomic section.
///
/// * `notmuch_status_t::XAPIAN_EXCEPTION`: A Xapian exception occurred;
/// atomic section not entered.
pub fn notmuch_database_begin_atomic(notmuch: *mut notmuch_database_t) -> notmuch_status_t;
/// Indicate the end of an atomic database operation.
///
/// Return value:
///
/// * `notmuch_status_t::SUCCESS`: Successfully completed atomic section.
///
/// * `notmuch_status_t::XAPIAN_EXCEPTION`: A Xapian exception occurred;
/// atomic section not ended.
///
/// * `notmuch_status_t::UNBALANCED_ATOMIC`: The database is not currently in
/// an atomic section.
pub fn notmuch_database_end_atomic(notmuch: *mut notmuch_database_t) -> notmuch_status_t;
/// 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.
pub fn notmuch_database_get_revision(
notmuch: *mut notmuch_database_t,
uuid: *mut *const c_char,
) -> c_ulong;
/// Retrieve a directory object from the database for 'path'.
///
/// Here, 'path' should be a path relative to the path of 'database'
/// (see `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 `notmuch_status_t::SUCCESS` and sets *directory to NULL.
///
/// Otherwise the returned directory object is owned by the database
/// and as such, will only be valid until `notmuch_database_destroy` is
/// called.
///
/// Return value:
///
/// * `notmuch_status_t::SUCCESS`: Successfully retrieved directory.
///
/// * `notmuch_status_t::NULL_POINTER`: The given 'directory' argument is NULL.
///
/// * `notmuch_status_t::XAPIAN_EXCEPTION`: A Xapian exception occurred;
/// directory not retrieved.
///
/// * `notmuch_status_t::UPGRADE_REQUIRED`: The caller must upgrade the
/// database to use this function.
pub fn notmuch_database_get_directory(
database: *mut notmuch_database_t,
path: *const c_char,
directory: *mut *mut notmuch_directory_t,
) -> notmuch_status_t;
/// 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 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
/// (NOTMUCH_STATUS_SUCCESS or 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
/// notmuch_message_destroy when done with the message. On any failure
/// '*message' will be set to NULL.
///
/// Return value:
///
/// NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
///
/// NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
/// message not added.
///
/// 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.
///
/// 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.
///
/// NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
/// like an email message. Nothing added to the database.
///
/// NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
/// mode so no message can be added.
///
/// NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
/// database to use this function.
///
/// @since libnotmuch 5.1 (notmuch 0.26)
pub fn notmuch_database_index_file(
database: *mut notmuch_database_t,
filename: *const c_char,
indexopts: *mut notmuch_indexopts_t,
message: *mut *mut notmuch_message_t,
) -> notmuch_status_t;
/// Deprecated alias for notmuch_database_index_file called with
/// NULL indexopts.
///
/// @deprecated Deprecated as of libnotmuch 5.1 (notmuch 0.26). Please
/// use notmuch_database_index_file instead.
pub fn notmuch_database_add_message(
database: *mut notmuch_database_t,
filename: *const c_char,
message: *mut *mut notmuch_message_t,
) -> notmuch_status_t;
/// 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 value:
///
/// * `notmuch_status_t::SUCCESS`: The last filename was removed and the
/// message was removed from the database.
///
/// * `notmuch_status_t::XAPIAN_EXCEPTION`: A Xapian exception occurred,
/// message not removed.
///
/// * `notmuch_status_t::DUPLICATE_MESSAGE_ID`: This filename was removed but
/// the message persists in the database with at least one other
/// filename.
///
/// * `notmuch_status_t::READ_ONLY_DATABASE`: Database was opened in read-only
/// mode so no message can be removed.
///
/// * `notmuch_status_t::UPGRADE_REQUIRED`: The caller must upgrade the
/// database to use this function.
pub fn notmuch_database_remove_message(
database: *mut notmuch_database_t,
filename: *const c_char,
) -> notmuch_status_t;
/// Find a message with the given message_id.
///
/// If a message with the given message_id is found then, on successful return
/// (`notmuch_status_t::SUCCESS`) '*message' will be initialized to a message
/// object. The caller should call `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 `notmuch_status_t::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 value:
///
/// * `notmuch_status_t::SUCCESS`: Successful return, check '*message'.
///
/// * `notmuch_status_t::NULL_POINTER`: The given 'message' argument is NULL
///
/// * `notmuch_status_t::OUT_OF_MEMORY`: Out of memory, creating message object
///
/// * `notmuch_status_t::XAPIAN_EXCEPTION`: A Xapian exception occurred
pub fn notmuch_database_find_message(
database: *mut notmuch_database_t,
message_id: *const c_char,
message: *mut *mut notmuch_message_t,
) -> notmuch_status_t;
/// Find a message with the given filename.
///
/// If the database contains a message with the given filename then, on
/// successful return (`notmuch_status_t::SUCCESS`) '*message' will be initialized to
/// a message object. The caller should call `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 `notmuch_status_t::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 value:
///
/// * `notmuch_status_t::SUCCESS`: Successful return, check '*message'
///
/// * `notmuch_status_t::NULL_POINTER`: The given 'message' argument is NULL
///
/// * `notmuch_status_t::OUT_OF_MEMORY`: Out of memory, creating the message object
///
/// * `notmuch_status_t::XAPIAN_EXCEPTION`: A Xapian exception occurred
///
/// * `notmuch_status_t::UPGRADE_REQUIRED`: The caller must upgrade the
/// database to use this function.
pub fn notmuch_database_find_message_by_filename(
database: *mut notmuch_database_t,
filename: *const c_char,
message: *mut *mut notmuch_message_t,
) -> notmuch_status_t;
/// 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.
pub fn notmuch_database_get_all_tags(db: *mut notmuch_database_t) -> *mut notmuch_tags_t;
/// Create a new query for 'database'.
///
/// Here, 'database' should be an open database, (see
/// notmuch_database_open and `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 `notmuch_query_set_sort` for controlling the order of results.
/// See notmuch_query_search_messages and `notmuch_query_search_threads`
/// to actually execute the query.
///
/// User should call `notmuch_query_destroy` when finished with this
/// query.
///
/// Will return NULL if insufficient memory is available.
pub fn notmuch_query_create(
database: *mut notmuch_database_t,
query_string: *const c_char,
) -> *mut notmuch_query_t;
/// Return the query_string of this query. See `notmuch_query_create`.
pub fn notmuch_query_get_query_string(query: *mut notmuch_query_t) -> *const c_char;
/// Return the notmuch database of this query. See `notmuch_query_create`.
pub fn notmuch_query_get_database(query: *const notmuch_query_t) -> *mut notmuch_database_t;
/// Specify whether to omit excluded results or simply flag them. By
/// default, this is set to TRUE.
///
/// If set to TRUE or ALL, `notmuch_query_search_messages` will omit excluded
/// messages from the results, and `notmuch_query_search_threads` will omit
/// threads that match only in excluded messages. If set to TRUE,
/// `notmuch_query_search_threads` will include all messages in threads that
/// match in at least one non-excluded message. Otherwise, if set to ALL,
/// `notmuch_query_search_threads` will omit excluded messages from all threads.
///
/// If set to FALSE or FLAG then both `notmuch_query_search_messages` and
/// `notmuch_query_search_threads` will return all matching
/// messages/threads regardless of exclude status. If set to FLAG then
/// the exclude flag will be set for any excluded message that is
/// returned by `notmuch_query_search_messages`, and the thread counts
/// for threads returned by `notmuch_query_search_threads` will be the
/// number of non-excluded messages/matches. Otherwise, if set to
/// FALSE, then the exclude status is completely ignored.
///
/// The performance difference when calling
/// `notmuch_query_search_messages` should be relatively small (and both
/// should be very fast). However, in some cases,
/// `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.
pub fn notmuch_query_set_omit_excluded(
query: *mut notmuch_query_t,
omit_excluded: notmuch_exclude_t,
);
/// Specify the sorting desired for this query.
pub fn notmuch_query_set_sort(query: *mut notmuch_query_t, sort: notmuch_sort_t);
/// Return the sort specified for this query. See
/// `notmuch_query_set_sort`.
pub fn notmuch_query_get_sort(query: *mut notmuch_query_t) -> notmuch_sort_t;
/// Add a tag that will be excluded from the query results by default.
/// This exclusion will be overridden if this tag appears explicitly in
/// the query.
pub fn notmuch_query_add_tag_exclude(query: *mut notmuch_query_t, tag: *const c_char) -> notmuch_status_t;
/// Execute a query for threads, returning a `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
/// `notmuch_query_destroy`.
///
/// Typical usage might be:
///
/// ```ignore
/// notmuch_query_t *query;
/// notmuch_threads_t *threads;
/// notmuch_thread_t *thread;
///
/// query = notmuch_query_create (database, query_string);
///
/// for (threads = notmuch_query_search_threads (query);
/// 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 `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 `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
/// `notmuch_threads_t` object. (For consistency, we do provide a
/// `notmuch_threads_destroy` function, but there's no good reason
/// to call it if the query is about to be destroyed).
///
/// @since libnotmuch 4.2 (notmuch 0.20)
pub fn notmuch_query_search_threads(
query: *mut notmuch_query_t,
out: *mut *mut notmuch_threads_t,
) -> notmuch_status_t;
/// Execute a query for messages, returning a `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 `notmuch_query_destroy`.
///
/// Typical usage might be:
///
/// ```ignore
/// 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 `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
/// `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
/// `notmuch_messages_t` object. (For consistency, we do provide a
/// `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)
pub fn notmuch_query_search_messages(
query: *mut notmuch_query_t,
out: *mut *mut notmuch_messages_t,
) -> notmuch_status_t;
/// Destroy a `notmuch_query_t` along with any associated resources.
///
/// This will in turn destroy any `notmuch_threads_t` and
/// `notmuch_messages_t` objects generated by this query, (and in
/// turn any notmuch_thread_t and `notmuch_message_t` objects generated
/// from those results, etc.), if such objects haven't already been
/// destroyed.
pub fn notmuch_query_destroy(query: *mut notmuch_query_t);
/// Is the given 'threads' iterator pointing at a valid thread.
///
/// When this function returns TRUE, `notmuch_threads_get` will return a
/// valid object. Whereas when this function returns FALSE,
/// `notmuch_threads_get` will return NULL.
///
/// If passed a NULL pointer, this function returns FALSE
///
/// See the documentation of `notmuch_query_search_threads` for example
/// code showing how to iterate over a `notmuch_threads_t` object.
pub fn notmuch_threads_valid(threads: *mut notmuch_threads_t) -> notmuch_bool_t;
/// Get the current thread from 'threads' as a `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 `notmuch_query_search_threads` for example
/// code showing how to iterate over a `notmuch_threads_t` object.
///
/// If an out-of-memory situation occurs, this function will return
/// NULL.
pub fn notmuch_threads_get(threads: *mut notmuch_threads_t) -> *mut notmuch_thread_t;
/// 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 `notmuch_threads_valid` will return FALSE and
/// `notmuch_threads_get` will return NULL).
///
/// See the documentation of `notmuch_query_search_threads` for example
/// code showing how to iterate over a `notmuch_threads_t` object.
pub fn notmuch_threads_move_to_next(threads: *mut notmuch_threads_t);
/// Destroy a `notmuch_threads_t` object.
///
/// It's not strictly necessary to call this function. All memory from
/// the `notmuch_threads_t` object will be reclaimed when the
/// containing query object is destroyed.
pub fn notmuch_threads_destroy(threads: *mut notmuch_threads_t);
/// Return the number of messages matching a search.
///
/// This function performs a search and returns the number of matching
/// messages.
///
/// @returns
///
/// `notmuch_status_t::SUCCESS`: query completed successfully.
///
/// `notmuch_status_t::XAPIAN_EXCEPTION`: a Xapian exception occured. The
/// value of *count is not defined.
///
/// @since libnotmuch 4.3 (notmuch 0.21)
pub fn notmuch_query_count_messages(
query: *mut notmuch_query_t,
count: *mut c_uint,
) -> notmuch_status_t;
/// 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
/// `notmuch_query_count_messages`{_st}().
///
/// @returns
///
/// * `notmuch_status_t::OUT_OF_MEMORY`: Memory allocation failed. The value
/// of *count is not defined
/// * `notmuch_status_t::SUCCESS`: query completed successfully.
///
/// * `notmuch_status_t::XAPIAN_EXCEPTION`: a Xapian exception occured. The
/// value of *count is not defined.
///
/// @since libnotmuch 4.3 (notmuch 0.21)
pub fn notmuch_query_count_threads(
query: *mut notmuch_query_t,
count: *mut c_uint,
) -> notmuch_status_t;
/// 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 `notmuch_thread_destroy` or until
/// the query from which it derived is destroyed).
pub fn notmuch_thread_get_thread_id(thread: *mut notmuch_thread_t) -> *const c_char;
/// Get the total number of messages in 'thread'.
///
/// This count consists of all messages in the database belonging to
/// this thread. Contrast with `notmuch_thread_get_matched_messages`().
pub fn notmuch_thread_get_total_messages(thread: *mut notmuch_thread_t) -> c_int;
/// Get the total number of files in 'thread'.
///
/// This sums notmuch_message_count_files over all messages in the
/// thread
/// @returns Non-negative integer
/// @since libnotmuch 5.0 (notmuch 0.25)
///
pub fn notmuch_thread_get_total_files(thread: *mut notmuch_thread_t) -> c_int;
/// Get a `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.
pub fn notmuch_thread_get_toplevel_messages(
thread: *mut notmuch_thread_t,
) -> *mut notmuch_messages_t;
/// Get a `notmuch_thread_t` iterator for all messages in 'thread' in
/// oldest-first order.
///
/// The returned list will be destroyed when the thread is destroyed.
pub fn notmuch_thread_get_messages(thread: *mut notmuch_thread_t) -> *mut notmuch_messages_t;
/// 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
/// `notmuch_query_add_tag_exclude`). Contrast with
/// `notmuch_thread_get_total_messages`() .
pub fn notmuch_thread_get_matched_messages(thread: *mut notmuch_thread_t) -> c_int;
/// 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 `notmuch_thread_destroy` or until
/// the query from which it derived is destroyed).
pub fn notmuch_thread_get_authors(thread: *mut notmuch_thread_t) -> *const c_char;
/// Get the subject of 'thread' as a UTF-8 string.
///
/// The subject is taken from the first message (according to the query
/// order---see `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 `notmuch_thread_destroy` or until
/// the query from which it derived is destroyed).
pub fn notmuch_thread_get_subject(thread: *mut notmuch_thread_t) -> *const c_char;
/// Get the date of the oldest message in 'thread' as a time_t value.
pub fn notmuch_thread_get_oldest_date(thread: *mut notmuch_thread_t) -> time_t;
/// Get the date of the newest message in 'thread' as a time_t value.
pub fn notmuch_thread_get_newest_date(thread: *mut notmuch_thread_t) -> time_t;
/// Get the tags for 'thread', returning a `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
/// `notmuch_thread_destroy` or until the query from which it derived is
/// destroyed).
///
/// Typical usage might be:
///
/// ```ignore
/// 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
/// `notmuch_tags_t` object. (For consistency, we do provide a
/// `notmuch_tags_destroy` function, but there's no good reason to call
/// it if the message is about to be destroyed).
pub fn notmuch_thread_get_tags(thread: *mut notmuch_thread_t) -> *mut notmuch_tags_t;
/// Destroy a `notmuch_thread_t` object.
pub fn notmuch_thread_destroy(thread: *mut notmuch_thread_t);
/// Is the given 'messages' iterator pointing at a valid message.
///
/// When this function returns TRUE, `notmuch_messages_get` will return a
/// valid object. Whereas when this function returns FALSE,
/// `notmuch_messages_get` will return NULL.
///
/// See the documentation of `notmuch_query_search_messages` for example
/// code showing how to iterate over a `notmuch_messages_t` object.
pub fn notmuch_messages_valid(messages: *mut notmuch_messages_t) -> notmuch_bool_t;
/// Get the current message from 'messages' as a `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 `notmuch_query_search_messages` for example
/// code showing how to iterate over a `notmuch_messages_t` object.
///
/// If an out-of-memory situation occurs, this function will return
/// NULL.
pub fn notmuch_messages_get(messages: *mut notmuch_messages_t) -> *mut notmuch_message_t;
/// 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 `notmuch_messages_valid` will return FALSE and
/// `notmuch_messages_get` will return NULL).
///
/// See the documentation of `notmuch_query_search_messages` for example
/// code showing how to iterate over a `notmuch_messages_t` object.
pub fn notmuch_messages_move_to_next(messages: *mut notmuch_messages_t);
/// Destroy a `notmuch_messages_t` object.
///
/// It's not strictly necessary to call this function. All memory from
/// the `notmuch_messages_t` object will be reclaimed when the containing
/// query object is destroyed.
pub fn notmuch_messages_destroy(messages: *mut notmuch_messages_t);
/// 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.
pub fn notmuch_messages_collect_tags(messages: *mut notmuch_messages_t) -> *mut notmuch_tags_t;
/// 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 not return NULL since Notmuch ensures that every
/// message has a unique message ID, (Notmuch will generate an ID for a
/// message if the original file does not contain one).
pub fn notmuch_message_get_message_id(message: *mut notmuch_message_t) -> *const c_char;
/// 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
/// `notmuch_message_destroy` on 'message' or until a query from which it
/// derived is destroyed).
///
/// This function will not return NULL since Notmuch ensures that every
/// message belongs to a single thread.
pub fn notmuch_message_get_thread_id(message: *mut notmuch_message_t) -> *const c_char;
/// Get a `notmuch_messages_t` iterator for all of the replies to
/// 'message'.
///
/// Note: This call only makes sense if 'message' was ultimately
/// obtained from a `notmuch_thread_t` object, (such as by coming
/// directly from the result of calling
/// `notmuch_thread_get_toplevel_messages` or by any number of subsequent
/// calls to `notmuch_message_get_replies`).
///
/// If 'message' was obtained through some non-thread means, (such as
/// by a call to `notmuch_query_search_messages`), then this function
/// will return NULL.
///
/// If there are no replies to 'message', this function will return
/// NULL. (Note that `notmuch_messages_valid` will accept that NULL
/// value as legitimate, and simply return FALSE for it.)
pub fn notmuch_message_get_replies(message: *mut notmuch_message_t) -> *mut notmuch_messages_t;
/// Get the total number of files associated with a message.
/// @returns Non-negative integer
/// @since libnotmuch 5.0 (notmuch 0.25)
pub fn notmuch_message_count_files(message: *mut notmuch_message_t) -> c_int;
/// Get a filename for the email corresponding to 'message'.
///
/// The returned filename is an absolute filename, (the initial
/// component will match `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 `notmuch_message_get_filenames` for returning the
/// complete list of filenames.
pub fn notmuch_message_get_filename(message: *mut notmuch_message_t) -> *const c_char;
/// Get all filenames for the email corresponding to 'message'.
///
/// Returns a `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 `notmuch_database_get_path`() ).
pub fn notmuch_message_get_filenames(
message: *mut notmuch_message_t,
) -> *mut notmuch_filenames_t;
/// 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 notmuch_database_index_file)
///
/// After reindexing, the user should discard the message object passed
/// in here by calling notmuch_message_destroy, since it refers to the
/// original message, not to the reindexed message.
pub fn notmuch_message_reindex(
message: *mut notmuch_message_t,
indexopts: *mut notmuch_indexopts_t
) -> notmuch_status_t;
/// Get a value of a flag for the email corresponding to 'message'.
pub fn notmuch_message_get_flag(
message: *mut notmuch_message_t,
flag: notmuch_message_flag_t,
) -> notmuch_bool_t;
/// Set a value of a flag for the email corresponding to 'message'.
pub fn notmuch_message_set_flag(
message: *mut notmuch_message_t,
flag: notmuch_message_flag_t,
value: notmuch_bool_t,
);
/// Get the date of 'message' as a time_t value.
///
/// For the original textual representation of the Date header from the
/// message call `notmuch_message_get_header`() with a header value of
/// "date".
pub fn notmuch_message_get_date(message: *mut notmuch_message_t) -> time_t;
/// 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.
pub fn notmuch_message_get_header(
message: *mut notmuch_message_t,
header: *const c_char,
) -> *const c_char;
/// Get the tags for 'message', returning a `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:
///
/// ```ignore
/// 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
/// `notmuch_tags_t` object. (For consistency, we do provide a
/// `notmuch_tags_destroy` function, but there's no good reason to call
/// it if the message is about to be destroyed).
pub fn notmuch_message_get_tags(message: *mut notmuch_message_t) -> *mut notmuch_tags_t;
/// Add a tag to the given message.
///
/// Return value:
///
/// * `notmuch_status_t::SUCCESS`: Tag successfully added to message
///
/// * `notmuch_status_t::NULL_POINTER`: The 'tag' argument is NULL
///
/// * `notmuch_status_t::TAG_TOO_LONG`: The length of 'tag' is too long
/// (exceeds TAG_MAX)
///
/// * `notmuch_status_t::READ_ONLY_DATABASE`: Database was opened in read-only
/// mode so message cannot be modified.
pub fn notmuch_message_add_tag(
message: *mut notmuch_message_t,
tag: *const c_char,
) -> notmuch_status_t;
/// Remove a tag from the given message.
///
/// Return value:
///
/// * `notmuch_status_t::SUCCESS`: Tag successfully removed from message
/// * `notmuch_status_t::NULL_POINTER`: The 'tag' argument is NULL
/// * `notmuch_status_t::TAG_TOO_LONG`: The length of 'tag' is too long (exceeds `TAG_MAX`)
/// * `notmuch_status_t::READ_ONLY_DATABASE`: Database was opened in read-only mode so message
/// cannot be modified.
pub fn notmuch_message_remove_tag(
message: *mut notmuch_message_t,
tag: *const c_char,
) -> notmuch_status_t;
/// Remove all tags from the given message.
///
/// See `notmuch_message_freeze` for an example showing how to safely
/// replace tag values.
///
/// `notmuch_status_t::READ_ONLY_DATABASE`: Database was opened in read-only
/// mode so message cannot be modified.
pub fn notmuch_message_remove_all_tags(message: *mut notmuch_message_t) -> notmuch_status_t;
/// 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:
///
/// ```ignore
/// 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
/// `notmuch_database_add_message`. See also
/// `notmuch_message_tags_to_maildir_flags` for synchronizing tag changes
/// back to maildir flags.
pub fn notmuch_message_maildir_flags_to_tags(
message: *mut notmuch_message_t,
) -> notmuch_status_t;
/// 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):
///
/// 'D' iff the message has the "draft" tag
/// 'F' iff the message has the "flagged" tag
/// 'P' iff the message has the "passed" tag
/// 'R' iff the message has the "replied" tag
/// '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 `notmuch_message_add_tag`,
/// notmuch_message_remove_tag, or `notmuch_message_freeze`/
/// notmuch_message_thaw). See also `notmuch_message_maildir_flags_to_tags`
/// for synchronizing maildir flag changes back to tags.
pub fn notmuch_message_tags_to_maildir_flags(
message: *mut notmuch_message_t,
) -> notmuch_status_t;
/// Freeze the current state of 'message' within the database.
///
/// This means that changes to the message state, (via
/// notmuch_message_add_tag, `notmuch_message_remove_tag`, and
/// `notmuch_message_remove_all_tags`), will not be committed to the
/// database until the message is thawed with `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:
///
/// ```ignore
/// 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
/// notmuch_message_remove_all_tags but before `notmuch_message_add_tag`.
///
/// Return value:
///
/// `notmuch_status_t::SUCCESS`: Message successfully frozen.
///
/// `notmuch_status_t::READ_ONLY_DATABASE`: Database was opened in read-only
/// mode so message cannot be modified.
pub fn notmuch_message_freeze(message: *mut notmuch_message_t) -> notmuch_status_t;
/// Thaw the current 'message', synchronizing any changes that may have
/// occurred while 'message' was frozen into the notmuch database.
///
/// See `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 value:
///
/// `notmuch_status_t::SUCCESS`: Message successfully thawed, (or at least
/// its frozen count has successfully been reduced by 1).
///
/// `notmuch_status_t::UNBALANCED_FREEZE_THAW`: An attempt was made to thaw
/// an unfrozen message. That is, there have been an unbalanced
/// number of calls to `notmuch_message_freeze` and
/// `notmuch_message_thaw`.
pub fn notmuch_message_thaw(message: *mut notmuch_message_t) -> notmuch_status_t;
/// Destroy a `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.)
pub fn notmuch_message_destroy(message: *mut notmuch_message_t);
/// 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.
///
/// @returns
/// - `notmuch_status_t::NULL_POINTER`: *value* may not be NULL.
/// - `notmuch_status_t::SUCCESS`: No error occured.
/// @since libnotmuch 4.4 (notmuch 0.23)
pub fn notmuch_message_get_property(
message: *mut notmuch_message_t,
key: *const c_char,
value: *mut *const c_char,
) -> notmuch_status_t;
/// Add a (key,value) pair to a message
///
/// @returns
/// - `notmuch_status_t::ILLEGAL_ARGUMENT`: *key* may not contain an '=' character.
/// - `notmuch_status_t::NULL_POINTER`: Neither *key* nor *value* may be NULL.
/// - `notmuch_status_t::SUCCESS`: No error occured.
/// @since libnotmuch 4.4 (notmuch 0.23)
pub fn notmuch_message_add_property(
message: *mut notmuch_message_t,
key: *const c_char,
value: *const c_char,
) -> notmuch_status_t;
///
/// Remove a `(key,value)` pair from a message.
///
/// It is not an error to remove a non-existant `(key,value)` pair
///
/// @returns
/// - `notmuch_status_t::ILLEGAL_ARGUMENT`: `key` may not contain an '=' character.
/// - `notmuch_status_t::NULL_POINTER`: Neither `key` nor *value* may be NULL.
/// - `notmuch_status_t::SUCCESS`: No error occured.
/// @since libnotmuch 4.4 (notmuch 0.23)
pub fn notmuch_message_remove_property(
message: *mut notmuch_message_t,
key: *const c_char,
value: *const c_char,
) -> notmuch_status_t;
/// Remove all `(key,value)` pairs from the given message.
///
/// @param[in,out] message message to operate on.
/// @param[in] key key to delete properties for. If NULL, delete
/// properties for all keys
/// @returns
/// - `notmuch_status_::READ_ONLY_DATABASE`: Database was opened in
/// read-only mode so message cannot be modified.
/// - `notmuch_status_t::SUCCESS`: No error occured.
///
/// @since libnotmuch 4.4 (notmuch 0.23)
pub fn notmuch_message_remove_all_properties(
message: *mut notmuch_message_t,
key: *const c_char,
) -> notmuch_status_t;
/// Remove all (prefix*,value) pairs from the given message
///
/// @param[in,out] message message to operate on.
/// @param[in] prefix delete properties with keys that start with prefix.
/// If NULL, delete all properties
/// @returns
/// - NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
/// read-only mode so message cannot be modified.
/// - NOTMUCH_STATUS_SUCCESS: No error occurred.
///
/// @since libnotmuch 5.1 (notmuch 0.26)
///
pub fn notmuch_message_remove_all_properties_with_prefix(
message: *mut notmuch_message_t,
prefix: *const c_char,
) -> notmuch_status_t;
/// Get the properties for *message*, returning a
/// `notmuch_message_properties_t` object which can be used to iterate over
/// all properties.
///
/// The `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[in] message The message to examine
/// @param[in] key key or key prefix
/// @param[in] exact if TRUE, require exact match with key. Otherwise
/// treat as prefix.
///
/// Typical usage might be:
///
/// ```ignore
/// 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
/// `notmuch_message_properties_t` object. (For consistency, we do provide a
/// `notmuch_message_properities_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)
///
pub fn notmuch_message_get_properties(
message: *mut notmuch_message_t,
key: *const c_char,
exact: notmuch_bool_t,
) -> *mut notmuch_message_properties_t;
/// Return the number of properties named "key" belonging to the specific message.
///
/// @param[in] message The message to examine
/// @param[in] key key to count
/// @param[out] count The number of matching properties associated with this message.
///
/// @returns
///
/// NOTMUCH_STATUS_SUCCESS: successful count, possibly some other error.
///
/// @since libnotmuch 5.2 (notmuch 0.27)
pub fn notmuch_message_count_properties(
message: *mut notmuch_message_t,
key: *const c_char,
count: *mut c_uint,
) -> notmuch_status_t;
/// 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 `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 `notmuch_message_properties_get` for example code
/// showing how to iterate over a `notmuch_message_properties_t` object.
///
/// @since libnotmuch 4.4 (notmuch 0.23)
pub fn notmuch_message_properties_valid(
properties: *const notmuch_message_properties_t,
) -> notmuch_bool_t;
/// 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
/// `notmuch_message_properties_valid` will return FALSE).
///
/// See the documentation of `notmuch_message_get_properties` for example
/// code showing how to iterate over a `notmuch_message_properties_t` object.
///
/// @since libnotmuch 4.4 (notmuch 0.23)
pub fn notmuch_message_properties_move_to_next(properties: *mut notmuch_message_properties_t);
/// 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)
///
pub fn notmuch_message_properties_key(
properties: *mut notmuch_message_properties_t,
) -> *const c_char;
/// 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)
pub fn notmuch_message_properties_value(
properties: *const notmuch_message_properties_t,
) -> *const c_char;
/// Destroy a `notmuch_message_properties_t` object.
///
/// It's not strictly necessary to call this function. All memory from
/// the `notmuch_message_properties_t` object will be reclaimed when the
/// containing message object is destroyed.
///
/// @since libnotmuch 4.4 (notmuch 0.23)
pub fn notmuch_message_properties_destroy(properties: *mut notmuch_message_properties_t);
/// Is the given 'tags' iterator pointing at a valid tag.
///
/// When this function returns TRUE, `notmuch_tags_get` will return a
/// valid string. Whereas when this function returns FALSE,
/// `notmuch_tags_get` will return NULL.
///
/// See the documentation of `notmuch_message_get_tags` for example code
/// showing how to iterate over a `notmuch_tags_t` object.
pub fn notmuch_tags_valid(tags: *mut notmuch_tags_t) -> notmuch_bool_t;
/// 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 `notmuch_message_get_tags` for example code
/// showing how to iterate over a `notmuch_tags_t` object.
pub fn notmuch_tags_get(tags: *mut notmuch_tags_t) -> *const c_char;
/// 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
/// notmuch_tags_valid will return FALSE and `notmuch_tags_get` will
/// return NULL).
///
/// See the documentation of `notmuch_message_get_tags` for example code
/// showing how to iterate over a `notmuch_tags_t` object.
pub fn notmuch_tags_move_to_next(tags: *mut notmuch_tags_t);
/// Destroy a `notmuch_tags_t` object.
///
/// It's not strictly necessary to call this function. All memory from
/// the `notmuch_tags_t` object will be reclaimed when the containing
/// message or query objects are destroyed.
pub fn notmuch_tags_destroy(tags: *mut notmuch_tags_t);
/// Store an mtime within the database for 'directory'.
///
/// The 'directory' should be an object retrieved from the database
/// with `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:
///
/// * Read the mtime of a directory from the filesystem
///
/// * Call add_message for all mail files in the directory
///
/// * Call `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 `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 `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 value:
///
/// * `notmuch_status_t::SUCCESS`: mtime successfully stored in database.
///
/// * `notmuch_status_t::XAPIAN_EXCEPTION`: A Xapian exception occurred, mtime not stored.
///
/// * `notmuch_status_t::READ_ONLY_DATABASE`: Database was opened in read-only mode so
/// directory mtime cannot be modified.
pub fn notmuch_directory_set_mtime(
directory: *mut notmuch_directory_t,
mtime: time_t,
) -> notmuch_status_t;
/// Get the mtime of a directory, (as previously stored with
/// `notmuch_directory_set_mtime`).
///
/// Returns 0 if no mtime has previously been stored for this
/// directory.
pub fn notmuch_directory_get_mtime(directory: *mut notmuch_directory_t) -> time_t;
/// Get a `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).
pub fn notmuch_directory_get_child_files(
directory: *mut notmuch_directory_t,
) -> *mut notmuch_filenames_t;
/// Get a `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).
pub fn notmuch_directory_get_child_directories(
directory: *mut notmuch_directory_t,
) -> *mut notmuch_filenames_t;
/// Delete directory document from the database, and destroy the
/// `notmuch_directory_t` object. Assumes any child directories and files
/// have been deleted by the caller.
///
/// @since libnotmuch 4.3 (notmuch 0.21)
pub fn notmuch_directory_delete(directory: *mut notmuch_directory_t) -> notmuch_status_t;
/// Destroy a `notmuch_directory_t` object.
pub fn notmuch_directory_destroy(directory: *mut notmuch_directory_t);
/// Is the given 'filenames' iterator pointing at a valid filename.
///
/// When this function returns TRUE, `notmuch_filenames_get` will return
/// a valid string. Whereas when this function returns FALSE,
/// `notmuch_filenames_get` will return NULL.
///
/// It is acceptable to pass NULL for 'filenames', in which case this
/// function will always return FALSE.
pub fn notmuch_filenames_valid(filenames: *mut notmuch_filenames_t) -> notmuch_bool_t;
/// 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.
pub fn notmuch_filenames_get(filenames: *mut notmuch_filenames_t) -> *const c_char;
/// 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 `notmuch_filenames_valid` will return FALSE and
/// `notmuch_filenames_get` will return NULL).
///
/// It is acceptable to pass NULL for 'filenames', in which case this
/// function will do nothing.
pub fn notmuch_filenames_move_to_next(filenames: *mut notmuch_filenames_t);
/// Destroy a `notmuch_filenames_t` object.
///
/// It's not strictly necessary to call this function. All memory from
/// the `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.
pub fn notmuch_filenames_destroy(filenames: *mut notmuch_filenames_t);
/// set config 'key' to 'value'
///
/// @since libnotmuch 4.4 (notmuch 0.23)
pub fn notmuch_database_set_config(
db: *mut notmuch_database_t,
key: *const c_char,
value: *const c_char,
) -> notmuch_status_t;
/// retrieve config item 'key', assign to 'value'
///
/// keys which have not been previously set with n_d_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)
pub fn notmuch_database_get_config(
db: *mut notmuch_database_t,
key: *const c_char,
value: *mut *mut c_char,
) -> notmuch_status_t;
/// Create an iterator for all config items with keys matching a given prefix
///
/// @since libnotmuch 4.4 (notmuch 0.23)
pub fn notmuch_database_get_config_list(
db: *mut notmuch_database_t,
prefix: *const c_char,
out: *mut *mut notmuch_config_list_t,
) -> notmuch_status_t;
/// Is 'config_list' iterator valid (i.e. _key, _value, _move_to_next can be called).
///
/// @since libnotmuch 4.4 (notmuch 0.23)
pub fn notmuch_config_list_valid(config_list: *mut notmuch_config_list_t) -> notmuch_bool_t;
/// return key for current config pair
///
/// return value is owned by the iterator, and will be destroyed by the
/// next call to `notmuch_config_list_key` or `notmuch_config_list_destroy`.
///
/// @since libnotmuch 4.4 (notmuch 0.23)
pub fn notmuch_config_list_key(config_list: *mut notmuch_config_list_t) -> *const c_char;
/// return 'value' for current config pair
///
/// return value is owned by the iterator, and will be destroyed by the
/// next call to `notmuch_config_list_value` or notmuch `config_list_destroy`
///
/// @since libnotmuch 4.4 (notmuch 0.23)
pub fn notmuch_config_list_value(config_list: *mut notmuch_config_list_t) -> *const c_char;
/// move 'config_list' iterator to the next pair
///
/// @since libnotmuch 4.4 (notmuch 0.23)
pub fn notmuch_config_list_move_to_next(config_list: *mut notmuch_config_list_t);
/// free any resources held by 'config_list'
///
/// @since libnotmuch 4.4 (notmuch 0.23)
pub fn notmuch_config_list_destroy(config_list: *mut notmuch_config_list_t);
/// get a configuration value from an open database.
///
/// This value reflects all configuration information given at the time the database was opened.
///
/// @param[in] notmuch database
/// @param[in] key configuration key
///
/// @since libnotmuch 5.4 (notmuch 0.32)
///
/// @retval 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.
pub fn notmuch_config_get(
notmuch: *mut notmuch_database_t,
key: notmuch_config_key_t,
) -> *const c_char;
/// set a configuration value from in an open database.
///
/// This value reflects all configuration information given at the time
/// the database was opened.
///
/// @param[in,out] notmuch database open read/write
/// @param[in] key configuration key
/// @param[in] val configuration value
///
/// @since libnotmuch 5.4 (notmuch 0.32)
///
/// @retval returns any return value for notmuch_database_set_config.
pub fn notmuch_config_set(
notmuch: *mut notmuch_database_t,
key: notmuch_config_key_t,
val: *const c_char,
) -> notmuch_status_t;
/// 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[in] notmuch database
/// @param[in] key configuration key
///
/// @since libnotmuch 5.4 (notmuch 0.32)
///
/// @retval NULL in case of error.
pub fn notmuch_config_get_values(
notmuch: *mut notmuch_database_t,
key: notmuch_config_key_t,
) -> *mut notmuch_config_values_t;
/// 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[in] notmuch database
/// @param[in] key configuration key
///
/// @since libnotmuch 5.4 (notmuch 0.32)
///
/// @retval NULL in case of error.
pub fn notmuch_config_get_values_string(
notmuch: *mut notmuch_database_t,
key: *const c_char,
) -> *mut notmuch_config_values_t;
/// Is the given 'config_values' iterator pointing at a valid element.
///
/// @param[in] values iterator
///
/// @since libnotmuch 5.4 (notmuch 0.32)
///
/// @retval FALSE if passed a NULL pointer, or the iterator is exhausted.
pub fn notmuch_config_values_valid(values: *mut notmuch_config_values_t) -> notmuch_bool_t;
/// Get the current value from the 'values' iterator
///
/// @param[in] values iterator
///
/// @since libnotmuch 5.4 (notmuch 0.32)
///
/// @retval a string with the same lifetime as the iterator
pub fn notmuch_config_values_get(values: *mut notmuch_config_values_t) -> *const c_char;
/// Move the 'values' iterator to the next element
///
/// @param[in,out] values iterator
///
/// @since libnotmuch 5.4 (notmuch 0.32)
///
pub fn notmuch_config_values_move_to_next(values: *mut notmuch_config_values_t);
/// reset the 'values' iterator to the first element
///
/// @param[in,out] values iterator. A NULL value is ignored.
///
/// @since libnotmuch 5.4 (notmuch 0.32)
///
pub fn notmuch_config_values_start(values: *mut notmuch_config_values_t);
/// Destroy a config values iterator, along with any associated
/// resources.
///
/// @param[in,out] values iterator
///
/// @since libnotmuch 5.4 (notmuch 0.32)
pub fn notmuch_config_values_destroy(values: *mut notmuch_config_values_t);
/// Returns an iterator for a (key, value) configuration pairs
///
/// @param[in] notmuch database
/// @param[in] prefix prefix for keys. Pass \"\" for all keys.
///
/// @since libnotmuch 5.4 (notmuch 0.32)
///
/// @retval NULL in case of error.
pub fn notmuch_config_get_pairs(
notmuch: *mut notmuch_database_t,
prefix: *const c_char,
) -> *mut notmuch_config_pairs_t;
/// Is the given 'config_pairs' iterator pointing at a valid element.
///
/// @param[in] pairs iterator
///
/// @since libnotmuch 5.4 (notmuch 0.32)
///
/// @retval FALSE if passed a NULL pointer, or the iterator is exhausted.
pub fn notmuch_config_pairs_valid(pairs: *mut notmuch_config_pairs_t) -> notmuch_bool_t;
/// Move the 'config_pairs' iterator to the next element
///
/// @param[in,out] pairs iterator
///
/// @since libnotmuch 5.4 (notmuch 0.32)
pub fn notmuch_config_pairs_move_to_next(pairs: *mut notmuch_config_pairs_t);
/// Get the current key from the 'config_pairs' iterator
///
/// @param[in] pairs iterator
///
/// @since libnotmuch 5.4 (notmuch 0.32)
///
/// @retval a string with the same lifetime as the iterator
pub fn notmuch_config_pairs_key(pairs: *mut notmuch_config_pairs_t) -> *const c_char;
/// Get the current value from the 'config_pairs' iterator
///
/// @param[in] pairs iterator
///
/// @since libnotmuch 5.4 (notmuch 0.32)
///
/// @retval a string with the same lifetime as the iterator
pub fn notmuch_config_pairs_value(pairs: *mut notmuch_config_pairs_t) -> *const c_char;
/// Destroy a config_pairs iterator, along with any associated
/// resources.
///
/// @param[in,out] pairs iterator
///
/// @since libnotmuch 5.4 (notmuch 0.32)
pub fn notmuch_config_pairs_destroy(pairs: *mut notmuch_config_pairs_t);
/// 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[in] notmuch database
/// @param[in] key configuration key
/// @param[out] val configuration value, converted to Boolean
///
/// @since libnotmuch 5.4 (notmuch 0.32)
///
/// @retval #NOTMUCH_STATUS_ILLEGAL_ARGUMENT if either key is unknown
/// or the corresponding value does not convert to Boolean.
pub fn notmuch_config_get_bool(
notmuch: *mut notmuch_database_t,
key: notmuch_config_key_t,
val: *mut notmuch_bool_t,
) -> notmuch_status_t;
/// return the path of the config file loaded, if any
///
/// @retval NULL if no config file was loaded
pub fn notmuch_config_path(notmuch: *mut notmuch_database_t) -> *const c_char;
/// 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
/// 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.
///
/// @since libnotmuch 5.1 (notmuch 0.26)
pub fn notmuch_database_get_default_indexopts(db: *mut notmuch_database_t) -> *mut notmuch_indexopts_t;
////
//// Stating a policy about how to decrypt messages.
////
//// See index.decrypt in 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.
////
//// 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)
pub fn notmuch_indexopts_set_decrypt_policy(options: *mut notmuch_indexopts_t,
decrypt_policy: notmuch_decryption_policy_t) -> notmuch_status_t;
//// Return whether to decrypt encrypted parts while indexing.
//// see notmuch_indexopts_set_decrypt_policy.
////
//// @since libnotmuch 5.1 (notmuch 0.26)
pub fn notmuch_indexopts_get_decrypt_policy(options: *const notmuch_indexopts_t) -> notmuch_decryption_policy_t;
/// Destroy a notmuch_indexopts_t object.
///
/// @since libnotmuch 5.1 (notmuch 0.26)
pub fn notmuch_indexopts_destroy(options: *mut notmuch_indexopts_t);
/// interrogate the library for compile time features
///
/// @since libnotmuch 4.4 (notmuch 0.23)
pub fn notmuch_built_with(name: *const c_char) -> notmuch_bool_t;
}