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
|
<refentry id="camel-camel-junk-plugin">
<refmeta>
<refentrytitle role="top_of_page" id="camel-camel-junk-plugin.top_of_page">camel-junk-plugin</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>CAMEL Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>camel-junk-plugin</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="camel-camel-junk-plugin.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
#define <link linkend="CAMEL-JUNK-PLUGIN:CAPS">CAMEL_JUNK_PLUGIN</link> (x)
<link linkend="CamelJunkPlugin">CamelJunkPlugin</link>;
const <link linkend="char">char</link>* <link linkend="camel-junk-plugin-get-name">camel_junk_plugin_get_name</link> (<link linkend="CamelJunkPlugin">CamelJunkPlugin</link> *csp);
<link linkend="int">int</link> <link linkend="camel-junk-plugin-check-junk">camel_junk_plugin_check_junk</link> (<link linkend="CamelJunkPlugin">CamelJunkPlugin</link> *csp,
<link linkend="struct--CamelMimeMessage">struct _CamelMimeMessage</link> *message);
<link linkend="void">void</link> <link linkend="camel-junk-plugin-report-junk">camel_junk_plugin_report_junk</link> (<link linkend="CamelJunkPlugin">CamelJunkPlugin</link> *csp,
<link linkend="struct--CamelMimeMessage">struct _CamelMimeMessage</link> *message);
<link linkend="void">void</link> <link linkend="camel-junk-plugin-report-notjunk">camel_junk_plugin_report_notjunk</link> (<link linkend="CamelJunkPlugin">CamelJunkPlugin</link> *csp,
<link linkend="struct--CamelMimeMessage">struct _CamelMimeMessage</link> *message);
<link linkend="void">void</link> <link linkend="camel-junk-plugin-commit-reports">camel_junk_plugin_commit_reports</link> (<link linkend="CamelJunkPlugin">CamelJunkPlugin</link> *csp);
<link linkend="void">void</link> <link linkend="camel-junk-plugin-init">camel_junk_plugin_init</link> (<link linkend="CamelJunkPlugin">CamelJunkPlugin</link> *csp);
</synopsis>
</refsynopsisdiv>
<refsect1 id="camel-camel-junk-plugin.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="camel-camel-junk-plugin.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="CAMEL-JUNK-PLUGIN:CAPS" role="macro">
<title>CAMEL_JUNK_PLUGIN()</title>
<indexterm zone="CAMEL-JUNK-PLUGIN:CAPS"><primary>CAMEL_JUNK_PLUGIN</primary></indexterm><programlisting>#define CAMEL_JUNK_PLUGIN(x) ((CamelJunkPlugin *) x)
</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>x</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="CamelJunkPlugin" role="struct">
<title>CamelJunkPlugin</title>
<indexterm zone="CamelJunkPlugin"><primary>CamelJunkPlugin</primary></indexterm><programlisting>typedef struct {
/* junk filter human readable name, translated */
const char * (*get_name) (struct _CamelJunkPlugin *csp);
/* should be set to 1 */
int api_version;
/* when called, it should return TRUE if message is identified as junk,
FALSE otherwise */
int (*check_junk) (struct _CamelJunkPlugin *csp, struct _CamelMimeMessage *message);
/* called when user identified a message to be junk */
void (*report_junk) (struct _CamelJunkPlugin *csp, struct _CamelMimeMessage *message);
/* called when user identified a message not to be junk */
void (*report_notjunk) (struct _CamelJunkPlugin *csp, struct _CamelMimeMessage *message);
/* called after one or more junk/ham(s) reported */
void (*commit_reports) (struct _CamelJunkPlugin *csp);
/* called before all other calls to junk plugin for initialization */
void (*init) (struct _CamelJunkPlugin *csp);
} CamelJunkPlugin;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="camel-junk-plugin-get-name" role="function">
<title>camel_junk_plugin_get_name ()</title>
<indexterm zone="camel-junk-plugin-get-name"><primary>camel_junk_plugin_get_name</primary></indexterm><programlisting>const <link linkend="char">char</link>* camel_junk_plugin_get_name (<link linkend="CamelJunkPlugin">CamelJunkPlugin</link> *csp);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>csp</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-junk-plugin-check-junk" role="function">
<title>camel_junk_plugin_check_junk ()</title>
<indexterm zone="camel-junk-plugin-check-junk"><primary>camel_junk_plugin_check_junk</primary></indexterm><programlisting><link linkend="int">int</link> camel_junk_plugin_check_junk (<link linkend="CamelJunkPlugin">CamelJunkPlugin</link> *csp,
<link linkend="struct--CamelMimeMessage">struct _CamelMimeMessage</link> *message);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>csp</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>message</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-junk-plugin-report-junk" role="function">
<title>camel_junk_plugin_report_junk ()</title>
<indexterm zone="camel-junk-plugin-report-junk"><primary>camel_junk_plugin_report_junk</primary></indexterm><programlisting><link linkend="void">void</link> camel_junk_plugin_report_junk (<link linkend="CamelJunkPlugin">CamelJunkPlugin</link> *csp,
<link linkend="struct--CamelMimeMessage">struct _CamelMimeMessage</link> *message);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>csp</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>message</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-junk-plugin-report-notjunk" role="function">
<title>camel_junk_plugin_report_notjunk ()</title>
<indexterm zone="camel-junk-plugin-report-notjunk"><primary>camel_junk_plugin_report_notjunk</primary></indexterm><programlisting><link linkend="void">void</link> camel_junk_plugin_report_notjunk (<link linkend="CamelJunkPlugin">CamelJunkPlugin</link> *csp,
<link linkend="struct--CamelMimeMessage">struct _CamelMimeMessage</link> *message);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>csp</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>message</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-junk-plugin-commit-reports" role="function">
<title>camel_junk_plugin_commit_reports ()</title>
<indexterm zone="camel-junk-plugin-commit-reports"><primary>camel_junk_plugin_commit_reports</primary></indexterm><programlisting><link linkend="void">void</link> camel_junk_plugin_commit_reports (<link linkend="CamelJunkPlugin">CamelJunkPlugin</link> *csp);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>csp</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-junk-plugin-init" role="function">
<title>camel_junk_plugin_init ()</title>
<indexterm zone="camel-junk-plugin-init"><primary>camel_junk_plugin_init</primary></indexterm><programlisting><link linkend="void">void</link> camel_junk_plugin_init (<link linkend="CamelJunkPlugin">CamelJunkPlugin</link> *csp);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>csp</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
