First Class Modules

Mail reader

Provides a read-focused view across authorized personal/shared mail accounts with search, unread filtering, plain-text message detail, read state, relations, activity, dynamic fields, and favorites.

Runtime key
module.mail-reader
Experience
Secured inbound mail
Security
Server-enforced

Use Mail Reader when tenant users need a bounded view of synchronized email inside the app without exposing mail-server settings, credentials, or raw executable content.

Note

The bundled renderer key is module.mail-reader. First-class means BuildWithHQ supplies a native, typed, secured runtime experience inside normal app provisioning and the signed-in user's existing permissions.

What it does

Provides a read-focused view across authorized personal/shared mail accounts with search, unread filtering, plain-text message detail, read state, relations, activity, dynamic fields, and favorites.

Key capabilities

  • Select authorized personal or shared accounts and view unread counts.
  • Search messages and filter unread mail.
  • Read safe plain-text headers, previews, and bodies; raw HTML is not rendered.
  • Mark permitted messages read/unread and connect them to favorites, relations, activity, and custom fields.

Common uses

  • Shared operations or support mailbox review.
  • Account/project email research linked to business records.
  • Read-focused compliance or case correspondence views.

How it connects

Mail Reader represents synchronized mail records. Use Conversations when messages should become managed customer threads and Universal Inbox when a message requires assignment or action.

Where applicable, its records use the universal RecordId conventions so they can participate in secured relationships, activity history, favorites, dynamic fields, notifications, Inbox attention, and global search without copying the source record.

Security and data boundary

Account ownership/shared access, SaaS, tenant, DataRole, and location are enforced server-side. Incoming-server settings, credential references, raw HTML, and private provider details are excluded from browser responses.

  • The authenticated service derives the SaaS app, tenant account, user, DataRole, and location scope; browser identifiers are never authorization proof.
  • The page editor composes React components with validated data bindings. Those bindings call typed runtime APIs, whose application services execute reviewed stored procedures.
  • List, search, detail, relation, activity, favorite, and write operations reapply their required server-side permissions.

Add it to an app

  1. Open the SaaS app in the Developer Console and identify the user journey and page where this module belongs.
  2. Add the validated module.mail-reader module block through the supported page/template authoring flow.
  3. Configure the module with the page editor's React components and validated data bindings; the bindings call authenticated platform APIs backed by reviewed stored procedures.
  4. Place the page in the correct user-type menus and assign existing DataRole, record, field, and location permissions.
  5. Test list, detail, search, empty, denied, stale-update, and cross-location behavior before publishing an exact version.
Tip

Do not treat Mail Reader as an unrestricted webmail client. Define the synchronized accounts, read-state authority, and handoff into Conversations or Inbox explicitly.

Important

A renderer being bundled in the tenant application does not make its data visible in every app. The server returns only components and records authorized for the current app and signed-in user; unavailable or unauthorized blocks fail closed.