---
title: "Rocket Chat Mailer Configuration Guide"
slug: "mailer"
description: "Learn how to configure the mailer in Rocket Chat. Enable secure communications and reliable email delivery."
updated: 2026-05-08T12:38:39Z
published: 2026-05-08T17:31:00Z
canonical: "docs.rocket.chat/mailer"
---
> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rocket.chat/llms.txt
> Use this file to discover all available pages before exploring further.
# Send Emails to Users
The **Mailer** lets you send custom broadcast emails to users in your workspace, for example, announcements, policy updates, or onboarding follow-ups. It uses your workspace's existing SMTP configuration to deliver the messages, and supports targeting specific users with a query and personalizing content with placeholders.
> [!NOTE]
> The Mailer is for one-off broadcast emails you compose yourself. Transactional emails (password resets, verification, login notifications) are handled separately through [email templates](https://docs.rocket.chat/docs/configure-email#define-email-templates).
## Before you begin
Make sure your workspace's [SMTP settings](https://docs.rocket.chat/docs/configure-email) are configured. The Mailer relies on SMTP to deliver every email it sends.
## Send a broadcast email
To open the Mailer, go to **Manage → Workspace → Mailer.**
Fill in the following fields. Required fields are marked with an asterisk (*).
| Field | Description |
| --- | --- |
| **From******* | The sender address shown in the recipient's inbox, for example: `team@example.com`. |
| **Dry run** | When enabled, the email is sent only to the **From** address (which must belong to a valid user) so you can preview how it looks. Disable this to send the email to all targeted users. |
| **Query** | Optional MongoDB-style filter to target specific users. When empty, all workspace users receive the email. Unsubscribed users are automatically excluded. The value must be valid JSON, see Targeting users with Query below |
| **Subject******* | The email subject line. |
| **Email body******* | The HTML body of the email. Must include the `[unsubscribe]` placeholder, see Email body placeholders below. |
Click **Send email** to deliver the message.
### Targeting users with Query
By default, every workspace user receives the email. Use **Query** to narrow the recipient list with a MongoDB-style JSON filter against the user collection.
For example, to email only users created after January 1, 2015:
```json
{"createdAt":{"$gt":{"$date":"2015-01-01T00:00:00.000Z"}}}
```
Unsubscribed users are automatically removed from any query result.
### Email body placeholders
The body accepts HTML and the following placeholders:
| Placeholder | Description |
| --- | --- |
| `[unsubscribe]` | **Required.** Renders the unsubscribe link. Every email must include it. |
| `[name]` | The recipient's full name. |
| `[fname]` | The recipient's first name. |
| `[lname]` | The recipient's last name. |
| `[email]` | The recipient's email address. |
**Example body:**
```xml
Dear [name],
Hello world! :)
[unsubscribe]
```
**Example email receipts see:**
