R/send_email.R

In UBC-MDS/rhousehunter: Simplify House-Hunting

#' A function to email search results.
#'
#' @param email_recipient A character vector containing the recipient's email.
#'
#' @param filtered_data A tibble containing the filtered search results.
#'
#' @param email_subject A character vector of desired subject of the email.
#' Optional argument with default value of  'Results from RHouseHunter'.
#'
#' @return None.
#' @export
#'
#' @examples
#' send_email("elabandari@gmail.com", (tibble::tibble(name = c("house1"))))
send_email <- function(email_recipient, filtered_data,
                       email_subject = "Results from RHouseHunter") {
  # Pattern for validating email address
  email_pattern <- "\\<[A-Z0-9._%+-]+@[A-Z0-9.-]+\\.[A-Z]{2,}\\>"
  # Programming defensively
  if (!is.character(email_recipient)) {
    rlang::abort("The email address must be a string. Aborting.")
  }
  if (grepl(email_pattern, email_recipient, ignore.case = TRUE) == FALSE) {
    rlang::abort("You have input an invalid Email Address. Aborting.")
  }
  if (!is.character(email_subject)) {
    rlang::abort("The email subject must be a string. Aborting.")
  }
  if (!tibble::is_tibble(filtered_data)) {
    rlang::abort("The filtered results must be a tibble. Aborting.")
  }
  if (dim(filtered_data)[1] == 0) {
    rlang::abort("Your tibble is empty and no results to be emailed. Aborting.")
  }

  # Writing tibble to tempfile as a csv
  file_path <- tempfile()
  readr::write_csv(filtered_data, file_path)


  email <- emayili::envelope(
    from = "pyhousehunter@gmail.com",
    to = email_recipient,
    subject = email_subject,
    text = "Results meeting your specifications are attached."
  )
  email <- emayili::attachment(email, file_path, "results.csv")

  smtp <- emayili::server(
    host = "smtp.gmail.com",
    port = 465,
    username = "pyhousehunter@gmail.com",
    password = "dsci524group6"
  )

  smtp(email, verbose = TRUE)
}