summaryrefslogtreecommitdiffstats
path: root/doc/html/namespaceTypes.html
blob: c4c446084c5f3ba55d3df2a441f226f47cc78dd4 (plain)
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>kshowmail.kdevelop: Types Namespace Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.0 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li id="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li><a href="classes.html"><span>Classes</span></a></li>
    <li><a href="files.html"><span>Files</span></a></li>
    <li><a href="dirs.html"><span>Directories</span></a></li>
  </ul></div>
<div class="tabs">
  <ul>
    <li><a href="namespaces.html"><span>Namespace List</span></a></li>
    <li><a href="namespacemembers.html"><span>Namespace&nbsp;Members</span></a></li>
  </ul></div>
<h1>Types Namespace Reference</h1>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTypes_1_1DownloadActionParams__Type.html">DownloadActionParams_Type</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTypes_1_1FilterCriteria__Type.html">FilterCriteria_Type</a></td></tr>

<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef QValueList&lt; int &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceTypes.html#48fad16d3707caeaf47bb1e8fab4be55">MailNumberList_Type</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef QMap&lt; QString, bool &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceTypes.html#ca963e9ff87e4dfc99a0123af22c0346">AccountTaskMap_Type</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef QMap&lt; int, <a class="el" href="structTypes_1_1DownloadActionParams__Type.html">DownloadActionParams_Type</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceTypes.html#28b7da8de2bbe1b7a098d41242e78ab7">MailToDownloadMap_Type</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef list&lt; <a class="el" href="structTypes_1_1FilterCriteria__Type.html">FilterCriteria_Type</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceTypes.html#2eaafd5612933c2e6ab8dd15593969a2">FilterCriteriaList_Type</a></td></tr>

<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceTypes.html#dc227eb5720632a8290561b001aaa565">State_Type</a> { <br>
&nbsp;&nbsp;<a class="el" href="namespaceTypes.html#dc227eb5720632a8290561b001aaa565c37aa546c58cdb9c8efabbbe513f8380">idle</a>, 
<a class="el" href="namespaceTypes.html#dc227eb5720632a8290561b001aaa565f49cd232f53f8851506c138924f2ec65">deleting</a>, 
<a class="el" href="namespaceTypes.html#dc227eb5720632a8290561b001aaa5653cde4c681a768eef7df3659c849a34b6">configure</a>, 
<a class="el" href="namespaceTypes.html#dc227eb5720632a8290561b001aaa56575f7f7187ee9497e63584b0ccb17a919">executing</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="namespaceTypes.html#dc227eb5720632a8290561b001aaa5655ee02dbb2bbc5f45a1a2517f7536c77c">showing</a>, 
<a class="el" href="namespaceTypes.html#dc227eb5720632a8290561b001aaa56592bd813e8e24cdf9c233a4cf26ebb691">refreshing</a>
<br>
 }</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceTypes.html#57c868019acd102e855ff50f6043c1b6">AccountState_Type</a> { <a class="el" href="namespaceTypes.html#57c868019acd102e855ff50f6043c1b6a15826a259a1b9518c05738511bca3c7">AccountIdle</a>, 
<a class="el" href="namespaceTypes.html#57c868019acd102e855ff50f6043c1b6c13599f1c51b33a59b319794917ccff5">AccountDeleting</a>, 
<a class="el" href="namespaceTypes.html#57c868019acd102e855ff50f6043c1b63accada2afa1ad270e3b25c14cae5fd9">AccountDownloading</a>, 
<a class="el" href="namespaceTypes.html#57c868019acd102e855ff50f6043c1b6ba5316f9cbdb41a05f75ebe4976865b9">AccountRefreshing</a>
 }</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceTypes.html#ce032cf029e8037fd21721b33e3a6adf">FilterAction_Type</a> { <br>
