← Back to branch summary

~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick-proposed

« back to all changes in this revision

Viewing changes to docs/reference/camel/html/camel-CamelFilterDriver.html

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
https://launchpad.net/bugs/42199
https://launchpad.net/bugs/229669
https://launchpad.net/bugs/173703
https://launchpad.net/bugs/360344
https://launchpad.net/bugs/508494
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    - install html documentation
  + debian/rules:
    - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/camel/html/camel-CamelFilterDriver.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>CamelFilterDriver</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
7
<link rel="home" href="index.html" title="Camel Reference Manual">
8
8
<link rel="up" href="Filters.html" title="Filters">
9
9
<link rel="prev" href="Filters.html" title="Filters">
26
26
                  <a href="#camel-CamelFilterDriver.description" class="shortcut">Description</a>
27
27
</td></tr>
28
28
</table>
29
 
<div class="refentry" lang="en">
 
29
<div class="refentry" title="CamelFilterDriver">
30
30
<a name="camel-CamelFilterDriver"></a><div class="titlepage"></div>
31
31
<div class="refnamediv"><table width="100%"><tr>
32
32
<td valign="top">
35
35
</td>
36
36
<td valign="top" align="right"></td>
37
37
</tr></table></div>
38
 
<div class="refsynopsisdiv">
 
38
<div class="refsynopsisdiv" title="Synopsis">
39
39
<a name="camel-CamelFilterDriver.synopsis"></a><h2>Synopsis</h2>
40
40
<pre class="synopsis">struct              <a class="link" href="camel-CamelFilterDriver.html#CamelFilterDriver" title="struct CamelFilterDriver">CamelFilterDriver</a>;
41
41
<a class="link" href="camel-CamelFolder.html#CamelFolder" title="struct CamelFolder"><span class="returnvalue">CamelFolder</span></a> *       (<a class="link" href="camel-CamelFilterDriver.html#CamelFilterGetFolderFunc" title="CamelFilterGetFolderFunc ()">*CamelFilterGetFolderFunc</a>)         (<em class="parameter"><code><a class="link" href="camel-CamelFilterDriver.html#CamelFilterDriver" title="struct CamelFilterDriver"><span class="type">CamelFilterDriver</span></a> *driver</code></em>,
92
92
                                                         <em class="parameter"><code><span class="type">GPtrArray</span> *uids</code></em>,
93
93
                                                         <em class="parameter"><code><span class="type">gboolean</span> remove</code></em>,
94
94
                                                         <em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex</code></em>);
95
 
<span class="returnvalue">void</span>                <a class="link" href="camel-CamelFilterDriver.html#camel-filter-driver-expand-option" title="camel_filter_driver_expand_option ()">camel_filter_driver_expand_option</a>   (<em class="parameter"><code><a class="link" href="camel-CamelFilterDriver.html#CamelFilterDriver" title="struct CamelFilterDriver"><span class="type">CamelFilterDriver</span></a> *d</code></em>,
96
 
                                                         <em class="parameter"><code><span class="type">GString</span> *s</code></em>,
97
 
                                                         <em class="parameter"><code><span class="type">GString</span> *action</code></em>,
98
 
                                                         <em class="parameter"><code><span class="type">struct filter_option</span> *op</code></em>);
99
 
<span class="returnvalue">gint</span>                <a class="link" href="camel-CamelFilterDriver.html#camel-filter-driver-rule-count" title="camel_filter_driver_rule_count ()">camel_filter_driver_rule_count</a>      (<em class="parameter"><code><a class="link" href="camel-CamelFilterDriver.html#CamelFilterDriver" title="struct CamelFilterDriver"><span class="type">CamelFilterDriver</span></a> *d</code></em>);
100
 
struct <span class="returnvalue">filter_option</span> * <a class="link" href="camel-CamelFilterDriver.html#camel-filter-driver-rule-get" title="camel_filter_driver_rule_get ()">camel_filter_driver_rule_get</a>     (<em class="parameter"><code><a class="link" href="camel-CamelFilterDriver.html#CamelFilterDriver" title="struct CamelFilterDriver"><span class="type">CamelFilterDriver</span></a> *d</code></em>,
101
 
                                                         <em class="parameter"><code><span class="type">gint</span> n</code></em>);
102
95
</pre>
103
96
</div>
104
 
<div class="refsect1" lang="en">
 
97
<div class="refsect1" title="Description">
105
98
<a name="camel-CamelFilterDriver.description"></a><h2>Description</h2>
106
99
<p>
107
100
</p>
108
101
</div>
109
 
