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
|
/*
* @license Apache-2.0
*
* Copyright (c) 2020 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// TypeScript Version: 2.0
/**
* Email object.
*/
interface Email {
/**
* Message id (relative to message group).
*/
id: string;
/**
* Message group.
*/
group: string;
/**
* Object containing checksum info.
*/
checksum: {
/**
* Checksum type (e.g., MD5).
*/
type: string;
/**
* Checksum value.
*/
value: string;
};
/**
* Message text (including headers).
*/
text: string;
}
/**
* Returns the Spam Assassin public email corpus.
*
* ## Notes
*
* - This function synchronously reads data from disk for each invocation. Such behavior is intentional and so is the avoidance of `require`. We assume that invocations are infrequent, and we want to avoid the `require` cache. This means that we allow data to be garbage collected and a user is responsible for explicitly caching data.
*
*
* @throws unable to read data
* @returns data
*
* @example
* var data = corpus();
* // returns [ {...}, {...}, ... ]
*/
declare function corpus(): Array<Email>;
// EXPORTS //
export = corpus;
|
