email_base.rdoc

doc/email_base.rdoc
Last Update: 2018-09-12 13:39:44 -0700

Documentation for Email Base Feature

The email base feature is automatically loaded when you use a Rodauth feature that requires sending emails.

Auth Value Methods

default_post_email_redirect

Where to redirect after sending an email. This is the default redirect location for all redirects after an email is sent when the account is not logged in. Also includes cases where an email is not sent due to rate limiting.

email_from

The from address to use for emails sent by Rodauth.

email_subject_prefix

The prefix to use for email subjects

require_mail?

Set to false to not require mail, useful if using a different library for sending email.

token_separator

The string used to separate account id from the random key in links.

Auth Methods

email_to

The email address to send emails to, by default the login of the current account.

create_email(subject, body)

Return a Mail::Message instance with the given subject and body.