MailDocument {tm.plugin.mail}R Documentation

E-Mail Documents

Description

Create electronic mail documents.

Usage

MailDocument(x,
             author = character(),
             datetimestamp = as.POSIXlt(Sys.time(), tz = "GMT"),
             description = character(),
             header = character(),
             heading = character(),
             id = character(),
             language = character(),
             origin = character(),
             ...,
             meta = NULL)

Arguments

x

A character giving the text content.

author

a character or an object of class person giving the author names.

datetimestamp

an object of class POSIXt or a character string giving the creation date/time information. If a character string, exactly one of the ISO 8601 formats defined by https://www.w3.org/TR/NOTE-datetime should be used. See parse_ISO_8601_datetime in package NLP for processing such date/time information.

description

a character giving a description.

header

a character giving the mail header.

heading

a character giving the title or a short heading.

id

a character giving a unique identifier.

language

a character giving the language (preferably as IETF language tags, see language in package NLP).

origin

a character giving information on the source and origin.

...

user-defined document metadata tag-value pairs.

meta

a named list or NULL (default) giving all metadata. If set, all other metadata arguments are ignored.

Value

An object inheriting from MailDocument, PlainTextDocument, and TextDocument.

Author(s)

Ingo Feinerer


[Package tm.plugin.mail version 0.2-2 Index]