R/send_text.R

In kbroman/mygmailR: Send myself email from R

#  send_text
#' Send a text to yourself
#'
#' Send a text to yourself, using google mail info from a private file
#'
#' @param subject Character string with subject for the email
#'     (Can't include single-quotes.)
#' @param body Character string or vector of character strings, with
#'     the body of the email; if it's a vector, it's combined with
#'     \code{collapse=body_sep} (default = \code{"\\n"}).
#'     (Contents can't include single-quotes, and you need to
#'     double-backslashed the backslashes.)
#' @param body_sep Character string for combining elements in the input \code{body}.
#' @param file_private Character string with file name containing the private information.
#' @param dir_private The directory containing \code{file}. If NULL or
#'     missing, we use the user's home directory \code{"~"}. Use \code{""}
#'     if the \code{file} argument includes the directory.
#'
#' @details
#' Uses gmail address and password information in the
#' \code{~/.gmail_private} file (or another file, specified with
#' \code{dir_private} and \code{file_private}. This should contain records
#' \code{gmail}, \code{password}, and \code{text}, and (optionally) \code{to}.
#'
#' An email will be sent from the address defined in the private file as \code{gmail}.
#' It will be sent to the email address defined as \code{text}. (If AT\&T is your
#' mobile phone company, this would be an address like \code{1234567890@@txt.att.net}.)
#'
#' @export
#' @importFrom gmailR gmail
#'
#' @return Returns value from \code{\link[gmailR]{gmail}}.
#'
#' @examples
#' \dontrun{
#' send_text("R message", "R process done")
#' }
#'
#' @seealso \code{\link{send_gmail}}
#' @keywords utilities
send_text <-
function(subject="", body="", body_sep="\\n",
         file_private=".gmail_private", dir_private=NULL)
{
    private <- read_private_info(file_private, dir_private)
    to <- private$text
    if(is.null(to)) stop("private information doesn't contain email for texting")
    body <- paste(body, collapse=body_sep)
    body <- paste0(body, "   ") # last few characters have been getting cut off

    # check for double or single quotes
    check4quotes(subject, "subject")
    check4quotes(body, "body")

    gmail(to=to, password=private$password, subject=subject, message=body,
          from=private$gmail, username=private$gmail)
}