{"Type":"Package","Package":"emayili","Title":"Send Email Messages","Version":"0.4.4","Authors@R":"\nc(person(given = c(\"Andrew\", \"B.\"),\nfamily = \"Collier\",\nrole = c(\"aut\", \"cre\"),\nemail = \"andrew@exegetic.biz\"),\nperson(given = \"Matt\",\nfamily = \"Dennis\",\nrole = \"ctb\",\nemail = \"matt@exegetic.biz\"),\nperson(given = \"Gerard\",\nfamily = \"Walsh\",\nrole = \"ctb\",\nemail = \"gerard@exegetic.biz\"),\nperson(given = \"Antoine\",\nfamily = \"Bichat\",\nrole = \"ctb\",\nemail = \"a.bichat@yahoo.fr\",\ncomment = c(ORCID = \"0000-0001-6599-7081\")),\nperson(given = \"Daniel\",\nfamily = \"Fahey\",\nrole = \"ctb\",\nemail = \"dpfahey@gmail.com\"),\nperson(given = c(\"Johann\", \"R.\"),\nfamily = \"Kleinbub\",\nrole = \"ctb\",\nemail = \"johann.kleinbub@gmail.com\"),\nperson(given = c(\"Panagiotis\"),\nfamily = \"Moulos\",\nrole = \"ctb\",\nemail = \"pmoulos@gmail.com\"))","Description":"A light, simple tool for sending emails with minimal dependencies.","URL":"https://datawookie.github.io/emayili/","BugReports":"https://github.com/datawookie/emayili/issues","License":"GPL-3","Imports":"base64enc, curl, glue, httr, magrittr, mime, stringi","Suggests":"testthat (>= 2.1.0), roxygen2","Encoding":"UTF-8","LazyData":"true","RoxygenNote":"7.1.0","NeedsCompilation":"no","Packaged":"2020-10-02 15:53:42 UTC; rstudio-user","Author":"Andrew B. Collier [aut, cre],\nMatt Dennis [ctb],\nGerard Walsh [ctb],\nAntoine Bichat [ctb] (),\nDaniel Fahey [ctb],\nJohann R. Kleinbub [ctb],\nPanagiotis Moulos [ctb]","Maintainer":"Andrew B. Collier ","Repository":"CRAN","Date/Publication":"2020-10-02 16:22:06 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/emayili_0.4.4.tar.gz","jsonAuthors":[{"name":["Andrew Collier","B. Collier"],"email":"andrew@exegetic.biz","maintainer":true},{"name":"Matt Dennis","email":"matt@exegetic.biz","maintainer":false},{"name":"Gerard Walsh","email":"gerard@exegetic.biz","maintainer":false},{"name":"Antoine Bichat","email":"a.bichat@yahoo.fr","maintainer":false},{"name":"Daniel Fahey","email":"dpfahey@gmail.com","maintainer":false},{"name":["Johann Kleinbub","R. Kleinbub"],"email":"johann.kleinbub@gmail.com","maintainer":false},{"name":"Panagiotis Moulos","email":"pmoulos@gmail.com","maintainer":false}],"readme":"\n\n\n# emayili $\"\"$ \n\n\n\n[![CRAN\nstatus](https://www.r-pkg.org/badges/version/emayili)](https://cran.r-project.org/package=emayili)\n[![Travis-CI build\nstatus](https://travis-ci.org/datawookie/emayili.svg?branch=master)](https://travis-ci.org/datawookie/emayili)\n[![Codecov test\ncoverage](https://img.shields.io/codecov/c/github/datawookie/emayili.svg)](https://codecov.io/github/datawookie/emayili)\n[![Lifecycle:\nexperimental](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://www.tidyverse.org/lifecycle/#maturing)\n\n\nemayili is a package for sending emails from R. The design goals are:\n\n - works on all manner of SMTP servers and\n - has minimal dependencies (or dependencies which are easily\n satisfied).\n\nThe package name is an adaption of the Zulu word for email, imeyili.\n\n## Installation\n\nGet the stable version from\n[CRAN](https://CRAN.R-project.org/package=emayili).\n\n``` r\ninstall.packages(\"emayili\")\n```\n\nOr grab it directly from\n[GitHub](https://github.com/datawookie/emayili).\n\n``` r\n# Install from the master branch.\nremotes::install_github(\"datawookie/emayili\")\n# Install from the development branch.\nremotes::install_github(\"datawookie/emayili\", ref = \"dev\")\n```\n\n## Usage\n\nFirst create a message object.\n\n``` r\nlibrary(emayili)\nlibrary(magrittr)\n\nemail <- envelope()\n```\n\n### Creating a Message\n\nThe message has class `envelope`.\n\n``` r\nclass(email)\n```\n\n [1] \"envelope\"\n\nAdd addresses for the sender and recipient.\n\n``` r\nemail <- email %>%\n from(\"alice@yahoo.com\") %>%\n to(\"bob@google.com\") %>%\n cc(\"craig@google.com\")\n```\n\nThere are also `bcc()` and `reply()` functions for setting the `Bcc` and\n`Reply-To` fields.\n\nAdd a subject.\n\n``` r\nemail <- email %>% subject(\"This is a plain text message!\")\n```\n\nAdd a text body. You can use `html()` to add an HTML body.\n\n``` r\nemail <- email %>% text(\"Hello!\")\n```\n\nAdd an attachment.\n\n``` r\nemail <- email %>% attachment(\"image.jpg\")\n```\n\nYou can also create the message in a single command:\n\n``` r\nemail <- envelope(\n to = \"bob@google.com\",\n from = \"alice@yahoo.com\",\n subject = \"This is a plain text message!\",\n text = \"Hello!\"\n)\n```\n\nSimply printing a message displays the header information.\n\n``` r\nemail\n```\n\n Date: Fri, 02 Oct 2020 14:17:38 GMT\n From: alice@yahoo.com\n To: bob@google.com\n Cc: craig@google.com\n Subject: This is a plain text message!\n X-Mailer: {emayili}-0.4.3\n\nYou can identify emails which have been sent using `{emayili}` by the\npresence of an `X-Mailer` header which includes both the package name\nand version.\n\nIf you want to see the complete MIME object, just convert to a string.\n\n``` r\nas.character(email)\n```\n\n### Sending a Message\n\nCreate a SMTP server object and send the message.\n\n``` r\nsmtp <- server(host = \"smtp.gmail.com\",\n port = 465,\n username = \"bob@gmail.com\",\n password = \"bd40ef6d4a9413de9c1318a65cbae5d7\")\nsmtp(email, verbose = TRUE)\n```\n\nTo see the guts of the message as passed to the SMTP server:\n\n``` r\nprint(email, details = TRUE)\n```\n\n### Using STARTTLS\n\nIf you’re trying to send email with a host that uses the STARTTLS\nsecurity protocol (like Google Mail, Yahoo\\! or AOL), then it will most\nprobably be blocked due to insufficient security. In order to circumvent\nthis, you can grant access to less secure apps. See the links below for\nspecifics:\n\n - [Google](https://myaccount.google.com/security)\n ([details](https://support.google.com/accounts/answer/6010255))\n - [Yahoo\\!](https://login.yahoo.com/account/security) and\n - [AOL](https://login.aol.com/account/security).\n\n## Similar Packages\n\nThere is a selection of other R packages which also send emails:\n\n - [blastula](https://cran.r-project.org/package=blastula)\n - [blatr](https://cran.r-project.org/package=blatr) (Windows)\n - [gmailr](https://cran.r-project.org/package=gmailr)\n - [mail](https://cran.r-project.org/package=mail)\n - [mailR](https://cran.r-project.org/package=mailR)\n - [sendmailR](https://cran.r-project.org/package=sendmailR)\n - [ponyexpress](https://github.com/ropenscilabs/ponyexpress)","jobInfo":{"package":"emayili","version":"0.4.4","parsingStatus":"success","parserVersion":1,"parsedAt":"2021-03-29T10:30:09+0000"}}

Description

Usage

Arguments

Value

See Also

Examples