Skip to contents

RegLogConnector for email sending via emayili package

RegLogEmayiliConnector.Rd

With the use of this object, RegLogServer can send emails confirming the registration and containing code for password reset procedure.

See also

Other mailConnectors: RegLogGmailrConnector

Super class

shiny.reglog::RegLogConnector -> RegLogEmayiliConnector

Public fields

mails

List containing default mail templates to use by default mail handlers for register and password reset

Methods

Public methods

Inherited methods

Method new()

Initialization of the object. Creates smtp server for email sending.

Usage

RegLogEmayiliConnector$new(
  from,
  smtp,
  lang = "en",
  custom_txts = NULL,
  custom_handlers = NULL,
  custom_mails = NULL
)

Arguments

from

Character containing content in from of the email.

smtp

Object created by emayili::server or all its similiar functions.

lang

character specyfiyng which language to use for all texts generated in the UI. Defaults to 'en' for English. Currently 'pl' for Polish is also supported.

custom_txts

named list containing character strings with custom messages. Defaults to NULL, so all built-in strings will be used.

custom_handlers

named list of custom handler functions. Custom handler should take arguments: self and private - relating to the R6 object and message of class RegLogConnectorMessage. It should return return RegLogConnectorMessage object.

custom_mails

named list containing character strings of the same structure as elements in the mails field. Not all elements need to be present.

Details

default mails are used by register_mail and reset_pass_mail handlers. To change the mail used by these handlers you can pass character strings to the custom_mail argument during initialization or append them directly into this list.

They are stored (and should be passed accordingly) in a list of structure:

  • register

    • subject

    • body

  • resetPass

    • subject

    • body

  • credsEdit

    • subject

    • body

Method clone()

The objects of this class are cloneable with this method.

Usage

RegLogEmayiliConnector$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.