Skip to content

Commit

Permalink
Updated docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
rpremraj committed Mar 7, 2014
1 parent 5ae17d0 commit f48d80c
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 7 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,5 @@ Issues/Contibutions
Happy to hear about any issues you encounter using mailR. Simply file a ticket on github or feel free to <A HREF="&#109;&#97;&#105;&#108;&#116;&#111;&#58;%72%2E%70%72%65%6D%72%61%6A%2B%6D%61%69%6C%52%40%67%6D%61%69%6C%2E%63%6F%6D">email me</A>, or even send in a patch ;-)

Also, would be great to have collaborators to further extend the functionality of mailR.

[![githalytics.com alpha](https://cruel-carlota.pagodabox.com/1650fb9891b70b7440cc380824b513f0 "githalytics.com")](http://githalytics.com/rpremraj/mailR)
20 changes: 13 additions & 7 deletions man/send.mail.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -64,13 +64,19 @@ parameters must have the same length as 'attach.files'. In
case attach.file is NULL, then these two parameters will be
ignored.
}
\note{
For more examples, see https://github.com/rpremraj/mailR
}
\examples{
send.mail(from = "[email protected]",
to = c("[email protected]", "[email protected]"),
subject="Subject of the email",
body = "Body of the email",
smtp = list(host.name = "aspmx.l.google.com", port = 25),
authenticate = FALSE,
send = TRUE)
sender <- "[email protected]" # Replace with a valid address
recipients <- c("[email protected]") # Replace with one or more valid addresses
email <- send.mail(from = sender,
to = recipients,
subject="Subject of the email",
body = "Body of the email",
smtp = list(host.name = "aspmx.l.google.com", port = 25),
authenticate = FALSE,
send = FALSE)
\dontrun{email$send() # execute to send email}
}

0 comments on commit f48d80c

Please sign in to comment.