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
| allow_param_fallback_for_session_param? |
For POST requests that use emailed keys, whether to allow the parameter in the request. By default, false, as the expected workflow is the GET request takes the parameter value and stores it in the session. If the json feature is used, this is true for JSON requests, since the JSON workflow does not submit GET requests. |
| allow_raw_email_token? |
When |
| 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 |
| 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. |
Auth Methods
| create_email(subject, body) |
Return a Mail::Message instance with the given subject and body. |
| email_to |
The email address to send emails to, by default the login of the current account. |
| send_email(email) |
Deliver a given Mail::Message instance. |