steve
/
factor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

better docs for smtp

db4
Doug Coleman 2008-09-09 18:55:49 -05:00
parent be9f1f89da
commit 12322932ef
1 changed files with 3 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
basis/smtp/smtp-docs.factor
View File

@ -20,8 +20,7 @@ HELP: <email>
HELP: send-email HELP: send-email
{ $values { "email" email } } { $values { "email" email } }
{ $description "Sends an " { $link email } " object to an STMP server stored in the " { $link smtp-server } " variable. The required slots are " { $snippet "from" } " and " { $snippet "to" } "." } { $description "Sends an " { $link email } " object to an STMP server stored in the " { $link smtp-server } " variable. The required slots are " { $slot "from" } " and " { $slot "to" } "." }
{ $examples { $examples
{ $unchecked-example "USING: accessors smtp ;" { $unchecked-example "USING: accessors smtp ;"
"<email>" "<email>"
@ -37,9 +36,5 @@ HELP: send-email
} ; } ;
ARTICLE: "smtp" "SMTP Client Library" ARTICLE: "smtp" "SMTP Client Library"
"Start by creating a new email object:" "Sending an email:"
{ $subsection <email> } { $subsection send-email } ;
"Set the " { $snippet "from" } " slot to a " { $link string } "." $nl
"Set the recipient fields, " { $snippet "to" } ", " { $snippet "cc" } ", and " { $snippet "bcc" } ", to arrays of strings."
"Set the " { $snippet "subject" } " to a " { $link string } "." $nl
"Set the " { $snippet "body" } " to a " { $link string } "." $nl ;