better smtp docs
parent
45425fccd7
commit
88ef60fe1d
basis/smtp
|
@ -4,12 +4,18 @@ USING: accessors kernel quotations help.syntax help.markup
|
||||||
io.sockets strings calendar ;
|
io.sockets strings calendar ;
|
||||||
IN: smtp
|
IN: smtp
|
||||||
|
|
||||||
|
HELP: smtp-domain
|
||||||
|
{ $description "The name of the machine that is sending the email. This variable will be filled in by the " { $link host-name } " word if not set by the user." } ;
|
||||||
|
|
||||||
HELP: smtp-server
|
HELP: smtp-server
|
||||||
{ $description "Holds an " { $link inet } " object with the address of an SMTP server." } ;
|
{ $description "Holds an " { $link inet } " object with the address of an SMTP server." } ;
|
||||||
|
|
||||||
HELP: smtp-read-timeout
|
HELP: smtp-read-timeout
|
||||||
{ $description "Holds an " { $link duration } " object that specifies how long to wait for a response from the SMTP server." } ;
|
{ $description "Holds an " { $link duration } " object that specifies how long to wait for a response from the SMTP server." } ;
|
||||||
|
|
||||||
|
HELP: esmtp?
|
||||||
|
{ $description "Set true by default, determines whether the SMTP client is using the Extended SMTP protocol." } ;
|
||||||
|
|
||||||
HELP: with-smtp-connection
|
HELP: with-smtp-connection
|
||||||
{ $values { "quot" quotation } }
|
{ $values { "quot" quotation } }
|
||||||
{ $description "Connects to an SMTP server stored in " { $link smtp-server } " and calls the quotation." } ;
|
{ $description "Connects to an SMTP server stored in " { $link smtp-server } " and calls the quotation." } ;
|
||||||
|
@ -36,5 +42,10 @@ HELP: send-email
|
||||||
} ;
|
} ;
|
||||||
|
|
||||||
ARTICLE: "smtp" "SMTP Client Library"
|
ARTICLE: "smtp" "SMTP Client Library"
|
||||||
|
"Configuring SMTP:"
|
||||||
|
{ $subsection smtp-server }
|
||||||
|
{ $subsection smtp-read-timeout }
|
||||||
|
{ $subsection smtp-domain }
|
||||||
|
{ $subsection esmtp? }
|
||||||
"Sending an email:"
|
"Sending an email:"
|
||||||
{ $subsection send-email } ;
|
{ $subsection send-email } ;
|
||||||
|
|
|
@ -10,7 +10,7 @@ IN: smtp
|
||||||
SYMBOL: smtp-domain
|
SYMBOL: smtp-domain
|
||||||
SYMBOL: smtp-server "localhost" "smtp" <inet> smtp-server set-global
|
SYMBOL: smtp-server "localhost" "smtp" <inet> smtp-server set-global
|
||||||
SYMBOL: smtp-read-timeout 1 minutes smtp-read-timeout set-global
|
SYMBOL: smtp-read-timeout 1 minutes smtp-read-timeout set-global
|
||||||
SYMBOL: esmtp t esmtp set-global
|
SYMBOL: esmtp? t esmtp? set-global
|
||||||
|
|
||||||
LOG: log-smtp-connection NOTICE ( addrspec -- )
|
LOG: log-smtp-connection NOTICE ( addrspec -- )
|
||||||
|
|
||||||
|
@ -39,7 +39,7 @@ TUPLE: email
|
||||||
: command ( string -- ) write crlf flush ;
|
: command ( string -- ) write crlf flush ;
|
||||||
|
|
||||||
: helo ( -- )
|
: helo ( -- )
|
||||||
esmtp get "EHLO " "HELO " ? host-name append command ;
|
esmtp? get "EHLO " "HELO " ? host-name append command ;
|
||||||
|
|
||||||
ERROR: bad-email-address email ;
|
ERROR: bad-email-address email ;
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue