Merges data into an email and send.
Description
![[Experimental]](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB3aWR0aD0iMTM2IiBoZWlnaHQ9IjIwIj48bGluZWFyR3JhZGllbnQgaWQ9ImIiIHgyPSIwIiB5Mj0iMTAwJSI+PHN0b3Agb2Zmc2V0PSIwIiBzdG9wLWNvbG9yPSIjYmJiIiBzdG9wLW9wYWNpdHk9Ii4xIi8+PHN0b3Agb2Zmc2V0PSIxIiBzdG9wLW9wYWNpdHk9Ii4xIi8+PC9saW5lYXJHcmFkaWVudD48Y2xpcFBhdGggaWQ9ImEiPjxyZWN0IHdpZHRoPSIxMzYiIGhlaWdodD0iMjAiIHJ4PSIzIiBmaWxsPSIjZmZmIi8+PC9jbGlwUGF0aD48ZyBjbGlwLXBhdGg9InVybCgjYSkiPjxwYXRoIGZpbGw9IiM1NTUiIGQ9Ik0wIDBoNTN2MjBIMHoiLz48cGF0aCBmaWxsPSIjZmU3ZDM3IiBkPSJNNTMgMGg4M3YyMEg1M3oiLz48cGF0aCBmaWxsPSJ1cmwoI2IpIiBkPSJNMCAwaDEzNnYyMEgweiIvPjwvZz48ZyBmaWxsPSIjZmZmIiB0ZXh0LWFuY2hvcj0ibWlkZGxlIiBmb250LWZhbWlseT0iRGVqYVZ1IFNhbnMsVmVyZGFuYSxHZW5ldmEsc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMTAiPjx0ZXh0IHg9IjI3NSIgeT0iMTUwIiBmaWxsPSIjMDEwMTAxIiBmaWxsLW9wYWNpdHk9Ii4zIiB0cmFuc2Zvcm09InNjYWxlKC4xKSIgdGV4dExlbmd0aD0iNDMwIj5saWZlY3ljbGU8L3RleHQ+PHRleHQgeD0iMjc1IiB5PSIxNDAiIHRyYW5zZm9ybT0ic2NhbGUoLjEpIiB0ZXh0TGVuZ3RoPSI0MzAiPmxpZmVjeWNsZTwvdGV4dD48dGV4dCB4PSI5MzUiIHk9IjE1MCIgZmlsbD0iIzAxMDEwMSIgZmlsbC1vcGFjaXR5PSIuMyIgdHJhbnNmb3JtPSJzY2FsZSguMSkiIHRleHRMZW5ndGg9IjczMCI+ZXhwZXJpbWVudGFsPC90ZXh0Pjx0ZXh0IHg9IjkzNSIgeT0iMTQwIiB0cmFuc2Zvcm09InNjYWxlKC4xKSIgdGV4dExlbmd0aD0iNzMwIj5leHBlcmltZW50YWw8L3RleHQ+PC9nPiA8L3N2Zz4=)
Merges columns from a data frame into a markdown document using the
glue::glue_data() function. The markdown can contain a yaml header for
subject and cc line.
Note that only 'gmail' is supported at the moment, via gmailr::gm_send_message.
Before using mail_merge(), you must be authenticated to the gmail service.
Use gmailr::gm_auth() to authenticate prior to starting the mail merge.
Usage
mail_merge( data, message, to_col = "email", send = c("preview", "draft", "immediately"), confirm = FALSE, sleep_preview = 1, sleep_send = 0.1 )mail_merge( data, message, to_col = "email", send = c("preview", "draft", "immediately"), confirm = FALSE, sleep_preview = 1, sleep_send = 0.1 )
Arguments
data |
A data frame or |
message |
A list with components |
to_col |
The name of the column in |
send |
A character string, one of:
|
confirm |
If |
sleep_preview |
If |
sleep_send |
If |
Value
Returns a list for every message, consisting of:
-
msg: The message inmimeformat -
id: Thegmailrresponse id -
type: preview, draft or sent -
success: TRUE if the message was sent successfully
See Also
Examples
## ---- input-data -------------------------------------------------------- dat <- data.frame( email = c("[email protected]", "[email protected]"), first_name = c("friend", "foe"), thing = c("something good", "something bad"), stringsAsFactors = FALSE ) ## ---- markdown-message -------------------------------------------------- msg <- ' --- subject: "**Hello, {first_name}**" --- Hi, **{first_name}** I am writing to tell you about **{thing}**. {if (first_name == "friend") "Regards" else ""} Me ' ## ---- mail-merge -------------------------------------------------------- dat %>% mail_merge(msg) if (interactive()) { dat %>% mail_merge(msg) %>% print() } ## ---- display shiny gadget ---------------------------------------------- if (interactive()) { dat %>% mail_merge(msg) %>% preview_mailmerge() }## ---- input-data -------------------------------------------------------- dat <- data.frame( email = c("[email protected]", "[email protected]"), first_name = c("friend", "foe"), thing = c("something good", "something bad"), stringsAsFactors = FALSE ) ## ---- markdown-message -------------------------------------------------- msg <- ' --- subject: "**Hello, {first_name}**" --- Hi, **{first_name}** I am writing to tell you about **{thing}**. {if (first_name == "friend") "Regards" else ""} Me ' ## ---- mail-merge -------------------------------------------------------- dat %>% mail_merge(msg) if (interactive()) { dat %>% mail_merge(msg) %>% print() } ## ---- display shiny gadget ---------------------------------------------- if (interactive()) { dat %>% mail_merge(msg) %>% preview_mailmerge() }
Read a markdown file from google drive
Description
Read a markdown file from google drive
Usage
mm_read_googledoc(id)mm_read_googledoc(id)
Arguments
id |
Unique Google Drive identifier, passed to googledrive::drive_download |
Value
the imported document
A list of character strings, containing the content of the google doc
Parse a markdown document into yaml and body components.
Description
You can use this to construct the message argument of mail_merge().
Usage
mm_read_message(txt)mm_read_message(txt)
Arguments
txt |
A file in markdown format |
Value
A list with components yaml and body
See Also
Other parsing functions:
mm_read_message_googledoc()
Parse the email template inside a markdown document on google drive.
Description
You can use this to construct the message argument of mail_merge().
Usage
mm_read_message_googledoc(id)mm_read_message_googledoc(id)
Arguments
id |
Unique Google Drive identifier, passed to googledrive::drive_download |
Value
A list of character strings
See Also
Other parsing functions:
mm_read_message()
Preview mailmerge as shiny gadget in RStudio preview pane.
Description
Usage
preview_mailmerge(x)preview_mailmerge(x)
Arguments
x |
mailmerge_preview object, from mail_merge |
Value
A 'shiny' gadget, see also shiny::runGadget
See Also
Examples
## ---- input-data -------------------------------------------------------- dat <- data.frame( email = c("[email protected]", "[email protected]"), first_name = c("friend", "foe"), thing = c("something good", "something bad"), stringsAsFactors = FALSE ) ## ---- markdown-message -------------------------------------------------- msg <- ' --- subject: "**Hello, {first_name}**" --- Hi, **{first_name}** I am writing to tell you about **{thing}**. {if (first_name == "friend") "Regards" else ""} Me ' ## ---- display shiny gadget ---------------------------------------------- if (interactive()) { dat %>% mail_merge(msg) %>% preview_mailmerge() }## ---- input-data -------------------------------------------------------- dat <- data.frame( email = c("[email protected]", "[email protected]"), first_name = c("friend", "foe"), thing = c("something good", "something bad"), stringsAsFactors = FALSE ) ## ---- markdown-message -------------------------------------------------- msg <- ' --- subject: "**Hello, {first_name}**" --- Hi, **{first_name}** I am writing to tell you about **{thing}**. {if (first_name == "friend") "Regards" else ""} Me ' ## ---- display shiny gadget ---------------------------------------------- if (interactive()) { dat %>% mail_merge(msg) %>% preview_mailmerge() }