These docs are for AuthRocket 1. Looking for AuthRocket 2 docs?

Settings: Emails

AuthRocket generates numerous events based on activity of the data in each realm. One of the ways these events come to life is by triggering outbound emails based on those events.

New realms have a handful of default Emails already configured. Each of those can be customized or removed and emails for other events can also be added.

Each email can be configured to be sent to the related user or to you (or another fixed email address). This means you can send, for example, a welcome email directly to a new user or an email to your customer welcome team about the new user. Or both.

When viewing each Email summary, there is also a Send test email button which will generate an email using sample data and send it directly to you (regardless of who it would normally be sent to). This is a great way to make sure your emails are coming through the way you intended.

Active

Whether the email trigger is active or not.

Event

The type of event that will trigger sending this email message.

Force all emails to

By default, emails are sent to the user related to the event. If you’d rather this email always be sent to you or some other email address within your organization, enter it here. This is great for dev/testing (in fact, we prepopulate it when creating a Sample realm) as well as ongoing things like telling you when a new user registers for your app.

User type

Since AuthRocket supports both human and API/system-type User records, you can choose which of those will apply to this message.

From (email)

The email that will be used as part of the email’s From address.

From (name)

The name that will be used as part of the email’s From address.

Subject

The subject of the email address.

Email renderer & Template

Email formatting can be a bit tricky. We provide several options to make sure you can send the kind of emails you want.

The default option is Markdown. In this case, the template should be provided as Markdown-formatted text. AuthRocket will automatically produce an HTML and plain-text version of the email from your template, making it super easy to send pleasant looking emails for modern HTML-enabled email clients, while properly falling back to plain-text for clients that need that.

Text only treats the template as plain-text only and sends this to everyone. This produces the simplest and smallest outbound emails. Among other uses, it’s great if the email is being send to an address where it will be automatically processed.

HTML w/auto plaintext treats the template as HTML. No additional theme or HTML will be added to the email, so exactly what you enter here will be sent out. If you already have an email template designed to match your brand, use this option. Additionally, this option will attempt to produce a simplified version of the email for plain-text fallback.

HTML only is just like HTML w/auto plaintext except that it doesn’t produce the plain-text fallback version of the email, meaning the email will go out as HTML only.

Templates can also include a number of merge variables to personalize the emails. Available variables vary slightly based on the type of event the email is for. Each event type has a default email message which includes use of some of these variables as well, which serves as a great starting point for customizing the message template.

Questions? Find a Typo? Get in touch.