Preview: SendMock has no stable release yet. These docs follow develop.
SendMock

Tour of the app

Every sidebar menu and header tool in one page, with its keyboard key and what it is for.

Try it in the demo. The demo is the real UI with sample data.

SendMock's screen has three parts: the sidebar on the left (where you go), the header at the top (tools that work everywhere), and the page. Most pages are a list with a detail beside it, like a mail client; on a phone the list and detail stack.

The sidebar

Press G and then the key in the table to jump to a menu from anywhere.

MenuKeyWhat it is forPage
OverviewG Othe home dashboard: counts, activity, webhook health, recent failures and how to connectOverview
Mail > InboxG Mevery email your app sent, and the replies you simulateMail
Mail > Providersthe email APIs SendMock answers (SendGrid, Mailgun, ..., your own)Providers
SMS > MessagesG Severy SMS and WhatsApp message, as conversationsSMS
SMS > VerifyG VTwilio Verify codes, with their expiry and attemptsVerify
SMS > Providersthe SMS APIs SendMock answers (Twilio, Vonage, ..., your own)Providers
HTTP CatcherG Hthe catcher for any other HTTP call your app makesHTTP Catcher
WebhooksG Wwhat SendMock sends back to your app, and its healthWebhooks
Webhooks > Endpointswhere deliveries go and how they are shaped and signedEndpoints
Webhooks > Ruleswhich events go to which endpoint, automaticallyRules
Webhooks > Inbound routeswhere incoming email (replies) goes, like Mailgun RoutesInbound routes
Webhooks > DeliveriesG Dthe log of everything sent, with retry and replayDeliveries
Webhooks > Composera request written by hand, like a small PostmanComposer and Saved
Webhooks > Templatesthe shapes a request can take (Twilio, Postmark, Slack, your own)Templates
Webhooks > Variablesvalues templates read: tokens, secrets, ids, random valuesVariables
Webhooks > Saveddeliveries you bookmarked to send againComposer and Saved
PaymentsG Pevery test payment, with its timeline and Simulate menuPayments
Payments > Gatewaysthe emulated providers: Stripe, PayPal, SSLCommerz, bKash, your ownGateways
Payments > Methodswhat a customer pays with (card, bKash, Nagad, ...) and its test valuesMethods
Payments > Flowsthe steps a checkout page asks for (card form, number, OTP, PIN, ...)Flows
Payments > Subscriptionsrecurring payments, renewed, failed and canceled on their own clockSubscriptions
NumbersG Nyour fake phone numbers and Messaging Services, set up like a provider consoleNumbers
ScenariosG Cmulti-step tests you write once and run again, step by stepScenarios
LogsG Lthe raw SMTP sessions and API requests behind every messageLogs
SettingsG ,how SendMock behaves: outcomes, profiles, chaos, seed file, connection snippetsSettings

The bottom of the sidebar has icon links to the docs, Report an issue, Request a feature, private security reporting and Star on GitHub (hover one for its name), and shows whether the live connection is up and the version. Mod+B (Cmd+B on macOS, Ctrl+B elsewhere) hides or shows the sidebar.

The header

  • Guide link: the book icon next to the page title opens that screen's page in this guide, in a new tab.
  • Search and the command palette (Mod+K): jump to any screen, or run an action, by typing its name.
  • Notification bell: the unread count and the last 50 notable events (new email, new or inbound SMS, failed webhook deliveries), each linking to its item. Pop-up toasts can be turned off or moved in Settings > Notifications.
  • Help menu: the docs, keyboard shortcuts, what's new, Report an issue, Request a feature, private security reporting and the repository.
  • Theme (T): light, dark or follow the system.

Every button or link that shows only an icon, here and on every screen, names its action in a tooltip when you hover or focus it, with its key when it has one (for example Delete email D).

Every control of the sidebar and the header, one by one: Sidebar and header in depth.

Keys that work in lists

KeyDoes
J / Knext / previous item
Enteropen the selected item
Ddelete the open item
/focus the search
?show every shortcut, grouped as General, Lists and messages, and Navigation
R, Shift+R, Freply, reply all, forward as the recipient (Mail)

Empty screens

A screen with nothing yet shows what will appear there, a how to connect card with the exact host and ports to copy, and a sample button (Send a sample email, Send a sample SMS, Start a sample verification, Add a sample number). Samples go through the same path as real traffic, so they fire events, webhooks and notifications. A screen that is empty only because of a search or filter says so and offers Clear filter instead.

The demo toolbar

The demo has a Demo controls button that installed SendMock does not have. It changes the sample data set (including Empty (no traffic)), API latency and errors, live traffic, and whether SendMock pretends to run in Docker, so every state of a screen can be seen.

Next

How it all connects explains how these menus feed each other.

On this page