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
|
(***********************************************************************)
(* *)
(* SpamOracle -- a Bayesian spam filter *)
(* *)
(* Xavier Leroy, projet Cristal, INRIA Rocquencourt *)
(* *)
(* Copyright 2002 Institut National de Recherche en Informatique et *)
(* en Automatique. This file is distributed under the terms of the *)
(* GNU Public License version 2, http://www.gnu.org/licenses/gpl.txt *)
(* *)
(***********************************************************************)
(* $Id: mbox.mli,v 1.3 2002/08/26 09:35:25 xleroy Exp $ *)
(** Reading of a mailbox file and splitting into individual messages *)
type t
(** The type of channels opened on a mailbox *)
val open_mbox_file: string -> t
(** Open the given file name as a mailbox, and return an mbox channel
ready for reading. If the file name ends in [.gz], arrange
for on-the-fly decompression with [zcat]. *)
val open_mbox_channel: in_channel -> t
(** Open the given input channel as a mailbox. *)
val read_msg: t -> string
(** Read the next message from the given channel, and return it
as a string. Raise [End_of_file] if no message remains. *)
val close_mbox: t -> unit
(** Close the given mbox channel. *)
val mbox_file_iter: string -> (string -> unit) -> unit
(** [mbox_file_iter filename fn] reads messages from the file named
[filename], and applies [fn] in turn to each message. *)
val mbox_channel_iter: in_channel -> (string -> unit) -> unit
(** [mbox_channel_iter ic fn] reads messages from the input channel
[ic], and applies [fn] in turn to each message. *)
val read_single_msg: in_channel -> string
(** Read one message from the given channel, up to end of file *)
|
