aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/mime.html29
1 files changed, 29 insertions, 0 deletions
diff --git a/doc/mime.html b/doc/mime.html
index e7211fa..fe15df3 100644
--- a/doc/mime.html
+++ b/doc/mime.html
@@ -230,6 +230,35 @@ print((mime.b64("diego:password")))
230--> ZGllZ286cGFzc3dvcmQ= 230--> ZGllZ286cGFzc3dvcmQ=
231</pre> 231</pre>
232 232
233<!-- dot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
234<p class=name id="dot">
235A, B = mime.<b>dot(</b>C [, D]<b>)</b>
236</p>
237
238<p class=description>
239Low-level filter to perform Base64 encoding.
240</p>
241
242<p class=description>
243<tt>A</tt> is the encoded version of the largest prefix of
244<tt>C..D</tt>
245that can be encoded unambiguously. <tt>B</tt> has the remaining bytes of
246<tt>C..D</tt>, <em>before</em> encoding.
247If <tt>D</tt> is <tt><b>nil</b></tt>, <tt>A</tt> is padded with
248the encoding of the remaining bytes of <tt>C</tt>.
249</p>
250
251<p class=note>
252Note: The simplest use of this function is to encode a string into it's
253Base64 transfer content encoding. Notice the extra parenthesis around the
254call to <tt>mime.b64</tt>, to discard the second return value.
255</p>
256
257<pre class=example>
258print((mime.b64("diego:password")))
259--&gt; ZGllZ286cGFzc3dvcmQ=
260</pre>
261
233<!-- eol ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> 262<!-- eol ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
234 263
235<p class=name id="eol"> 264<p class=name id="eol">