| 1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 2 |
<html xmlns="http://www.w3.org/1999/xhtml"> |
| 3 |
<head> |
| 4 |
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| 5 |
<meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| 6 |
<meta name="generator" content="Doxygen 1.9.1"/> |
| 7 |
<meta name="viewport" content="width=device-width, initial-scale=1"/> |
| 8 |
<title>fullquottel: Options Struct Reference</title> |
| 9 |
<link href="tabs.css" rel="stylesheet" type="text/css"/> |
| 10 |
<script type="text/javascript" src="jquery.js"></script> |
| 11 |
<script type="text/javascript" src="dynsections.js"></script> |
| 12 |
<link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| 13 |
</head> |
| 14 |
<body> |
| 15 |
<div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| 16 |
<div id="titlearea"> |
| 17 |
<table cellspacing="0" cellpadding="0"> |
| 18 |
<tbody> |
| 19 |
<tr style="height: 56px;"> |
| 20 |
<td id="projectalign" style="padding-left: 0.5em;"> |
| 21 |
<div id="projectname">fullquottel |
| 22 |
</div> |
| 23 |
</td> |
| 24 |
</tr> |
| 25 |
</tbody> |
| 26 |
</table> |
| 27 |
</div> |
| 28 |
<!-- end header part --> |
| 29 |
<!-- Generated by Doxygen 1.9.1 --> |
| 30 |
<script type="text/javascript" src="menudata.js"></script> |
| 31 |
<script type="text/javascript" src="menu.js"></script> |
| 32 |
<script type="text/javascript"> |
| 33 |
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| 34 |
$(function() { |
| 35 |
initMenu('',false,false,'search.php','Search'); |
| 36 |
}); |
| 37 |
/* @license-end */</script> |
| 38 |
<div id="main-nav"></div> |
| 39 |
</div><!-- top --> |
| 40 |
<div class="header"> |
| 41 |
<div class="summary"> |
| 42 |
<a href="#pub-methods">Public Member Functions</a> | |
| 43 |
<a href="#pub-attribs">Public Attributes</a> | |
| 44 |
<a href="structOptions-members.html">List of all members</a> </div> |
| 45 |
<div class="headertitle"> |
| 46 |
<div class="title">Options Struct Reference</div> </div> |
| 47 |
</div><!--header--> |
| 48 |
<div class="contents"> |
| 49 |
|
| 50 |
<p>Structure to store the program options. |
| 51 |
<a href="structOptions.html#details">More...</a></p> |
| 52 |
<table class="memberdecls"> |
| 53 |
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| 54 |
Public Member Functions</h2></td></tr> |
| 55 |
<tr class="memitem:ab72fb640172a6109e34c8a5366563753"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structOptions.html#ab72fb640172a6109e34c8a5366563753">Options</a> ()</td></tr> |
| 56 |
<tr class="memdesc:ab72fb640172a6109e34c8a5366563753"><td class="mdescLeft"> </td><td class="mdescRight">the constructor initializes the options with their default values. <a href="structOptions.html#ab72fb640172a6109e34c8a5366563753">More...</a><br /></td></tr> |
| 57 |
<tr class="separator:ab72fb640172a6109e34c8a5366563753"><td class="memSeparator" colspan="2"> </td></tr> |
| 58 |
</table><table class="memberdecls"> |
| 59 |
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> |
| 60 |
Public Attributes</h2></td></tr> |
| 61 |
<tr class="memitem:af83a903df203c52330bbf08c4f806e79"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="structOptions.html#af83a903df203c52330bbf08c4f806e79">scoreThreshold</a></td></tr> |
| 62 |
<tr class="memdesc:af83a903df203c52330bbf08c4f806e79"><td class="mdescLeft"> </td><td class="mdescRight">Threshold of the added scores of the tests, that decide, whether the mail is a tofu mail or not (default: 0.5). <a href="structOptions.html#af83a903df203c52330bbf08c4f806e79">More...</a><br /></td></tr> |
| 63 |
<tr class="separator:af83a903df203c52330bbf08c4f806e79"><td class="memSeparator" colspan="2"> </td></tr> |
| 64 |
<tr class="memitem:afb21fbcb9dd29da17ddebe161ed6fba8"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="structOptions.html#afb21fbcb9dd29da17ddebe161ed6fba8">quoteChars</a></td></tr> |
| 65 |
<tr class="memdesc:afb21fbcb9dd29da17ddebe161ed6fba8"><td class="mdescLeft"> </td><td class="mdescRight">Character(s) that are used to quote. The default value is ">|#". <a href="structOptions.html#afb21fbcb9dd29da17ddebe161ed6fba8">More...</a><br /></td></tr> |
| 66 |
<tr class="separator:afb21fbcb9dd29da17ddebe161ed6fba8"><td class="memSeparator" colspan="2"> </td></tr> |
| 67 |
<tr class="memitem:a2659b52db8688c4975db64de2601a13b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structOptions.html#a2659b52db8688c4975db64de2601a13b">debug</a></td></tr> |
| 68 |
<tr class="memdesc:a2659b52db8688c4975db64de2601a13b"><td class="mdescLeft"> </td><td class="mdescRight">If this option is set, the internal variables that show the mail statistics are print (default: false). <a href="structOptions.html#a2659b52db8688c4975db64de2601a13b">More...</a><br /></td></tr> |
| 69 |
<tr class="separator:a2659b52db8688c4975db64de2601a13b"><td class="memSeparator" colspan="2"> </td></tr> |
| 70 |
<tr class="memitem:ac379c5023df0e03d841436c38560bff0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="fullquottel_8cpp.html#ac5f732bfa685eef86e748807e9295e1c">TextLines</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structOptions.html#ac379c5023df0e03d841436c38560bff0">attributionLines</a></td></tr> |
| 71 |
<tr class="memdesc:ac379c5023df0e03d841436c38560bff0"><td class="mdescLeft"> </td><td class="mdescRight">List of Microsoft Attribution Lines (needed for the <a class="el" href="index.html#doc_msTest">Microsoft Attribution Line Test (msTest)</a>). <a href="structOptions.html#ac379c5023df0e03d841436c38560bff0">More...</a><br /></td></tr> |
| 72 |
<tr class="separator:ac379c5023df0e03d841436c38560bff0"><td class="memSeparator" colspan="2"> </td></tr> |
| 73 |
<tr class="memitem:afd7c803a9ce0fa91678fe312ba4011f8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structSigRating.html">SigRating</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structOptions.html#afd7c803a9ce0fa91678fe312ba4011f8">ownSigTest</a></td></tr> |
| 74 |
<tr class="memdesc:afd7c803a9ce0fa91678fe312ba4011f8"><td class="mdescLeft"> </td><td class="mdescRight">Signature filename and rating options for the <a class="el" href="index.html#doc_ownSigTest">Own Signature Test (ownSigTest)</a> (default: ~/.signature). <a href="structOptions.html#afd7c803a9ce0fa91678fe312ba4011f8">More...</a><br /></td></tr> |
| 75 |
<tr class="separator:afd7c803a9ce0fa91678fe312ba4011f8"><td class="memSeparator" colspan="2"> </td></tr> |
| 76 |
<tr class="memitem:a1b01b0d73e2c905120e95e96caabfe27"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structIntegerRating.html">IntegerRating</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structOptions.html#a1b01b0d73e2c905120e95e96caabfe27">msTest</a></td></tr> |
| 77 |
<tr class="memdesc:a1b01b0d73e2c905120e95e96caabfe27"><td class="mdescLeft"> </td><td class="mdescRight">Rating options for the <a class="el" href="index.html#doc_msTest">Microsoft Attribution Line Test (msTest)</a>. <a href="structOptions.html#a1b01b0d73e2c905120e95e96caabfe27">More...</a><br /></td></tr> |
| 78 |
<tr class="separator:a1b01b0d73e2c905120e95e96caabfe27"><td class="memSeparator" colspan="2"> </td></tr> |
| 79 |
<tr class="memitem:a625435077e0760c8f484b1f4109314d9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structRatioRating.html">RatioRating</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structOptions.html#a625435077e0760c8f484b1f4109314d9">quotedToAllTest</a></td></tr> |
| 80 |
<tr class="memdesc:a625435077e0760c8f484b1f4109314d9"><td class="mdescLeft"> </td><td class="mdescRight">Rating options for the <a class="el" href="index.html#doc_quotedToAllTest">Ratio Quoted Lines To All Lines Test (quotedToAllTest)</a>. <a href="structOptions.html#a625435077e0760c8f484b1f4109314d9">More...</a><br /></td></tr> |
| 81 |
<tr class="separator:a625435077e0760c8f484b1f4109314d9"><td class="memSeparator" colspan="2"> </td></tr> |
| 82 |
<tr class="memitem:a75852fb51d45dd48c139deb58c6af336"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structRatioRating.html">RatioRating</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structOptions.html#a75852fb51d45dd48c139deb58c6af336">bottomQuotedToAllTest</a></td></tr> |
| 83 |
<tr class="memdesc:a75852fb51d45dd48c139deb58c6af336"><td class="mdescLeft"> </td><td class="mdescRight">Rating options for the <a class="el" href="index.html#doc_bottomQuotedToAllTest">Ratio Quoted Lines At Bottom Of The Mail To All Lines Test (bottomQuotedToAllTest)</a>. <a href="structOptions.html#a75852fb51d45dd48c139deb58c6af336">More...</a><br /></td></tr> |
| 84 |
<tr class="separator:a75852fb51d45dd48c139deb58c6af336"><td class="memSeparator" colspan="2"> </td></tr> |
| 85 |
<tr class="memitem:a6e4841f3f5a6c0f3ef48287ff19f45ee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structRatioRating.html">RatioRating</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structOptions.html#a6e4841f3f5a6c0f3ef48287ff19f45ee">bottomQuotedToQuotedTest</a></td></tr> |
| 86 |
<tr class="memdesc:a6e4841f3f5a6c0f3ef48287ff19f45ee"><td class="mdescLeft"> </td><td class="mdescRight">Rating options for the <a class="el" href="index.html#doc_bottomQuotedToQuotedTest">Ratio Quoted Lines At Bottom Of The Mail To Quoted Lines Test (bottomQuotedToQuotedTest)</a>. <a href="structOptions.html#a6e4841f3f5a6c0f3ef48287ff19f45ee">More...</a><br /></td></tr> |
| 87 |
<tr class="separator:a6e4841f3f5a6c0f3ef48287ff19f45ee"><td class="memSeparator" colspan="2"> </td></tr> |
| 88 |
<tr class="memitem:adf91188c340583fffc590cd9d1d63369"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structBoolRating.html">BoolRating</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structOptions.html#adf91188c340583fffc590cd9d1d63369">singleBottomQuoteTest</a></td></tr> |
| 89 |
<tr class="memdesc:adf91188c340583fffc590cd9d1d63369"><td class="mdescLeft"> </td><td class="mdescRight">Rating options for the <a class="el" href="index.html#doc_singleBottomQuoteTest">Single Quote Block At The Bottom of The Mail Test (mailSingleBottomQuote)</a>. <a href="structOptions.html#adf91188c340583fffc590cd9d1d63369">More...</a><br /></td></tr> |
| 90 |
<tr class="separator:adf91188c340583fffc590cd9d1d63369"><td class="memSeparator" colspan="2"> </td></tr> |
| 91 |
</table> |
| 92 |
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| 93 |
<div class="textblock"><p>Structure to store the program options. </p> |
| 94 |
<p>It stores all options and parameters that are needed to run the program. The command line options, system wide file options, and user file options are transfered within this struct and after that, only this struct is used to access the options. </p> |
| 95 |
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| 96 |
<a id="ab72fb640172a6109e34c8a5366563753"></a> |
| 97 |
<h2 class="memtitle"><span class="permalink"><a href="#ab72fb640172a6109e34c8a5366563753">◆ </a></span>Options()</h2> |
| 98 |
|
| 99 |
<div class="memitem"> |
| 100 |
<div class="memproto"> |
| 101 |
<table class="memname"> |
| 102 |
<tr> |
| 103 |
<td class="memname">Options::Options </td> |
| 104 |
<td>(</td> |
| 105 |
<td class="paramname"></td><td>)</td> |
| 106 |
<td></td> |
| 107 |
</tr> |
| 108 |
</table> |
| 109 |
</div><div class="memdoc"> |
| 110 |
|
| 111 |
<p>the constructor initializes the options with their default values. </p> |
| 112 |
|
| 113 |
</div> |
| 114 |
</div> |
| 115 |
<h2 class="groupheader">Member Data Documentation</h2> |
| 116 |
<a id="af83a903df203c52330bbf08c4f806e79"></a> |
| 117 |
<h2 class="memtitle"><span class="permalink"><a href="#af83a903df203c52330bbf08c4f806e79">◆ </a></span>scoreThreshold</h2> |
| 118 |
|
| 119 |
<div class="memitem"> |
| 120 |
<div class="memproto"> |
| 121 |
<table class="memname"> |
| 122 |
<tr> |
| 123 |
<td class="memname">double Options::scoreThreshold</td> |
| 124 |
</tr> |
| 125 |
</table> |
| 126 |
</div><div class="memdoc"> |
| 127 |
|
| 128 |
<p>Threshold of the added scores of the tests, that decide, whether the mail is a tofu mail or not (default: 0.5). </p> |
| 129 |
|
| 130 |
</div> |
| 131 |
</div> |
| 132 |
<a id="afb21fbcb9dd29da17ddebe161ed6fba8"></a> |
| 133 |
<h2 class="memtitle"><span class="permalink"><a href="#afb21fbcb9dd29da17ddebe161ed6fba8">◆ </a></span>quoteChars</h2> |
| 134 |
|
| 135 |
<div class="memitem"> |
| 136 |
<div class="memproto"> |
| 137 |
<table class="memname"> |
| 138 |
<tr> |
| 139 |
<td class="memname">string Options::quoteChars</td> |
| 140 |
</tr> |
| 141 |
</table> |
| 142 |
</div><div class="memdoc"> |
| 143 |
|
| 144 |
<p>Character(s) that are used to quote. The default value is ">|#". </p> |
| 145 |
|
| 146 |
</div> |
| 147 |
</div> |
| 148 |
<a id="a2659b52db8688c4975db64de2601a13b"></a> |
| 149 |
<h2 class="memtitle"><span class="permalink"><a href="#a2659b52db8688c4975db64de2601a13b">◆ </a></span>debug</h2> |
| 150 |
|
| 151 |
<div class="memitem"> |
| 152 |
<div class="memproto"> |
| 153 |
<table class="memname"> |
| 154 |
<tr> |
| 155 |
<td class="memname">bool Options::debug</td> |
| 156 |
</tr> |
| 157 |
</table> |
| 158 |
</div><div class="memdoc"> |
| 159 |
|
| 160 |
<p>If this option is set, the internal variables that show the mail statistics are print (default: false). </p> |
| 161 |
|
| 162 |
</div> |
| 163 |
</div> |
| 164 |
<a id="ac379c5023df0e03d841436c38560bff0"></a> |
| 165 |
<h2 class="memtitle"><span class="permalink"><a href="#ac379c5023df0e03d841436c38560bff0">◆ </a></span>attributionLines</h2> |
| 166 |
|
| 167 |
<div class="memitem"> |
| 168 |
<div class="memproto"> |
| 169 |
<table class="memname"> |
| 170 |
<tr> |
| 171 |
<td class="memname"><a class="el" href="fullquottel_8cpp.html#ac5f732bfa685eef86e748807e9295e1c">TextLines</a> Options::attributionLines</td> |
| 172 |
</tr> |
| 173 |
</table> |
| 174 |
</div><div class="memdoc"> |
| 175 |
|
| 176 |
<p>List of Microsoft Attribution Lines (needed for the <a class="el" href="index.html#doc_msTest">Microsoft Attribution Line Test (msTest)</a>). </p> |
| 177 |
|
| 178 |
</div> |
| 179 |
</div> |
| 180 |
<a id="afd7c803a9ce0fa91678fe312ba4011f8"></a> |
| 181 |
<h2 class="memtitle"><span class="permalink"><a href="#afd7c803a9ce0fa91678fe312ba4011f8">◆ </a></span>ownSigTest</h2> |
| 182 |
|
| 183 |
<div class="memitem"> |
| 184 |
<div class="memproto"> |
| 185 |
<table class="memname"> |
| 186 |
<tr> |
| 187 |
<td class="memname"><a class="el" href="structSigRating.html">SigRating</a> Options::ownSigTest</td> |
| 188 |
</tr> |
| 189 |
</table> |
| 190 |
</div><div class="memdoc"> |
| 191 |
|
| 192 |
<p>Signature filename and rating options for the <a class="el" href="index.html#doc_ownSigTest">Own Signature Test (ownSigTest)</a> (default: ~/.signature). </p> |
| 193 |
|
| 194 |
</div> |
| 195 |
</div> |
| 196 |
<a id="a1b01b0d73e2c905120e95e96caabfe27"></a> |
| 197 |
<h2 class="memtitle"><span class="permalink"><a href="#a1b01b0d73e2c905120e95e96caabfe27">◆ </a></span>msTest</h2> |
| 198 |
|
| 199 |
<div class="memitem"> |
| 200 |
<div class="memproto"> |
| 201 |
<table class="memname"> |
| 202 |
<tr> |
| 203 |
<td class="memname"><a class="el" href="structIntegerRating.html">IntegerRating</a> Options::msTest</td> |
| 204 |
</tr> |
| 205 |
</table> |
| 206 |
</div><div class="memdoc"> |
| 207 |
|
| 208 |
<p>Rating options for the <a class="el" href="index.html#doc_msTest">Microsoft Attribution Line Test (msTest)</a>. </p> |
| 209 |
|
| 210 |
</div> |
| 211 |
</div> |
| 212 |
<a id="a625435077e0760c8f484b1f4109314d9"></a> |
| 213 |
<h2 class="memtitle"><span class="permalink"><a href="#a625435077e0760c8f484b1f4109314d9">◆ </a></span>quotedToAllTest</h2> |
| 214 |
|
| 215 |
<div class="memitem"> |
| 216 |
<div class="memproto"> |
| 217 |
<table class="memname"> |
| 218 |
<tr> |
| 219 |
<td class="memname"><a class="el" href="structRatioRating.html">RatioRating</a> Options::quotedToAllTest</td> |
| 220 |
</tr> |
| 221 |
</table> |
| 222 |
</div><div class="memdoc"> |
| 223 |
|
| 224 |
<p>Rating options for the <a class="el" href="index.html#doc_quotedToAllTest">Ratio Quoted Lines To All Lines Test (quotedToAllTest)</a>. </p> |
| 225 |
|
| 226 |
</div> |
| 227 |
</div> |
| 228 |
<a id="a75852fb51d45dd48c139deb58c6af336"></a> |
| 229 |
<h2 class="memtitle"><span class="permalink"><a href="#a75852fb51d45dd48c139deb58c6af336">◆ </a></span>bottomQuotedToAllTest</h2> |
| 230 |
|
| 231 |
<div class="memitem"> |
| 232 |
<div class="memproto"> |
| 233 |
<table class="memname"> |
| 234 |
<tr> |
| 235 |
<td class="memname"><a class="el" href="structRatioRating.html">RatioRating</a> Options::bottomQuotedToAllTest</td> |
| 236 |
</tr> |
| 237 |
</table> |
| 238 |
</div><div class="memdoc"> |
| 239 |
|
| 240 |
<p>Rating options for the <a class="el" href="index.html#doc_bottomQuotedToAllTest">Ratio Quoted Lines At Bottom Of The Mail To All Lines Test (bottomQuotedToAllTest)</a>. </p> |
| 241 |
|
| 242 |
</div> |
| 243 |
</div> |
| 244 |
<a id="a6e4841f3f5a6c0f3ef48287ff19f45ee"></a> |
| 245 |
<h2 class="memtitle"><span class="permalink"><a href="#a6e4841f3f5a6c0f3ef48287ff19f45ee">◆ </a></span>bottomQuotedToQuotedTest</h2> |
| 246 |
|
| 247 |
<div class="memitem"> |
| 248 |
<div class="memproto"> |
| 249 |
<table class="memname"> |
| 250 |
<tr> |
| 251 |
<td class="memname"><a class="el" href="structRatioRating.html">RatioRating</a> Options::bottomQuotedToQuotedTest</td> |
| 252 |
</tr> |
| 253 |
</table> |
| 254 |
</div><div class="memdoc"> |
| 255 |
|
| 256 |
<p>Rating options for the <a class="el" href="index.html#doc_bottomQuotedToQuotedTest">Ratio Quoted Lines At Bottom Of The Mail To Quoted Lines Test (bottomQuotedToQuotedTest)</a>. </p> |
| 257 |
|
| 258 |
</div> |
| 259 |
</div> |
| 260 |
<a id="adf91188c340583fffc590cd9d1d63369"></a> |
| 261 |
<h2 class="memtitle"><span class="permalink"><a href="#adf91188c340583fffc590cd9d1d63369">◆ </a></span>singleBottomQuoteTest</h2> |
| 262 |
|
| 263 |
<div class="memitem"> |
| 264 |
<div class="memproto"> |
| 265 |
<table class="memname"> |
| 266 |
<tr> |
| 267 |
<td class="memname"><a class="el" href="structBoolRating.html">BoolRating</a> Options::singleBottomQuoteTest</td> |
| 268 |
</tr> |
| 269 |
</table> |
| 270 |
</div><div class="memdoc"> |
| 271 |
|
| 272 |
<p>Rating options for the <a class="el" href="index.html#doc_singleBottomQuoteTest">Single Quote Block At The Bottom of The Mail Test (mailSingleBottomQuote)</a>. </p> |
| 273 |
|
| 274 |
</div> |
| 275 |
</div> |
| 276 |
<hr/>The documentation for this struct was generated from the following file:<ul> |
| 277 |
<li><a class="el" href="fullquottel_8cpp.html">fullquottel.cpp</a></li> |
| 278 |
</ul> |
| 279 |
</div><!-- contents --> |
| 280 |
<!-- start footer part --> |
| 281 |
<hr class="footer"/><address class="footer"><small> |
| 282 |
Generated on Fri Mar 5 2021 19:45:53 for fullquottel by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 |
| 283 |
</small></address> |
| 284 |
</body> |
| 285 |
</html> |