&nbsp;&nbsp;<a class="el" href="namespaceTypes.html#ce032cf029e8037fd21721b33e3a6adf0e2f723024c86b001d2c0d50cc70e456">FActPass</a>, 
<a class="el" href="namespaceTypes.html#ce032cf029e8037fd21721b33e3a6adf9de5e046888ae556dd3f4548957fcf10">FActDelete</a>, 
<a class="el" href="namespaceTypes.html#ce032cf029e8037fd21721b33e3a6adf0b8c53628aabb517f41d6ccdf5bf5d4c">FActMark</a>, 
<a class="el" href="namespaceTypes.html#ce032cf029e8037fd21721b33e3a6adf4f2a44934f9b85ed07832ccf32016462">FActMove</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="namespaceTypes.html#ce032cf029e8037fd21721b33e3a6adfc54805588ea5ecd697098c55a3ec73a1">FActSpamcheck</a>, 
<a class="el" href="namespaceTypes.html#ce032cf029e8037fd21721b33e3a6adf6b838ac6d09fdaade0e40f4a50d33b68">FActIgnore</a>, 
<a class="el" href="namespaceTypes.html#ce032cf029e8037fd21721b33e3a6adfb62372bfae14c67a307649aa9f2f7f34">FActNone</a>
<br>
 }</td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
All special types for KShowMail. 
<p>
<hr><h2>Typedef Documentation</h2>
<a class="anchor" name="ca963e9ff87e4dfc99a0123af22c0346"></a><!-- doxytag: member="Types::AccountTaskMap_Type" ref="ca963e9ff87e4dfc99a0123af22c0346" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef QMap&lt;QString, bool&gt; <a class="el" href="namespaceTypes.html#ca963e9ff87e4dfc99a0123af22c0346">Types::AccountTaskMap_Type</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Map to notice which accounts need to get an order to do a task. The Key is the account name and the data a boolean. TRUE means the task was ordered, FALSE the task was ended. 
</div>
</div><p>
<a class="anchor" name="2eaafd5612933c2e6ab8dd15593969a2"></a><!-- doxytag: member="Types::FilterCriteriaList_Type" ref="2eaafd5612933c2e6ab8dd15593969a2" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef list&lt;<a class="el" href="structTypes_1_1FilterCriteria__Type.html">FilterCriteria_Type</a>&gt; <a class="el" href="namespaceTypes.html#2eaafd5612933c2e6ab8dd15593969a2">Types::FilterCriteriaList_Type</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
List of filter criterias. 
</div>
</div><p>
<a class="anchor" name="48fad16d3707caeaf47bb1e8fab4be55"></a><!-- doxytag: member="Types::MailNumberList_Type" ref="48fad16d3707caeaf47bb1e8fab4be55" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef QValueList&lt;int&gt; <a class="el" href="namespaceTypes.html#48fad16d3707caeaf47bb1e8fab4be55">Types::MailNumberList_Type</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
List of mail numbers. It is a QValueList of integers. 
</div>
</div><p>
<a class="anchor" name="28b7da8de2bbe1b7a098d41242e78ab7"></a><!-- doxytag: member="Types::MailToDownloadMap_Type" ref="28b7da8de2bbe1b7a098d41242e78ab7" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef QMap&lt;int, <a class="el" href="structTypes_1_1DownloadActionParams__Type.html">DownloadActionParams_Type</a>&gt; <a class="el" href="namespaceTypes.html#28b7da8de2bbe1b7a098d41242e78ab7">Types::MailToDownloadMap_Type</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
This map is used by <a class="el" href="classConfigElem.html">ConfigElem</a> and <a class="el" href="classShowRecord.html">ShowRecord</a> to hold a list of mail numbers which shall be downloaded for some filter actions; at time for moving and spam check 
</div>
</div><p>
<hr><h2>Enumeration Type Documentation</h2>
<a class="anchor" name="57c868019acd102e855ff50f6043c1b6"></a><!-- doxytag: member="Types::AccountState_Type" ref="57c868019acd102e855ff50f6043c1b6" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="namespaceTypes.html#57c868019acd102e855ff50f6043c1b6">Types::AccountState_Type</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
State of an account. <dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="57c868019acd102e855ff50f6043c1b6a15826a259a1b9518c05738511bca3c7"></a><!-- doxytag: member="AccountIdle" ref="57c868019acd102e855ff50f6043c1b6a15826a259a1b9518c05738511bca3c7" args="" -->AccountIdle</em>&nbsp;</td><td>
it's doing nothing </td></tr>
<tr><td valign="top"><em><a class="anchor" name="57c868019acd102e855ff50f6043c1b6c13599f1c51b33a59b319794917ccff5"></a><!-- doxytag: member="AccountDeleting" ref="57c868019acd102e855ff50f6043c1b6c13599f1c51b33a59b319794917ccff5" args="" -->AccountDeleting</em>&nbsp;</td><td>
a deletion is running </td></tr>
<tr><td valign="top"><em><a class="anchor" name="57c868019acd102e855ff50f6043c1b63accada2afa1ad270e3b25c14cae5fd9"></a><!-- doxytag: member="AccountDownloading" ref="57c868019acd102e855ff50f6043c1b63accada2afa1ad270e3b25c14cae5fd9" args="" -->AccountDownloading</em>&nbsp;</td><td>
the account is downloading mail bodies </td></tr>
<tr><td valign="top"><em><a class="anchor" name="57c868019acd102e855ff50f6043c1b6ba5316f9cbdb41a05f75ebe4976865b9"></a><!-- doxytag: member="AccountRefreshing" ref="57c868019acd102e855ff50f6043c1b6ba5316f9cbdb41a05f75ebe4976865b9" args="" -->AccountRefreshing</em>&nbsp;</td><td>
the account is refreshing its mail list </td></tr>
</table>
</dl>

