Address: Address

AddressR Documentation

Address

Description

Address Class

Public fields

method

(character) one or more URLs

url

(character) one or more URLs

Active bindings

method

(character) one or more URLs

url

(character) one or more URLs

Methods

Public methods


Method new()

Create a new Address object

Usage
Address$new(email_address, config = list())
Arguments
email_address

(character) an email address

config

(list) list of config options


Method split_local_host()

split local host

Usage
Address$split_local_host(email)
Arguments
email

(character) email address

Returns

character string


Method normal()

Usage
Address$normal()

Method to_s()

Usage
Address$to_s()

Method munge()

Usage
Address$munge()

Method canonical()

Usage
Address$canonical()

Method base()

Usage
Address$base()

Method reference()

Usage
Address$reference()

Method valid()

Usage
Address$valid(options = list())

Method fail()

Usage
Address$fail()

Method clone()

The objects of this class are cloneable with this method.

Usage
Address$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Examples

## Not run: 
x <- Address$new("User+tag@example.com")
x
x$local
x$local$valid()
x$host
x$host$valid()
x$valid()
x$fail()
x$munge()
x$normal()

x <- Address$new("User+tag@example.com",
  config = list(munge_string = "*^*^*^*"))
x$munge()

## End(Not run)

ropenscilabs/addressable documentation built on Sept. 13, 2022, 11:32 p.m.