Email & CRMSMTP username + password (or app password)Confirm pricing before publishing
Email (SMTP)
Monthly client reports, weekly plans and alerts (workspace); trial, billing and password emails (Super Admin platform SMTP).
AProvider definition
- Provider
- Email (SMTP)
- What it does
- Sends monthly client reports, weekly plans and alerts.
- Why we need it
- Monthly client reports, weekly plans and alerts (workspace); trial, billing and password emails (Super Admin platform SMTP).
- Used in
- Reports · Workflows (email) · Platform emails
- Official site
- https://nodemailer.com/smtp/
BAccount requirements
- Account type
- Any SMTP mailbox or email service (Google Workspace, Microsoft 365, SES, SendGrid, Mailgun…)
- Prerequisites
- SPF/DKIM set up for the sending domain
CConnection method
- Authentication
- SMTP username + password (or app password)
- Where to enter it
- Your workspace: App → Integrations → Providers & API keysWorkspace owner or admin. Keys added here are used only by your workspace (AI keys here don't use plan credits).
- Platform-wide (Super Admin): Super Admin → Platform → IntegrationsPlatform owner. Used for every customer who hasn't added their own key; can also be set as PLATFORM_KEY_<PROVIDER> on the API server.
Setup steps
- 1Get the SMTP host, port (587 STARTTLS or 465 SSL), username and password from your email provider. For Gmail/Workspace use an App Password.
- 2Enter them with the From address and click Test.
DPermissions & API scopes
No OAuth scopes — access is controlled by the key or token itself. Restrict keys to the APIs listed in the setup steps where the provider allows it.
This list is generated from the scopes the application's code requests.
EFree vs paid
- Free account / free API access
- Check the provider's pricing page.
- Card or billing account required?
- Usually required for production use.
- Paid plan / costs
- Depends on your email provider.
- Quota and usage limits
- Provider-specific rate limits.
Not yet verified. Confirm on the provider's official pricing page before publishing.
FSetup screenshots
Capture each step with real values masked. Save images as public/docs/integrations/smtp/1.png … 10.png and they appear here automatically.
- Screenshot to add1. Account login / creationThe provider's sign-in or sign-up page.
- Screenshot to add2. Developer consoleThe developer console or dashboard home.
- Not applicable3. Project / app creationCreating the app or project used for this integration.
- Not applicable4. API enablementThe API or product enabled for the project.
- Not applicable5. OAuth configurationConsent screen / OAuth settings with the redirect URIs.
- Screenshot to add6. API key / credentials creationCreating the key, secret or token (mask the value).
- Not applicable7. Permissions / scopesThe scopes or permissions requested or approved.
- Screenshot to add8. Billing / quota settingsBilling, credits or quota page.
- Screenshot to add9. Application connectionThe provider card in our application with fields filled (secrets masked).
- Screenshot to add10. Successful connectionThe green Test result or the connected account listed.
GApplication configuration
Never include real API keys, client secrets, access tokens or passwords in screenshots, tickets or documentation. Values below are field names and examples only.
| Field | Required | Example / default | Notes |
|---|---|---|---|
| Host | Yes | smtp.gmail.com | |
| Port | Optional | 587 | |
| Username | Yes | — | |
| Password | Yes | •••••••• | Stored encrypted; shown masked after saving. |
| From address | Yes | Marketing <reports@example.com> | |
| Report recipients | Optional | you@example.com, client@example.com |
HTesting
- 1Click Test — a test email is sent.
ITroubleshooting
| Problem | What to do |
|---|---|
| 535 authentication failed | Use an app password; basic auth may be disabled on the mailbox. |
| Emails land in spam | Set SPF, DKIM and DMARC for the From domain. |
| Invalid credentials | The key or token is wrong, revoked or from another project. Create a new one and paste it again, then click Test. |
| Missing permissions | The key's project or role doesn't include this API. Grant access or create the key in the right project. |
| API not enabled | Enable the API/product for the project or app in the provider console and wait a few minutes. |
| Quota exceeded | Wait for the quota window to reset (see section E) or request a higher quota / add credits. |
| Account not eligible | Check the account requirements in section B (e.g. business/professional account, verified property, registered organisation). |
| Billing required | Add a payment method or prepaid credits on the provider account (see section E). |
JDisconnect & security
- Revoke access at the provider
- Revoke the app password at your email provider.
- Disconnect in the application
- App → Integrations → Providers & API keys or Super Admin → Platform → Integrations → open the card → Remove / Disconnect. Connected accounts can be disconnected per brand.
- Rotate credentials
- Create the new key or secret first, paste it into the same card and Test, then delete the old one at the provider — no downtime.
- How credentials are stored
- Encrypted at rest with AES-256-GCM using the server's ENCRYPTION_KEY, shown masked after saving, never returned to the browser, and used only from the API server.
- What data the application can access
- Only the emails the app sends.

