~ubuntu-branches/ubuntu/karmic/ocamlnet/karmic

<pre><span class="keyword">module</span> QuotedPrintable: <code class="code">sig</code> <a href="Netencoding.QuotedPrintable.html">..</a> <code class="code">end</code></pre><hr width="100%">

<br>

This module implements the "Quoted Printable" encoding as

described in RFC 2045.

<p>

This implementation assumes that the encoded string has a text MIME

type. On input both CR/LF and LF are accepted as end-of-line (eol) terminators,

but the output normalizes the eol delimiter as the <code class="code">crlf</code> argument

specifies. Note that this implies that<ul>

<li>If <code class="code">crlf</code>, the output uses CR/LF as line separator as MIME prescribes</li>

<li>the encoding is not invertible for binary data</li>

</ul>

<br>

<pre><span class="keyword">val</span> <a name="VALencode"></a>encode : <code class="type">?crlf:bool -> ?pos:int -> ?len:int -> string -> string</code></pre><div class="info">

Encodes the string and returns it.

<p>

Since OcamlNet 0.98, soft line breaks are added to the output

to ensure that all output lines have a length <= 76 bytes.

<p>

Note unsafe characters:

As recommended by RFC 2045, the characters <code class="code">!#$@[]^`{|}~</code>

and the double quotes

are additionally represented as hex tokens.

Furthermore, the letter 'F' is considered as unsafe if it

occurs at the beginning of the line, so the encoded text

never contains the word "From" at the beginning of a line.

<p>

If <code class="code">pos</code> and/or <code class="code">len</code> are passed, only the substring starting at

<code class="code">pos</code> (default: 0) with length <code class="code">len</code> (default: rest of the string)

is encoded.

<p>

If <code class="code">crlf</code> is set (the default), the output text uses CR/LF as

line separator. Otherwise only LF is used.<br>

</div>

<pre><span class="keyword">val</span> <a name="VALdecode"></a>decode : <code class="type">?pos:int -> ?len:int -> string -> string</code></pre><div class="info">

Decodes the string and returns it.

<p>

Most format errors cause an <code class="code">Invalid_argument</code> exception.

<p>

If <code class="code">pos</code> and/or <code class="code">len</code> are passed, only the substring starting at

<code class="code">pos</code> (default: 0) with length <code class="code">len</code> (default: rest of the string)

100

is decoded.<br>

101

</div>

102

<pre><span class="keyword">class</span> <a name="TYPEencoding_pipe"></a><a href="Netencoding.QuotedPrintable.encoding_pipe.html">encoding_pipe</a> : <code class="type">?crlf:bool -> unit -> </code><code class="type"><a href="Netchannels.pipe.html">Netchannels.pipe</a></code></pre><div class="info">

103

This pipe encodes the data written into the pipe.

104

</div>

105

<pre><span class="keyword">class</span> <a name="TYPEdecoding_pipe"></a><a href="Netencoding.QuotedPrintable.decoding_pipe.html">decoding_pipe</a> : <code class="type">unit -> </code><code class="type"><a href="Netchannels.pipe.html">Netchannels.pipe</a></code></pre><div class="info">

106

This pipe decodes the data written into the pipe.

107

</div>

108

</body></html>

b'\\ No newline at end of file'

Older »