mirror of
https://github.com/deltachat/deltachat-core.git
synced 2025-10-04 10:19:16 +02:00
101 lines
22 KiB
HTML
101 lines
22 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.11"/>
|
|
<title>Delta Chat Core C-API: /home/bpetersen/projects/deltachat-core/src/mrimap.h Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { init_search(); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="user.css" rel="stylesheet" type="text/css"/>
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">Delta Chat Core C-API
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.11 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>File Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">mrimap.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*******************************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> *</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Delta Chat Core</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Copyright (C) 2017 Björn Petersen</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Contact: r10s@b44t.com, http://b44t.com</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> *</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * This program is free software: you can redistribute it and/or modify it under</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * the terms of the GNU General Public License as published by the Free Software</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * Foundation, either version 3 of the License, or (at your option) any later</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * version.</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> *</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * This program is distributed in the hope that it will be useful, but WITHOUT</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * details.</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> *</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * You should have received a copy of the GNU General Public License along with</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * this program. If not, see http://www.gnu.org/licenses/ .</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> *</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> ******************************************************************************/</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">/* Purpose: Reading from IMAP servers with no dependencies to the database.</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">mrmailbox_t is only used for logging and to get information about</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">the online state. */</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#ifndef __MRIMAP_H__</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#define __MRIMAP_H__</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>mrloginparam_t mrloginparam_t;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>mrimap_t mrimap_t;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#define MR_IMAP_SEEN 0x0001L</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">typedef</span> int32_t (*mr_get_config_int_t)(mrimap_t*, <span class="keyword">const</span> <span class="keywordtype">char</span>*, int32_t);</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">typedef</span> void (*mr_set_config_int_t)(mrimap_t*, <span class="keyword">const</span> <span class="keywordtype">char</span>*, int32_t);</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">typedef</span> void (*mr_receive_imf_t) (mrimap_t*, <span class="keyword">const</span> <span class="keywordtype">char</span>* imf_raw_not_terminated, <span class="keywordtype">size_t</span> imf_raw_bytes, <span class="keyword">const</span> <span class="keywordtype">char</span>* server_folder, uint32_t server_uid, uint32_t flags);</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>mrimap_t</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> {</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordtype">char</span>* m_imap_server;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">int</span> m_imap_port;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordtype">char</span>* m_imap_user;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordtype">char</span>* m_imap_pw;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordtype">int</span> m_server_flags;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordtype">int</span> m_connected; <span class="comment">/* initally connected and watch thread installed */</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  mailimap* m_hEtpan; <span class="comment">/* normally, if connected, m_hEtpan is also set; however, if a reconnection is required, we may lost this handle */</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  pthread_mutex_t m_hEtpanmutex;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordtype">int</span> m_idle_set_up;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordtype">char</span>* m_selected_folder;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordtype">int</span> m_should_reconnect;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordtype">int</span> m_can_idle;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordtype">int</span> m_has_xlist;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">char</span>* m_moveto_folder;<span class="comment">/* Folder, where reveived chat messages should go to. Normally "Chats" but may be NULL to leave them in the INBOX */</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordtype">char</span>* m_sent_folder; <span class="comment">/* Folder, where send messages should go to. Normally "Chats". */</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  pthread_mutex_t m_idlemutex; <span class="comment">/* set, if idle is not possible; morover, the interrupted IDLE thread waits a second before IDLEing again; this allows several jobs to be executed */</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  pthread_mutex_t m_inwait_mutex; <span class="comment">/* only used to wait for mailstream_wait_idle()/mailimap_idle_done() to terminate. */</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  pthread_t m_watch_thread;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  pthread_cond_t m_watch_cond;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  pthread_mutex_t m_watch_condmutex;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordtype">int</span> m_watch_condflag;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordtype">int</span> m_watch_do_exit;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  time_t m_enter_watch_wait_time;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  pthread_t m_heartbeat_thread;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  pthread_cond_t m_heartbeat_cond;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  pthread_mutex_t m_heartbeat_condmutex;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keyword">struct </span>mailimap_fetch_type* m_fetch_type_uid;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">struct </span>mailimap_fetch_type* m_fetch_type_body;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keyword">struct </span>mailimap_fetch_type* m_fetch_type_flags;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  mr_get_config_int_t m_get_config_int;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  mr_set_config_int_t m_set_config_int;</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  mr_receive_imf_t m_receive_imf;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordtype">void</span>* m_userData;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <a class="code" href="structmrmailbox__t.html">mrmailbox_t</a>* m_mailbox;</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordtype">int</span> m_log_connect_errors;</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> } mrimap_t;</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> mrimap_t* mrimap_new (mr_get_config_int_t, mr_set_config_int_t, mr_receive_imf_t, <span class="keywordtype">void</span>* userData, <a class="code" href="structmrmailbox__t.html">mrmailbox_t</a>*);</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="keywordtype">void</span> mrimap_unref (mrimap_t*);</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="keywordtype">int</span> mrimap_connect (mrimap_t*, <span class="keyword">const</span> mrloginparam_t*);</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="keywordtype">void</span> mrimap_disconnect (mrimap_t*);</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="keywordtype">int</span> mrimap_is_connected (mrimap_t*);</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="keywordtype">int</span> mrimap_fetch (mrimap_t*);</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="keywordtype">int</span> mrimap_append_msg (mrimap_t*, time_t timestamp, <span class="keyword">const</span> <span class="keywordtype">char</span>* data_not_terminated, <span class="keywordtype">size_t</span> data_bytes, <span class="keywordtype">char</span>** ret_server_folder, uint32_t* ret_server_uid);</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="preprocessor">#define MR_MS_ALSO_MOVE 0x01</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="preprocessor">#define MR_MS_SET_MDNSent_FLAG 0x02</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="preprocessor">#define MR_MS_MDNSent_JUST_SET 0x10</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="keywordtype">int</span> mrimap_markseen_msg (mrimap_t*, <span class="keyword">const</span> <span class="keywordtype">char</span>* folder, uint32_t server_uid, <span class="keywordtype">int</span> ms_flags, <span class="keywordtype">char</span>** ret_server_folder, uint32_t* ret_server_uid, <span class="keywordtype">int</span>* ret_ms_flags); <span class="comment">/* only returns 0 on connection problems; we should try later again in this case */</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="keywordtype">int</span> mrimap_delete_msg (mrimap_t*, <span class="keyword">const</span> <span class="keywordtype">char</span>* rfc724_mid, <span class="keyword">const</span> <span class="keywordtype">char</span>* folder, uint32_t server_uid); <span class="comment">/* only returns 0 on connection problems; we should try later again in this case */</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="keywordtype">void</span> mrimap_heartbeat (mrimap_t*);</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> } <span class="comment">/* /extern "C" */</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="preprocessor">#endif </span><span class="comment">/* __MRIMAP_H__ */</span><span class="preprocessor"></span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> </div><div class="ttc" id="structmrmailbox__t_html"><div class="ttname"><a href="structmrmailbox__t.html">mrmailbox_t</a></div><div class="ttdoc">An object representing a single mailbox. </div><div class="ttdef"><b>Definition:</b> mrmailbox.h:184</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.11
|
|
</small></address>
|
|
</body>
|
|
</html>
|