From 1d3f8977ef7540e85bec43cae955a361cae7eaa0 Mon Sep 17 00:00:00 2001 From: botan Date: Fri, 27 Sep 2024 16:35:06 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20botan/sg?= =?UTF-8?q?@9368d66e335b74f9639846d8e83e3cb88576c5fd=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- pkgdown.yml | 2 +- reference/sg_mime.html | 6 +++++- search.json | 2 +- sitemap.xml | 1 - 4 files changed, 7 insertions(+), 4 deletions(-) diff --git a/pkgdown.yml b/pkgdown.yml index 21fc647..63a25b1 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -2,7 +2,7 @@ pandoc: 3.1.11 pkgdown: 2.1.1 pkgdown_sha: ~ articles: {} -last_built: 2024-09-27T14:46Z +last_built: 2024-09-27T16:35Z urls: reference: https://botan.github.io/sg/reference article: https://botan.github.io/sg/articles diff --git a/reference/sg_mime.html b/reference/sg_mime.html index 3cbce76..3f8a403 100644 --- a/reference/sg_mime.html +++ b/reference/sg_mime.html @@ -55,7 +55,7 @@

Usage sg_attachments(x, ...) -sg_send(x) +sg_send(x, api_key = Sys.getenv("SENDGRID_API_KEY"))
@@ -85,6 +85,10 @@

Argumentstype

The content type (e.g., "text/plain")

+ +
api_key
+

SendGrid API key. Defaults to the environment variable SENDGRID_API_KEY if not provided.

+

Value

