Send Emails Using 'Blat' for Windows

Description

'Blat' is a feature-rich command line email tool for Windows. The blatr package is a wrapper for using 'Blat' from within R. For information about 'Blat' and its options, see http://www.blat.net, for the 'Blat' license, see http://www.blat.net/?docs/license.txt.

Details

To use the blatr package, 'Blat' needs to be installed. This can be done manually, by downloading the executables from the website www.blat.net and place them in the blatr installation directory, i.e. in /path/to/R/library/blatr/. You can also use blatr:::install_blat to let blatr do it for you. You can always check that the needed files are placed correctly using blatr:::check_install. Note that these functions are not exported, as they are generally not needed when blatr is properly set up. The files installed by blatr:::install_blat are hosted on the blatr development page at http://GitHub.com/smbache/blatr. To get started, see the documentation for blat.

Author(s)

Stefan Milton Bache

Send Emails Using 'Blat' for Windows

Description

This is a wrapper which calls 'Blat' to send emails. For documentation on the options, see http://www.blat.net/syntax/syntax.html. You should not use dashes as part of the argument names (as with 'Blat'), this is done for you: simply use name = value pairs as arguments. For some basic examples of the most commonly used arguments, see below.

Usage

blat(...)

Arguments

Details

'Blat' can use a file as body of the email, in which case this is ordinarily the first argument in the 'Blat' command. However, blatr uses the named argument filename to specify this. Unnamed arguments do not work with blatr.

Examples

## Not run: 
   # With attachment
   blat(f      = "Your Name <your@email.com>",
        to     = "your-recipients@email.com",
        s      = "The subject",
        server = "server.address",
        attach = "C:/path/to/attachment.txt",
        body   = "The text you wish to send.")

   # With file as body
   blat(f        = "Your Name <your@email.com>",
        to       = "your-recipients@email.com",
        s        = "The subject",
        server   = "server.address",
        attach   = "C:/path/to/attachment.txt",
        filename = "C:/path/to/file/with/body.txt")

   # With username and password required.
   blat(f        = "Your Name <your@email.com>",
        to       = "your-recipients@email.com",
        s        = "The subject",
        server   = "server.address",
        attach   = "C:/path/to/attachment.txt",
        filename = "C:/path/to/file/with/body.txt",
        u        = "username",
        pw       = "password")

## End(Not run)

Get the needed Blat files.

Description

Get the needed Blat files.

Usage

blat_files()

Value

a character vector of needed Blat files.

Function to check whether Blat is installed correctly.

Description

Function to check whether Blat is installed correctly.

Usage

check_install()

Value

logical.

Function to install the Blat software

Description

Function to install the Blat software

Usage

install_blat(arch = 64, force = FALSE)

Arguments