| blob | bbbff8047b9249f50194090852cbd0c0738f1eac |
3 <html>
5 <head>
11 </head>
13 <body>
15 <!-- header +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
18 <hr>
19 <center>
23 </a></td></tr>
25 </td></tr>
26 </table>
33 </p>
34 </center>
35 <hr>
36 </div>
38 <!-- smtp +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
43 messages. The high-level API consists of two functions: one to
44 define an e-mail message, and another to actually send the message.
45 Although almost all users will find that these functions provide more than
46 enough functionality, the underlying implementation allows for even more
47 control (if you bother to read the code).
48 </p>
50 <p>The implementation conforms to the Simple Mail Transfer Protocol,
52 Another RFC of interest is <a
54 which governs the Internet Message Format.
55 Multipart messages (those that contain attachments) are part
56 of the MIME standard, but described mainly
62 assumed. In fact, the SMTP module was the main reason for their
63 creation. </p>
65 <p>
67 </p>
70 -- loads the SMTP module and everything it requires
71 local smtp = require("socket.smtp")
72 </pre>
74 <p>
75 MIME headers are represented as a Lua table in the form:
76 </p>
78 <blockquote>
80 <tr><td><tt>
81 headers = {<br>
87 }
88 </tt></td></tr>
89 </table>
90 </blockquote>
92 <p>
93 Field names are case insensitive (as specified by the standard) and all
94 functions work with lowercase field names (but see
96 Field values are left unmodified.
97 </p>
100 Note: MIME headers are independent of order. Therefore, there is no problem
101 in representing them in a Lua table.
102 </p>
104 <p>
105 The following constants can be set to control the default behavior of
106 the SMTP module:
107 </p>
109 <ul>
115 </ul>
117 <!-- send +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
132 </p>
135 Sends a message to a recipient list. Since sending messages is not as
136 simple as downloading an URL from a FTP or HTTP server, this function
137 doesn't have a simple interface. However, see the
139 a very powerful way to define the message contents.
140 </p>
146 address, or a string
147 in case there is just one recipient.
151 </p>
152 <ul>
154 authentication. The function will attempt LOGIN and PLAIN authentication
155 methods if supported by the server (both are unsafe);
159 local machine host name;
162 pump step function used to pass data from the
166 </ul>
169 If successful, the function returns 1. Otherwise, the function returns
171 </p>
174 Note: SMTP servers can be very picky with the format of e-mail
175 addresses. To be safe, use only addresses of the form
178 addresses can take whatever form you like. </p>
181 Big note: There is a good deal of misconception with the use of the
185 exact opposite of what you expect.
186 </p>
190 message. Each recipient of an SMTP mail message receives a copy of the
191 message body along with the headers, and nothing more. The headers
195 part of the message and will not be sent to anyone.
196 </p>
202 use of these headers. Here is a summary of what it says:
203 </p>
205 <ul>
207 of the message;
209 making a copy on a typewriter using carbon paper) contains the
210 addresses of others who are to receive the message, though the
211 content of the message may not be directed at them;
213 Copy") contains addresses of recipients of the message whose addresses are not to be revealed to other recipients of the message.
214 </ul>
218 headers you send, but it gives you full control over what is sent and
219 to whom it is sent:
220 </p>
221 <ul>
223 to be in the recipient list. This is the only parameter that controls who
224 gets a copy of the message;
225 <li> If there are multiple recipients, none of them will automatically
226 know that someone else got that message. That is, the default behavior is
229 recipients so that other recipients can see it;
231 list of additional recipients so that everyone else sees it;
233 empty. Otherwise, everyone receiving the message will see it and that is
235 </ul>
238 I hope this clarifies the issue. Otherwise, please refer to
240 and
242 </p>
245 -- load the smtp support
246 local smtp = require("socket.smtp")
248 -- Connects to server "localhost" and sends a message to users
250 -- and "sicrano@example.com".
252 -- carbon copy and neither of them knows that "sicrano" received a blind
253 -- carbon copy of the message.
254 from = "<luasocket@example.com>"
256 rcpt = {
257 "<fulano@example.com>",
258 "<beltrano@example.com>",
259 "<sicrano@example.com>"
260 }
262 mesgt = {
263 headers = {
264 to = "Fulano da Silva <fulano@example.com>",
266 subject = "My first message"
267 },
268 body = "I hope this works. If it does, I can send you another 1000 copies."
269 }
271 r, e = smtp.send{
272 from = from,
273 rcpt = rcpt,
274 source = smtp.message(mesgt)
275 }
276 </pre>
278 <!-- message ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
282 </p>
286 <a href="http://lua-users.org/wiki/FiltersSourcesAndSinks">LTN12</a> source that sends an SMTP message body, possibly multipart (arbitrarily deep).
287 </p>
290 The only parameter of the function is a table describing the message.
292 </p>
294 <blockquote>
296 <tr><td><tt>
297 mesgt = {<br>
301 }<br>
303 multipart-mesgt = {<br>
310 }<br>
311 </tt></td></tr>
312 </table>
313 </blockquote>
320 source. For multipart messages, the body is a table that
321 recursively defines each part as an independent message, plus an optional
323 </p>
328 source that produces the
330 Hopefully, the following
331 example will make things clear. When in doubt, refer to the appropriate RFC
332 as listed in the introduction. </p>
335 -- load the smtp support and its friends
336 local smtp = require("socket.smtp")
337 local mime = require("mime")
338 local ltn12 = require("ltn12")
340 -- creates a source to send a message with two parts. The first part is
341 -- plain text, the second part is a PNG image, encoded as base64.
342 source = smtp.message{
343 headers = {
344 -- Remember that headers are *ignored* by smtp.send.
345 from = "Sicrano de Oliveira <sicrano@example.com>",
346 to = "Fulano da Silva <fulano@example.com>",
347 subject = "Here is a message with attachments"
348 },
349 body = {
350 preamble = "If your client doesn't understand attachments, \r\n" ..
351 "it will still display the preamble and the epilogue.\r\n" ..
352 "Preamble will probably appear even in a MIME enabled client.",
353 -- first part: no headers means plain text, us-ascii.
354 -- The mime.eol low-level filter normalizes end-of-line markers.
355 [1] = {
356 body = mime.eol(0, [[
357 Lines in a message body should always end with CRLF.
358 The smtp module will *NOT* perform translation. However, the
359 send function *DOES* perform SMTP stuffing, whereas the message
360 function does *NOT*.
361 ]])
362 },
363 -- second part: headers describe content to be a png image,
364 -- sent under the base64 transfer content encoding.
365 -- notice that nothing happens until the message is actually sent.
366 -- small chunks are loaded into memory right before transmission and
367 -- translation happens on the fly.
368 [2] = {
369 headers = {
372 ["content-description"] = 'a beautiful image',
374 },
375 body = ltn12.source.chain(
377 ltn12.filter.chain(
378 mime.encode("base64"),
379 mime.wrap()
380 )
381 )
382 },
383 epilogue = "This might also show up, but after the attachments"
384 }
385 }
387 -- finally send it
388 r, e = smtp.send{
389 from = "<sicrano@example.com>",
390 rcpt = "<fulano@example.com>",
391 source = source,
392 }
393 </pre>
395 <!-- footer +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
398 <hr>
399 <center>
406 </p>
407 <p>
408 <small>
409 Last modified by Diego Nehab on <br>
411 </small>
412 </p>
413 </center>
414 </div>
416 </body>
417 </html>