diff --git a/search.json b/search.json index 260f5b8..e616f62 100644 --- a/search.json +++ b/search.json @@ -1 +1 @@ -[{"path":"https://botan.github.io/sg/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2024 Botan Ağın Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://botan.github.io/sg/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Botan Ağın. Author, maintainer.","code":""},{"path":"https://botan.github.io/sg/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Ağın B (2024). sg: 'SendGrid' Email API Client. R package version 0.1.0.9000, https://botan.github.io/sg/, https://github.com/botan/sg.","code":"@Manual{, title = {sg: 'SendGrid' Email API Client}, author = {Botan Ağın}, year = {2024}, note = {R package version 0.1.0.9000, https://botan.github.io/sg/}, url = {https://github.com/botan/sg}, }"},{"path":"https://botan.github.io/sg/index.html","id":"sg","dir":"","previous_headings":"","what":"SendGrid Email API Client","title":"SendGrid Email API Client","text":"Minimalistic SendGrid Email API client sending emails R.","code":""},{"path":"https://botan.github.io/sg/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"SendGrid Email API Client","text":"Install released version sg CRAN: install development version GitHub :","code":"install.packages(\"sg\") # install.packages(\"pak\") pak::pak(\"botan/sg\")"},{"path":"https://botan.github.io/sg/index.html","id":"authentication","dir":"","previous_headings":"","what":"Authentication","title":"SendGrid Email API Client","text":"Set API key using SENDGRID_API_KEY environment variable. package automatically detect use sending emails.","code":""},{"path":"https://botan.github.io/sg/index.html","id":"usage","dir":"","previous_headings":"","what":"Usage","title":"SendGrid Email API Client","text":"basic example shows send email:","code":"library(sg) sg_mime() |> sg_from(\"sender@example.com\") |> sg_to(\"recipient1@example.com\", \"recipient2@example.com\") |> sg_cc(\"cc1@example.com\", \"cc2@example.com\") |> sg_bcc(\"bcc1@example.com\", \"bcc2@example.com\") |> sg_subject(\"This is the subject\") |> sg_body(\"Hello from sg!\") |> sg_attachments(\"path/to/file1.csv\", \"path/to/file2.pdf\") |> sg_send()"},{"path":"https://botan.github.io/sg/reference/get_api_key.html","id":null,"dir":"Reference","previous_headings":"","what":"Get API key for auth. — get_api_key","title":"Get API key for auth. — get_api_key","text":"Get API key auth.","code":""},{"path":"https://botan.github.io/sg/reference/get_api_key.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get API key for auth. — get_api_key","text":"","code":"get_api_key(api_key = Sys.getenv(\"SENDGRID_API_KEY\"))"},{"path":"https://botan.github.io/sg/reference/get_api_key.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get API key for auth. — get_api_key","text":"api_key SendGrid API key.","code":""},{"path":"https://botan.github.io/sg/reference/get_api_key.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get API key for auth. — get_api_key","text":"api_key","code":""},{"path":"https://botan.github.io/sg/reference/is_email_address.html","id":null,"dir":"Reference","previous_headings":"","what":"Check if a string is in a valid email format — is_email_address","title":"Check if a string is in a valid email format — is_email_address","text":"Check string valid email format","code":""},{"path":"https://botan.github.io/sg/reference/is_email_address.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check if a string is in a valid email format — is_email_address","text":"","code":"is_email_address(email)"},{"path":"https://botan.github.io/sg/reference/is_email_address.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check if a string is in a valid email format — is_email_address","text":"email character string.","code":""},{"path":"https://botan.github.io/sg/reference/is_email_address.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check if a string is in a valid email format — is_email_address","text":"logical value.","code":""},{"path":"https://botan.github.io/sg/reference/sg_mime.html","id":null,"dir":"Reference","previous_headings":"","what":"Create and send MIME formatted message objects — sg_mime","title":"Create and send MIME formatted message objects — sg_mime","text":"Methods creating sending MIME messages.","code":""},{"path":"https://botan.github.io/sg/reference/sg_mime.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create and send MIME formatted message objects — sg_mime","text":"","code":"sg_mime() sg_from(x, email) sg_to(x, ...) sg_cc(x, ...) sg_bcc(x, ...) sg_subject(x, subject) sg_body(x, body, type = \"text/html\") sg_attachments(x, ...) sg_send(x)"},{"path":"https://botan.github.io/sg/reference/sg_mime.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create and send MIME formatted message objects — sg_mime","text":"x MIME object. email sender's email address. ... One email addresses. subject email subject. body body content email. type content type (e.g., \"text/plain\")","code":""},{"path":"https://botan.github.io/sg/reference/sg_mime.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create and send MIME formatted message objects — sg_mime","text":"MIME object.","code":""},{"path":"https://botan.github.io/sg/reference/sg_mime.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create and send MIME formatted message objects — sg_mime","text":"","code":"if (FALSE) { # \\dontrun{ sg_mime() |> sg_from(\"sender@example.com\") |> sg_to(\"recipient1@example.com\", \"recipient2@example.com\") |> sg_cc(\"cc1@example.com\", \"cc2@example.com\") |> sg_bcc(\"bcc1@example.com\", \"bcc2@example.com\") |> sg_subject(\"This is the subject\") |> sg_body(\"Hello from sg!\") |> sg_attachments(\"path/to/file1.csv\", \"path/to/file2.pdf\") |> sg_send() } # }"},{"path":[]},{"path":"https://botan.github.io/sg/news/index.html","id":"sg-010","dir":"Changelog","previous_headings":"","what":"sg 0.1.0","title":"sg 0.1.0","text":"CRAN release: 2024-09-20 Initial CRAN submission.","code":""}] +[{"path":"https://botan.github.io/sg/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2024 Botan Ağın Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://botan.github.io/sg/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Botan Ağın. Author, maintainer.","code":""},{"path":"https://botan.github.io/sg/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Ağın B (2024). sg: 'SendGrid' Email API Client. R package version 0.1.0.9000, https://botan.github.io/sg/, https://github.com/botan/sg.","code":"@Manual{, title = {sg: 'SendGrid' Email API Client}, author = {Botan Ağın}, year = {2024}, note = {R package version 0.1.0.9000, https://botan.github.io/sg/}, url = {https://github.com/botan/sg}, }"},{"path":"https://botan.github.io/sg/index.html","id":"sg","dir":"","previous_headings":"","what":"SendGrid Email API Client","title":"SendGrid Email API Client","text":"Minimalistic SendGrid Email API client sending emails R.","code":""},{"path":"https://botan.github.io/sg/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"SendGrid Email API Client","text":"Install released version sg CRAN: install development version GitHub :","code":"install.packages(\"sg\") # install.packages(\"pak\") pak::pak(\"botan/sg\")"},{"path":"https://botan.github.io/sg/index.html","id":"authentication","dir":"","previous_headings":"","what":"Authentication","title":"SendGrid Email API Client","text":"Set API key using SENDGRID_API_KEY environment variable. package automatically detect use sending emails.","code":""},{"path":"https://botan.github.io/sg/index.html","id":"usage","dir":"","previous_headings":"","what":"Usage","title":"SendGrid Email API Client","text":"basic example shows send email:","code":"library(sg) sg_mime() |> sg_from(\"sender@example.com\") |> sg_to(\"recipient1@example.com\", \"recipient2@example.com\") |> sg_cc(\"cc1@example.com\", \"cc2@example.com\") |> sg_bcc(\"bcc1@example.com\", \"bcc2@example.com\") |> sg_subject(\"This is the subject\") |> sg_body(\"Hello from sg!\") |> sg_attachments(\"path/to/file1.csv\", \"path/to/file2.pdf\") |> sg_send()"},{"path":"https://botan.github.io/sg/reference/is_email_address.html","id":null,"dir":"Reference","previous_headings":"","what":"Check if a string is in a valid email format — is_email_address","title":"Check if a string is in a valid email format — is_email_address","text":"Check string valid email format","code":""},{"path":"https://botan.github.io/sg/reference/is_email_address.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check if a string is in a valid email format — is_email_address","text":"","code":"is_email_address(email)"},{"path":"https://botan.github.io/sg/reference/is_email_address.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check if a string is in a valid email format — is_email_address","text":"email character string.","code":""},{"path":"https://botan.github.io/sg/reference/is_email_address.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check if a string is in a valid email format — is_email_address","text":"logical value.","code":""},{"path":"https://botan.github.io/sg/reference/sg_mime.html","id":null,"dir":"Reference","previous_headings":"","what":"Create and send MIME formatted message objects — sg_mime","title":"Create and send MIME formatted message objects — sg_mime","text":"Methods creating sending MIME messages.","code":""},{"path":"https://botan.github.io/sg/reference/sg_mime.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create and send MIME formatted message objects — sg_mime","text":"","code":"sg_mime() sg_from(x, email) sg_to(x, ...) sg_cc(x, ...) sg_bcc(x, ...) sg_subject(x, subject) sg_body(x, body, type = \"text/html\") sg_attachments(x, ...) sg_send(x, api_key = Sys.getenv(\"SENDGRID_API_KEY\"))"},{"path":"https://botan.github.io/sg/reference/sg_mime.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create and send MIME formatted message objects — sg_mime","text":"x MIME object. email sender's email address. ... One email addresses. subject email subject. body body content email. type content type (e.g., \"text/plain\") api_key SendGrid API key. Defaults environment variable SENDGRID_API_KEY provided.","code":""},{"path":"https://botan.github.io/sg/reference/sg_mime.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create and send MIME formatted message objects — sg_mime","text":"MIME object.","code":""},{"path":"https://botan.github.io/sg/reference/sg_mime.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create and send MIME formatted message objects — sg_mime","text":"","code":"if (FALSE) { # \\dontrun{ sg_mime() |> sg_from(\"sender@example.com\") |> sg_to(\"recipient1@example.com\", \"recipient2@example.com\") |> sg_cc(\"cc1@example.com\", \"cc2@example.com\") |> sg_bcc(\"bcc1@example.com\", \"bcc2@example.com\") |> sg_subject(\"This is the subject\") |> sg_body(\"Hello from sg!\") |> sg_attachments(\"path/to/file1.csv\", \"path/to/file2.pdf\") |> sg_send() } # }"},{"path":[]},{"path":"https://botan.github.io/sg/news/index.html","id":"sg-010","dir":"Changelog","previous_headings":"","what":"sg 0.1.0","title":"sg 0.1.0","text":"CRAN release: 2024-09-20 Initial CRAN submission.","code":""}] diff --git a/sitemap.xml b/sitemap.xml index 4185716..1e00eba 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -5,7 +5,6 @@ https://botan.github.io/sg/authors.html https://botan.github.io/sg/index.html https://botan.github.io/sg/news/index.html -https://botan.github.io/sg/reference/get_api_key.html https://botan.github.io/sg/reference/index.html https://botan.github.io/sg/reference/is_email_address.html https://botan.github.io/sg/reference/sg_mime.html