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/mrmimeparser.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">mrmimeparser.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">/* Parse MIME body; this is the text part of an IMF, see https://tools.ietf.org/html/rfc5322</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">mrmimeparser_t has no deep dependencies to mrmailbox_t or to the database</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">(mrmailbox_t is used for logging only). */</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 __MRMIMEPARSER_H__</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#define __MRMIMEPARSER_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="preprocessor">#include "mrhash.h"</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#include "mrparam.h"</span></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> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>mrmimepart_t</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> {</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordtype">int</span> m_type; <span class="comment">/*one of MR_MSG_* */</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordtype">int</span> m_is_meta; <span class="comment">/*meta parts contain eg. profile or group images and are only present if there is at least one "normal" part*/</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordtype">char</span>* m_msg;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordtype">char</span>* m_msg_raw;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordtype">int</span> m_bytes;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  mrparam_t* m_param;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> } mrmimepart_t;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>mrmimeparser_t</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> {</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="comment">/* data, read-only, must not be free()'d (it is free()'d when the mrmimeparser_t object gets destructed) */</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  carray* m_parts; <span class="comment">/* array of mrmimepart_t objects */</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">struct </span>mailmime* m_mimeroot;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  mrhash_t m_header; <span class="comment">/* memoryhole-compliant header */</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">struct </span>mailimf_fields* m_header_root; <span class="comment">/* must NOT be freed, do not use for query, merged into m_header, a pointer somewhere to the MIME data*/</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">struct </span>mailimf_fields* m_header_protected; <span class="comment">/* MUST be freed, do not use for query, merged into m_header */</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordtype">char</span>* m_subject;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordtype">int</span> m_is_send_by_messenger;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordtype">int</span> m_decrypted_and_validated;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordtype">int</span> m_decrypted_with_validation_errors;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">int</span> m_decrypting_failed; <span class="comment">/* set, if there are multipart/encrypted parts left after decryption */</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* m_blobdir;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordtype">int</span> m_is_forwarded;</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>  <a class="code" href="classmrmailbox__t.html">mrmailbox_t</a>* m_mailbox;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  carray* m_reports; <span class="comment">/* array of mailmime objects */</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordtype">int</span> m_is_system_message;</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> } mrmimeparser_t;</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> </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> mrmimeparser_t* mrmimeparser_new (<span class="keyword">const</span> <span class="keywordtype">char</span>* blobdir, <a class="code" href="classmrmailbox__t.html">mrmailbox_t</a>*);</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="keywordtype">void</span> mrmimeparser_unref (mrmimeparser_t*);</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="keywordtype">void</span> mrmimeparser_empty (mrmimeparser_t*);</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="keywordtype">void</span> mrmimeparser_parse (mrmimeparser_t*, <span class="keyword">const</span> <span class="keywordtype">char</span>* body_not_terminated, <span class="keywordtype">size_t</span> body_bytes);</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </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> <span class="comment">/* the following functions can be used only after a call to mrmimeparser_parse() */</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="keyword">struct </span>mailimf_field* mrmimeparser_lookup_field (mrmimeparser_t*, <span class="keyword">const</span> <span class="keywordtype">char</span>* field_name);</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="keyword">struct </span>mailimf_optional_field* mrmimeparser_lookup_optional_field (mrmimeparser_t*, <span class="keyword">const</span> <span class="keywordtype">char</span>* field_name);</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="keyword">struct </span>mailimf_optional_field* mrmimeparser_lookup_optional_field2 (mrmimeparser_t*, <span class="keyword">const</span> <span class="keywordtype">char</span>* field_name, <span class="keyword">const</span> <span class="keywordtype">char</span>* or_field_name);</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> mrmimepart_t* mrmimeparser_get_last_nonmeta (mrmimeparser_t*);</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="preprocessor">#define mrmimeparser_has_nonmeta(a) (mrmimeparser_get_last_nonmeta((a))!=NULL)</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="keywordtype">int</span> mrmimeparser_is_mailinglist_message (mrmimeparser_t*);</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </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> <span class="comment">/* low-level-tools for working with mailmime structures directly */</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="preprocessor">#ifdef MR_USE_MIME_DEBUG</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="keywordtype">void</span> mailmime_print (<span class="keyword">struct</span> mailmime*);</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="keyword">struct </span>mailmime_parameter* mailmime_find_ct_parameter (<span class="keyword">struct</span> mailmime*, <span class="keyword">const</span> <span class="keywordtype">char</span>* name);</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="keywordtype">int</span> mailmime_transfer_decode (<span class="keyword">struct</span> mailmime*, <span class="keyword">const</span> <span class="keywordtype">char</span>** ret_decoded_data, <span class="keywordtype">size_t</span>* ret_decoded_data_bytes, <span class="keywordtype">char</span>** ret_to_mmap_string_unref);</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="keyword">struct </span>mailimf_fields* mailmime_find_mailimf_fields (<span class="keyword">struct</span> mailmime*); <span class="comment">/*the result is a pointer to mime, must not be freed*/</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="keywordtype">char</span>* mailimf_find_first_addr (<span class="keyword">const</span> <span class="keyword">struct</span> mailimf_mailbox_list*); <span class="comment">/*the result must be freed*/</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="keyword">struct </span>mailimf_field* mailimf_find_field (<span class="keyword">struct</span> mailimf_fields*, <span class="keywordtype">int</span> wanted_fld_type); <span class="comment">/*the result is a pointer to mime, must not be freed*/</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="keyword">struct </span>mailimf_optional_field* mailimf_find_optional_field (<span class="keyword">struct</span> mailimf_fields*, <span class="keyword">const</span> <span class="keywordtype">char</span>* wanted_fld_name);</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> </div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> } <span class="comment">/* /extern "C" */</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="preprocessor">#endif </span><span class="comment">/* __MRMIMEPARSER_H__ */</span><span class="preprocessor"></span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div><div class="ttc" id="classmrmailbox__t_html"><div class="ttname"><a href="classmrmailbox__t.html">mrmailbox_t</a></div><div class="ttdoc">An object representing a single mailbox. </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>
|