</div>
</div><p>
<a class="anchor" name="ce032cf029e8037fd21721b33e3a6adf"></a><!-- doxytag: member="Types::FilterAction_Type" ref="ce032cf029e8037fd21721b33e3a6adf" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="namespaceTypes.html#ce032cf029e8037fd21721b33e3a6adf">Types::FilterAction_Type</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Actions returned by filters. <dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="ce032cf029e8037fd21721b33e3a6adf0e2f723024c86b001d2c0d50cc70e456"></a><!-- doxytag: member="FActPass" ref="ce032cf029e8037fd21721b33e3a6adf0e2f723024c86b001d2c0d50cc70e456" args="" -->FActPass</em>&nbsp;</td><td>
Mail has passed the filter check. It can showed in the list. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="ce032cf029e8037fd21721b33e3a6adf9de5e046888ae556dd3f4548957fcf10"></a><!-- doxytag: member="FActDelete" ref="ce032cf029e8037fd21721b33e3a6adf9de5e046888ae556dd3f4548957fcf10" args="" -->FActDelete</em>&nbsp;</td><td>
Undesirable mail. Delete it. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="ce032cf029e8037fd21721b33e3a6adf0b8c53628aabb517f41d6ccdf5bf5d4c"></a><!-- doxytag: member="FActMark" ref="ce032cf029e8037fd21721b33e3a6adf0b8c53628aabb517f41d6ccdf5bf5d4c" args="" -->FActMark</em>&nbsp;</td><td>
Probably undesirable mail. Mark it in the mail list. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="ce032cf029e8037fd21721b33e3a6adf4f2a44934f9b85ed07832ccf32016462"></a><!-- doxytag: member="FActMove" ref="ce032cf029e8037fd21721b33e3a6adf4f2a44934f9b85ed07832ccf32016462" args="" -->FActMove</em>&nbsp;</td><td>
Move the mail to a certain mail box. The name of the box will returned by a further parameter. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="ce032cf029e8037fd21721b33e3a6adfc54805588ea5ecd697098c55a3ec73a1"></a><!-- doxytag: member="FActSpamcheck" ref="ce032cf029e8037fd21721b33e3a6adfc54805588ea5ecd697098c55a3ec73a1" args="" -->FActSpamcheck</em>&nbsp;</td><td>
This mail shall be forwared to a spam filter, which checks the whole mail including body. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="ce032cf029e8037fd21721b33e3a6adf6b838ac6d09fdaade0e40f4a50d33b68"></a><!-- doxytag: member="FActIgnore" ref="ce032cf029e8037fd21721b33e3a6adf6b838ac6d09fdaade0e40f4a50d33b68" args="" -->FActIgnore</em>&nbsp;</td><td>
This mail shall not be shown. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="ce032cf029e8037fd21721b33e3a6adfb62372bfae14c67a307649aa9f2f7f34"></a><!-- doxytag: member="FActNone" ref="ce032cf029e8037fd21721b33e3a6adfb62372bfae14c67a307649aa9f2f7f34" args="" -->FActNone</em>&nbsp;</td><td>
The mail doesn't match up with the filter. Perform the next one. </td></tr>
</table>
</dl>

