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
|
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Class: RMail::Parser</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link rel=StyleSheet href="../.././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript" language="JavaScript">
<!--
function popCode(url) {
window.open(url, "Code",
"resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}
//-->
</script>
</head>
<body bgcolor="white">
<table summary="Information on class" width="100%" border="0" cellspacing="0">
<tr class="title-row">
<td class="big-title-font">
<sup><font color="aqua">Class</font></sup> RMail::Parser
</td>
<td align="right">
<table summary="layout" cellspacing="0" cellpadding="2">
<tr valign="top">
<td class="small-title-font">In:</td>
<td class="small-title-font">
<a href="../../files/lib/rmail/parser/pushbackreader_rb.html" class="aqua">
lib/rmail/parser/pushbackreader.rb
</a>
<br />
<a href="../../files/lib/rmail/parser/multipart_rb.html" class="aqua">
lib/rmail/parser/multipart.rb
</a>
<br />
<a href="../../files/lib/rmail/parser_rb.html" class="aqua">
lib/rmail/parser.rb
</a>
<br />
</td>
</tr>
<tr>
<td class="small-title-font">Parent:</td>
<td class="small-title-font">
Object
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- banner header -->
<div class="description"><p>
The <a href="Parser.html">RMail::Parser</a> class creates <a
href="Message.html">RMail::Message</a> objects from Ruby IO objects or
strings.
</p>
<p>
To parse from a string:
</p>
<pre>
message = RMail::Parser.read(the_string)
</pre>
<p>
To parse from an IO object:
</p>
<pre>
message = File.open('my-message') { |f|
RMail::Parser.read(f)
}
</pre>
<p>
You can also parse from STDIN, etc.
</p>
<pre>
message = RMail::Parser.read(STDIN)
</pre>
<p>
In all cases, the parser consumes all input.
</p>
</div>
<table summary="Methods" cellpadding="5" width="100%">
<tr><td class="tablesubtitle">Methods</td></tr>
</table>
<div class="name-list">
<a href="#M000023">new</a>
<a href="#M000024">parse</a>
<a href="#M000025">read</a>
</div>
<table summary="Attributes" cellpadding="5" width="100%">
<tr><td class="tablesubtitle">Attributes</td></tr>
</table>
<table summary="Attribute details" cellspacing="5">
<tr valign="top">
<td class="attr-name">chunk_size</td>
<td align="center" class="attr-rw"> [RW] </td>
<td><p>
Change the chunk size used to read the message. This is useful mostly for
testing.
</p>
</td>
</tr>
</table>
<table summary="List of classes" cellpadding="5" width="100%">
<tr><td class="tablesubtitle">Classes and Modules</td></tr>
</table>
<div class="classlist">
Class <a href="Parser/Error.html" class="link">RMail::Parser::Error</a><br />
</div>
<table summary="Method list" cellpadding="5" width="100%">
<tr><td class="tablesubtitle">Public Class methods</td></tr>
</table>
<table summary="method" width="100%" cellspacing="0" cellpadding="5" border="0">
<tr><td class="methodtitle">
<a name="M000023"></a>
<a href="Parser.src/M000023.html" target="Code" class="methodtitle"
onClick="popCode('Parser.src/M000023.html');return false;">
<b>new</b>()
</a>
</td></tr>
</table>
<div class="description">
<p>
Creates a new parser. Messages of <tt>message_class</tt> will be created by
the parser. By default, the parser will create <a
href="Message.html">RMail::Message</a> objects.
</p>
</div>
<table summary="method" width="100%" cellspacing="0" cellpadding="5" border="0">
<tr><td class="methodtitle">
<a name="M000025"></a>
<a href="Parser.src/M000025.html" target="Code" class="methodtitle"
onClick="popCode('Parser.src/M000025.html');return false;">
<b>read</b>(input)
</a>
</td></tr>
</table>
<div class="description">
<p>
Parse a message from the IO object <tt>io</tt> and return a new message.
The <tt>io</tt> object can also be a string. This is just shorthand for:
</p>
<pre>
RMail::Parser.new.parse(io)
</pre>
</div>
<table summary="Method list" cellpadding="5" width="100%">
<tr><td class="tablesubtitle">Public Instance methods</td></tr>
</table>
<table summary="method" width="100%" cellspacing="0" cellpadding="5" border="0">
<tr><td class="methodtitle">
<a name="M000024"></a>
<a href="Parser.src/M000024.html" target="Code" class="methodtitle"
onClick="popCode('Parser.src/M000024.html');return false;">
<b>parse</b>(input)
</a>
</td></tr>
</table>
<div class="description">
<p>
Parse a message from the IO object <tt>io</tt> and return a new message.
The <tt>io</tt> object can also be a string.
</p>
</div>
</body>
</html>
|
