send_email_update_tar: Send email alerts to updated automation reports

In ecohealthalliance/containerTemplateUtils: Provides utility functions to the container-template repository

Send email alerts to updated automation reports

Description

Send email alerts to updated automation reports

Usage

send_email_update_tar(
  to,
  from = "[e-mail]",
  project_name,
  use_hyperlinks = FALSE,
  hyperlinks_text = NULL,
  hyperlinks_url = NULL,
  attach = FALSE,
  attachment_paths,
  test = FALSE,
  additional_body_text = ""
)

Arguments

to	A vector of email addresses serving as primary recipients for the message.
from	The email address of the sender.
project_name	String. Name of the project to use in email subject and body text.
use_hyperlinks	Logical. If TRUE, a hyperlink using the file name or custom text is provided instead of the the full url of the report.
hyperlinks_text	String. NULL, hyperlink will be Current_ReportBasename eg Current_MyMarkdownReport.html. If a string or vector of strings are provided those will be used for the text in the hyperlink.
hyperlinks_url	String. Url to used in the hyperlink or as raw text to link to file.
attach	Logical. Should reports be attached to email? Default is FALSE. If TRUE, specify local files using the attachment_paths argument.
attachment_paths	String. Local file paths to be attachemed to the email.
test	Logical. Is this an email alert for testing automation reports? Default is FALSE. If TRUE, subject includes test and upload path will include the current git branch in the file path (e.g. https://project.secure.eha.io/refs/fix/missing_documentation/file.txt)
additional_body_text	String. Any additional text to be included in the body. This text is added to the end of the email body. You can use markdown to format the text.

Value

Invisible. Update email sent to list of recipients in to

See Also

browseVignettes("blastula")

ecohealthalliance/containerTemplateUtils documentation built on March 31, 2024, 7:46 a.m.