send_message: Methods for sending messages.

Description Usage Arguments Details Methods (by class)

View source: R/send_message.R

Description

The send_message method for the client_sendeR only serves as a placeholder.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
## S3 method for class 'client_gmail'
send_message(
  client,
  message,
  destination,
  verbose = FALSE,
  subject = "sendeR message",
  ...
)

## S3 method for class 'client_sendeR'
send_message(client, message, destination, verbose = FALSE, ...)

## S3 method for class 'client_slack'
send_message(client, message, destination = NULL, verbose = FALSE, ...)

## S3 method for class 'client_telegram'
send_message(client, message, destination, verbose = FALSE, ...)

## S3 method for class 'client_with_fields'
send_message(client, message, destination, verbose = FALSE, ...)

send_message(client, message, destination, verbose = FALSE, ...)

Arguments

client

one of the clients created by the sendeR package.

message

a text body of the message to send. Should be a character vector of length one.

destination

a destination of the message. Should be a character vector of length one. For more details see Methods (by class) section below.

verbose

if is set to TRUE then the function returns whole response instead of only a status_code.

subject

a subject of an email message.

...

send_message passes additional (non-standard) arguments to respective method. Client specific methods have this argument only for method overloading purposes.

Details

Note: arguments to send_message function are always prioritized over the client fields.

Methods (by class)


tmakowski/sendeR documentation built on June 27, 2020, 9 p.m.