<div class="refsect1" lang="en">
 
102
<div class="refsect1" title="Details">
110
103
<a name="camel-CamelFilterDriver.details"></a><h2>Details</h2>
111
 
<div class="refsect2" lang="en">
 
104
<div class="refsect2" title="struct CamelFilterDriver">
112
105
<a name="CamelFilterDriver"></a><h3>struct CamelFilterDriver</h3>
113
106
<pre class="programlisting">struct CamelFilterDriver {
114
107
        CamelObject parent;
120
113
</p>
121
114
</div>
122
115
<hr>
123
 
<div class="refsect2" lang="en">
 
116
<div class="refsect2" title="CamelFilterGetFolderFunc ()">
124
117
<a name="CamelFilterGetFolderFunc"></a><h3>CamelFilterGetFolderFunc ()</h3>
125
118
<pre class="programlisting"><a class="link" href="camel-CamelFolder.html#CamelFolder" title="struct CamelFolder"><span class="returnvalue">CamelFolder</span></a> *       (*CamelFilterGetFolderFunc)         (<em class="parameter"><code><a class="link" href="camel-CamelFilterDriver.html#CamelFilterDriver" title="struct CamelFilterDriver"><span class="type">CamelFilterDriver</span></a> *driver</code></em>,
126
119
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *uri</code></em>,
160
153
</table></div>
161
154
</div>
162
155
<hr>
163
 
<div class="refsect2" lang="en">
 
156
<div class="refsect2" title="camel_filter_driver_new ()">
164
157
<a name="camel-filter-driver-new"></a><h3>camel_filter_driver_new ()</h3>
165
158
<pre class="programlisting"><a class="link" href="camel-CamelFilterDriver.html#CamelFilterDriver" title="struct CamelFilterDriver"><span class="returnvalue">CamelFilterDriver</span></a> * camel_filter_driver_new             (<em class="parameter"><code><a class="link" href="camel-CamelSession.html#CamelSession" title="struct CamelSession"><span class="type">CamelSession</span></a> *Param1</code></em>);</pre>
166
159
<div class="variablelist"><table border="0">
180
173
</table></div>
181
174
</div>
182
175
<hr>
183
 
<div class="refsect2" lang="en">
 
176
<div class="refsect2" title="camel_filter_driver_set_logfile ()">
184
177
<a name="camel-filter-driver-set-logfile"></a><h3>camel_filter_driver_set_logfile ()</h3>
185
178
<pre class="programlisting"><span class="returnvalue">void</span>                camel_filter_driver_set_logfile     (<em class="parameter"><code><a class="link" href="camel-CamelFilterDriver.html#CamelFilterDriver" title="struct CamelFilterDriver"><span class="type">CamelFilterDriver</span></a> *d</code></em>,
186
179
                                                         <em class="parameter"><code><span class="type">FILE</span> *logfile</code></em>);</pre>
203
196
</table></div>
204
197
</div>
205
198
<hr>
206
 
<div class="refsect2" lang="en">
 
199
<div class="refsect2" title="camel_filter_driver_set_status_func ()">
207
200
<a name="camel-filter-driver-set-status-func"></a><h3>camel_filter_driver_set_status_func ()</h3>
208
201
<pre class="programlisting"><span class="returnvalue">void</span>                camel_filter_driver_set_status_func (<em class="parameter"><code><a class="link" href="camel-CamelFilterDriver.html#CamelFilterDriver" title="struct CamelFilterDriver"><span class="type">CamelFilterDriver</span></a> *d</code></em>,
209
202
                                                         <em class="parameter"><code><span class="type">CamelFilterStatusFunc</span> *func</code></em>,
232
225
</table></div>
233
226
</div>
234
227
<hr>
235
 
<div class="refsect2" lang="en">
 
228
<div class="refsect2" title="camel_filter_driver_set_shell_func ()">
236
229
<a name="camel-filter-driver-set-shell-func"></a><h3>camel_filter_driver_set_shell_func ()</h3>
237
230
<pre class="programlisting"><span class="returnvalue">void</span>                camel_filter_driver_set_shell_func  (<em class="parameter"><code><a class="link" href="camel-CamelFilterDriver.html#CamelFilterDriver" title="struct CamelFilterDriver"><span class="type">CamelFilterDriver</span></a> *d</code></em>,
238
231
                                                         <em class="parameter"><code><span class="type">CamelFilterShellFunc</span> *func</code></em>,
261
254
</table></div>
262
255
</div>
263
256
<hr>
264
 
<div class="refsect2" lang="en">
 
257
<div class="refsect2" title="camel_filter_driver_set_play_sound_func ()">
265
258
<a name="camel-filter-driver-set-play-sound-func"></a><h3>camel_filter_driver_set_play_sound_func ()</h3>
266
259
<pre class="programlisting"><span class="returnvalue">void</span>                camel_filter_driver_set_play_sound_func
267
260
                                                        (<em class="parameter"><code><a class="link" href="camel-CamelFilterDriver.html#CamelFilterDriver" title="struct CamelFilterDriver"><span class="type">CamelFilterDriver</span></a> *d</code></em>,
291
284
</table></div>
292
285
</div>
293
286
<hr>
294
 
<div class="refsect2" lang="en">
 
287
<div class="refsect2" title="camel_filter_driver_set_system_beep_func ()">
295
288
<a name="camel-filter-driver-set-system-beep-func"></a><h3>camel_filter_driver_set_system_beep_func ()</h3>
296
289
<pre class="programlisting"><span class="returnvalue">void</span>                camel_filter_driver_set_system_beep_func
297
290
                                                        (<em class="parameter"><code><a class="link" href="camel-CamelFilterDriver.html#CamelFilterDriver" title="struct CamelFilterDriver"><span class="type">CamelFilterDriver</span></a> *d</code></em>,
321
314
</table></div>
322
315
</div>
323
316
<hr>
324
 
<div class="refsect2" lang="en">
 
317
<div class="refsect2" title="camel_filter_driver_set_folder_func ()">
325
318
<a name="camel-filter-driver-set-folder-func"></a><h3>camel_filter_driver_set_folder_func ()</h3>
326
319
<pre class="programlisting"><span class="returnvalue">void</span>                camel_filter_driver_set_folder_func (<em class="parameter"><code><a class="link" href="camel-CamelFilterDriver.html#CamelFilterDriver" title="struct CamelFilterDriver"><span class="type">CamelFilterDriver</span></a> *d</code></em>,
327
320
                                                         <em class="parameter"><code><a class="link" href="camel-CamelFilterDriver.html#CamelFilterGetFolderFunc" title="CamelFilterGetFolderFunc ()"><span class="type">CamelFilterGetFolderFunc</span></a> fetcher</code></em>,
350
343
</table></div>
351
344
</div>
352
345
<hr>
353
 
<div class="refsect2" lang="en">
 
346
<div class="refsect2" title="camel_filter_driver_set_default_folder ()">
354
347
<a name="camel-filter-driver-set-default-folder"></a><h3>camel_filter_driver_set_default_folder ()</h3>
355
348
<pre class="programlisting"><span class="returnvalue">void</span>                camel_filter_driver_set_default_folder
356
349
                                                        (<em class="parameter"><code><a class="link" href="camel-CamelFilterDriver.html#CamelFilterDriver" title="struct CamelFilterDriver"><span class="type">CamelFilterDriver</span></a> *d</code></em>,
374
367
</table></div>
375
368
</div>
376
369
<hr>
377
 
<div class="refsect2" lang="en">
 
370
<div class="refsect2" title="camel_filter_driver_add_rule ()">
378
371
<a name="camel-filter-driver-add-rule"></a><h3>camel_filter_driver_add_rule ()</h3>
379
372
<pre class="programlisting"><span class="returnvalue">void</span>                camel_filter_driver_add_rule        (<em class="parameter"><code><a class="link" href="camel-CamelFilterDriver.html#CamelFilterDriver" title="struct CamelFilterDriver"><span class="type">CamelFilterDriver</span></a> *d</code></em>,
380
373
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
409
402
</table></div>
410
403
</div>
411
404
<hr>
412
 
<div class="refsect2" lang="en">
 
405
<div class="refsect2" title="camel_filter_driver_remove_rule_by_name ()">
413
406
<a name="camel-filter-driver-remove-rule-by-name"></a><h3>camel_filter_driver_remove_rule_by_name ()</h3>
414
407
<pre class="programlisting"><span class="returnvalue">gint</span>                camel_filter_driver_remove_rule_by_name
415
408
                                                        (<em class="parameter"><code><a class="link" href="camel-CamelFilterDriver.html#CamelFilterDriver" title="struct CamelFilterDriver"><span class="type">CamelFilterDriver</span></a> *d</code></em>,
438
431
</table></div>
439
432
</div>
440
433
<hr>
441
 
<div class="refsect2" lang="en">
 
434
<div class="refsect2" title="camel_filter_driver_flush ()">
442
435
<a name="camel-filter-driver-flush"></a><h3>camel_filter_driver_flush ()</h3>
443
436
<pre class="programlisting"><span class="returnvalue">void</span>                camel_filter_driver_flush           (<em class="parameter"><code><a class="link" href="camel-CamelFilterDriver.html#CamelFilterDriver" title="struct CamelFilterDriver"><span class="type">CamelFilterDriver</span></a> *driver</code></em>,
444
437
                                                         <em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex</code></em>);</pre>
445
438
<p>
446
 
Flush all of the only-once filter actions.</p>
 
439
Flush all of the only-once filter actions.
 
440
</p>
447
441
</div>
448
442
<hr>
449
 
<div class="refsect2" lang="en">
 
443
<div class="refsect2" title="camel_filter_driver_filter_message ()">
450
444
<a name="camel-filter-driver-filter-message"></a><h3>camel_filter_driver_filter_message ()</h3>
451
445
<pre class="programlisting"><span class="returnvalue">gint</span>                camel_filter_driver_filter_message  (<em class="parameter"><code><a class="link" href="camel-CamelFilterDriver.html#CamelFilterDriver" title="struct CamelFilterDriver"><span class="type">CamelFilterDriver</span></a> *driver</code></em>,
452
446
                                                         <em class="parameter"><code><a class="link" href="camel-CamelMimeMessage.html#CamelMimeMessage" title="struct CamelMimeMessage"><span class="type">CamelMimeMessage</span></a> *message</code></em>,
461
455
object. If the source folder (<em class="parameter"><code>source</code></em>) and the uid (<em class="parameter"><code>uid</code></em>) are
462
456
provided, the filter will operate on the CamelFolder (which in
463
457
certain cases is more efficient than using the default
464
 
<a class="link" href="camel-CamelFolder.html#camel-folder-append-message" title="camel_folder_append_message ()"><code class="function">camel_folder_append_message()</code></a> function).</p>
 
458
<a class="link" href="camel-CamelFolder.html#camel-folder-append-message" title="camel_folder_append_message ()"><code class="function">camel_folder_append_message()</code></a> function).
 
459
</p>
465
460
<div class="variablelist"><table border="0">
466
461
<col align="left" valign="top">
467
462
<tbody>
516
511
</table></div>
517
512
</div>
518
513
<hr>
519
 
<div class="refsect2" lang="en">
 
514
<div class="refsect2" title="camel_filter_driver_filter_mbox ()">
520
515
<a name="camel-filter-driver-filter-mbox"></a><h3>camel_filter_driver_filter_mbox ()</h3>
521
516
<pre class="programlisting"><span class="returnvalue">gint</span>                camel_filter_driver_filter_mbox     (<em class="parameter"><code><a class="link" href="camel-CamelFilterDriver.html#CamelFilterDriver" title="struct CamelFilterDriver"><span class="type">CamelFilterDriver</span></a> *driver</code></em>,
522
517
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *mbox</code></em>,
525
520
<p>
526
521
Filters an mbox file based on rules defined in the FilterDriver
527
522
object. Is more efficient as it doesn't need to open the folder
528
 
through Camel directly.</p>
 
523
through Camel directly.
 
524
</p>
529
525
<div class="variablelist"><table border="0">
530
526
<col align="left" valign="top">
531
527
<tbody>
555
551
</table></div>
556
552
</div>
557
553
<hr>
558
 
<div class="refsect2" lang="en">
 
554
<div class="refsect2" title="camel_filter_driver_filter_folder ()">
559
555
<a name="camel-filter-driver-filter-folder"></a><h3>camel_filter_driver_filter_folder ()</h3>
560
556
<pre class="programlisting"><span class="returnvalue">gint</span>                camel_filter_driver_filter_folder   (<em class="parameter"><code><a class="link" href="camel-CamelFilterDriver.html#CamelFilterDriver" title="struct CamelFilterDriver"><span class="type">CamelFilterDriver</span></a> *driver</code></em>,
561
557
                                                         <em class="parameter"><code><a class="link" href="camel-CamelFolder.html#CamelFolder" title="struct CamelFolder"><span class="type">CamelFolder</span></a> *folder</code></em>,
565
561
                                                         <em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex</code></em>);</pre>
566
562
<p>
567
563
Filters a folder based on rules defined in the FilterDriver
568
 
object.</p>
 
564
object.
 
565
</p>
569
566
<div class="variablelist"><table border="0">
570
567
<col align="left" valign="top">
571
568
<tbody>
609
606
</tbody>
610
607
</table></div>
611
608
</div>
612
 
<hr>
613
 
<div class="refsect2" lang="en">
614
 
<a name="camel-filter-driver-expand-option"></a><h3>camel_filter_driver_expand_option ()</h3>
615
 
<pre class="programlisting"><span class="returnvalue">void</span>                camel_filter_driver_expand_option   (<em class="parameter"><code><a class="link" href="camel-CamelFilterDriver.html#CamelFilterDriver" title="struct CamelFilterDriver"><span class="type">CamelFilterDriver</span></a> *d</code></em>,
616
 
                                                         <em class="parameter"><code><span class="type">GString</span> *s</code></em>,
617
 
                                                         <em class="parameter"><code><span class="type">GString</span> *action</code></em>,
618
 
                                                         <em class="parameter"><code><span class="type">struct filter_option</span> *op</code></em>);</pre>
619
 
<p>
620
 
</p>
621
 
<div class="variablelist"><table border="0">
622
 
<col align="left" valign="top">
623
 
<tbody>
624
 
<tr>
625
 
<td><p><span class="term"><em class="parameter"><code>d</code></em> :</span></p></td>
626
 
<td>
627
 
</td>
628
 
</tr>
629
 
<tr>
630
 
<td><p><span class="term"><em class="parameter"><code>s</code></em> :</span></p></td>
631
 
<td>
632
 
</td>
633
 
</tr>
634
 
<tr>
635
 
<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
636
 
<td>
637
 
</td>
638
 
</tr>
639
 
<tr>
640
 
<td><p><span class="term"><em class="parameter"><code>op</code></em> :</span></p></td>
641
 
<td>
642
 
</td>
643
 
</tr>
644
 
</tbody>
645
 
</table></div>
646
 
</div>
647
 
<hr>
648
 
<div class="refsect2" lang="en">
649
 
<a name="camel-filter-driver-rule-count"></a><h3>camel_filter_driver_rule_count ()</h3>
650
 
<pre class="programlisting"><span class="returnvalue">gint</span>                camel_filter_driver_rule_count      (<em class="parameter"><code><a class="link" href="camel-CamelFilterDriver.html#CamelFilterDriver" title="struct CamelFilterDriver"><span class="type">CamelFilterDriver</span></a> *d</code></em>);</pre>
651
 
<p>
652
 
</p>
653
 
<div class="variablelist"><table border="0">
654
 
<col align="left" valign="top">
655
 
<tbody>
656
 
<tr>
657
 
<td><p><span class="term"><em class="parameter"><code>d</code></em> :</span></p></td>
658
 
<td>
659
 
</td>
660
 
</tr>
661
 
<tr>
662
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
663
 
<td>
664
 
</td>
665
 
</tr>
666
 
</tbody>
667
 
</table></div>
668
 
</div>
669
 
<hr>
670
 
<div class="refsect2" lang="en">
671
 
<a name="camel-filter-driver-rule-get"></a><h3>camel_filter_driver_rule_get ()</h3>
672
 
<pre class="programlisting">struct <span class="returnvalue">filter_option</span> * camel_filter_driver_rule_get     (<em class="parameter"><code><a class="link" href="camel-CamelFilterDriver.html#CamelFilterDriver" title="struct CamelFilterDriver"><span class="type">CamelFilterDriver</span></a> *d</code></em>,
673
 
                                                         <em class="parameter"><code><span class="type">gint</span> n</code></em>);</pre>
674
 
<p>
675
 
</p>
676
 
<div class="variablelist"><table border="0">
677
 
<col align="left" valign="top">
678
 
<tbody>
679
 
<tr>
680
 
<td><p><span class="term"><em class="parameter"><code>d</code></em> :</span></p></td>
681
 
<td>
682
 
</td>
683
 
</tr>
684
 
<tr>
685
 
<td><p><span class="term"><em class="parameter"><code>n</code></em> :</span></p></td>
686
 
<td>
687
 
</td>
688
 
</tr>
689
 
<tr>
690
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
691
 
<td>
692
 
</td>
693
 
</tr>
694
 
</tbody>
695
 
</table></div>
696
 
</div>
697
609
</div>
698
610
</div>
699
611
<div class="footer">