</div>
</div><p>
<a class="anchor" name="dc227eb5720632a8290561b001aaa565"></a><!-- doxytag: member="Types::State_Type" ref="dc227eb5720632a8290561b001aaa565" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="namespaceTypes.html#dc227eb5720632a8290561b001aaa565">Types::State_Type</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
State of the application during running time. <dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="dc227eb5720632a8290561b001aaa565c37aa546c58cdb9c8efabbbe513f8380"></a><!-- doxytag: member="idle" ref="dc227eb5720632a8290561b001aaa565c37aa546c58cdb9c8efabbbe513f8380" args="" -->idle</em>&nbsp;</td><td>
it's doing nothing </td></tr>
<tr><td valign="top"><em><a class="anchor" name="dc227eb5720632a8290561b001aaa565f49cd232f53f8851506c138924f2ec65"></a><!-- doxytag: member="deleting" ref="dc227eb5720632a8290561b001aaa565f49cd232f53f8851506c138924f2ec65" args="" -->deleting</em>&nbsp;</td><td>
it's deleting a message on the server </td></tr>
<tr><td valign="top"><em><a class="anchor" name="dc227eb5720632a8290561b001aaa5653cde4c681a768eef7df3659c849a34b6"></a><!-- doxytag: member="configure" ref="dc227eb5720632a8290561b001aaa5653cde4c681a768eef7df3659c849a34b6" args="" -->configure</em>&nbsp;</td><td>
the user is configuring the application or the mail or just the header of the mail is being shown </td></tr>
<tr><td valign="top"><em><a class="anchor" name="dc227eb5720632a8290561b001aaa56575f7f7187ee9497e63584b0ccb17a919"></a><!-- doxytag: member="executing" ref="dc227eb5720632a8290561b001aaa56575f7f7187ee9497e63584b0ccb17a919" args="" -->executing</em>&nbsp;</td><td>
a command on the command list is being executed </td></tr>
<tr><td valign="top"><em><a class="anchor" name="dc227eb5720632a8290561b001aaa5655ee02dbb2bbc5f45a1a2517f7536c77c"></a><!-- doxytag: member="showing" ref="dc227eb5720632a8290561b001aaa5655ee02dbb2bbc5f45a1a2517f7536c77c" args="" -->showing</em>&nbsp;</td><td>
it's downloading and showing a mail </td></tr>
<tr><td valign="top"><em><a class="anchor" name="dc227eb5720632a8290561b001aaa56592bd813e8e24cdf9c233a4cf26ebb691"></a><!-- doxytag: member="refreshing" ref="dc227eb5720632a8290561b001aaa56592bd813e8e24cdf9c233a4cf26ebb691" args="" -->refreshing</em>&nbsp;</td><td>
it's refreshing the mail lists </td></tr>
</table>
</dl>

</div>
</div><p>
<hr size="1"><address style="align: right;"><small>Generated on Tue Apr 1 21:59:50 2008 for kshowmail.kdevelop by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.0 </small></address>
</body>
</html>