aboutsummaryrefslogtreecommitdiff
path: root/doc/smtp.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/smtp.html')
-rw-r--r--doc/smtp.html8
1 files changed, 6 insertions, 2 deletions
diff --git a/doc/smtp.html b/doc/smtp.html
index bd18bfa..1e1523b 100644
--- a/doc/smtp.html
+++ b/doc/smtp.html
@@ -127,6 +127,7 @@ smtp.<b>send{</b><br>
127&nbsp;&nbsp;[port = <i>number</i>,]<br> 127&nbsp;&nbsp;[port = <i>number</i>,]<br>
128&nbsp;&nbsp;[domain = <i>string</i>,]<br> 128&nbsp;&nbsp;[domain = <i>string</i>,]<br>
129&nbsp;&nbsp;[step = <i>LTN12 pump step</i>,]<br> 129&nbsp;&nbsp;[step = <i>LTN12 pump step</i>,]<br>
130&nbsp;&nbsp;[create = <i>function</i>]<br>
130<b>}</b> 131<b>}</b>
131</p> 132</p>
132 133
@@ -138,6 +139,7 @@ doesn't have a simple interface. However, see the
138a very powerful way to define the message contents. 139a very powerful way to define the message contents.
139</p> 140</p>
140 141
142
141<p class=parameters> 143<p class=parameters>
142The sender is given by the e-mail address in the <tt>from</tt> field. 144The sender is given by the e-mail address in the <tt>from</tt> field.
143<tt>Rcpt</tt> is a Lua table with one entry for each recipient e-mail 145<tt>Rcpt</tt> is a Lua table with one entry for each recipient e-mail
@@ -158,7 +160,9 @@ local machine host name;
158<li> <tt>step</tt>: 160<li> <tt>step</tt>:
159<a href="http://lua-users.org/wiki/FiltersSourcesAndSinks">LTN12</a> 161<a href="http://lua-users.org/wiki/FiltersSourcesAndSinks">LTN12</a>
160pump step function used to pass data from the 162pump step function used to pass data from the
161source to the server. Defaults to the LTN12 <tt>pump.step</tt> function. 163source to the server. Defaults to the LTN12 <tt>pump.step</tt> function;
164<li><tt>accept</tt>: An optional function to be used instead of
165<a href=tcp.html#socket.tcp><tt>socket.tcp</tt></a> when the communications socket is created.
162</ul> 166</ul>
163 167
164<p class=return> 168<p class=return>
@@ -167,7 +171,7 @@ If successful, the function returns 1. Otherwise, the function returns
167</p> 171</p>
168 172
169<p class=note> 173<p class=note>
170Note: SMTP servers are can be very picky with the format of e-mail 174Note: SMTP servers can be very picky with the format of e-mail
171addresses. To be safe, use only addresses of the form 175addresses. To be safe, use only addresses of the form
172"<tt>&lt;fulano@example.com&gt;</tt>" in the <tt>from</tt> and 176"<tt>&lt;fulano@example.com&gt;</tt>" in the <tt>from</tt> and
173<tt>rcpt</tt> arguments to the <tt>send</tt> function. In headers, e-mail 177<tt>rcpt</tt> arguments to the <tt>send</tt> function. In headers, e-mail