Email (SMTP) Connection
The SMTP connection type allows automation workflows to send emails through any standard SMTP mail server. It is used by the plugin-email plugin, which delegates to the email-connector for actual mail delivery.
Connection Type
| Property | Value |
|---|---|
| Type enum | SMTP |
| Type ID | smtp |
| Category | Communication |
| Entity class | SMTPConnectionDetails |
Friendly Example
| What you enter | Example |
|---|---|
| Connection name | Corporate SMTP Relay |
| Used for | Sending approval emails, reminders, and job alerts |
| Main details to collect | SMTP host, port, sender email, username, and app password |
| Best person to provide it | Email or IT administrator |
After it is saved, workflow builders select Corporate SMTP Relay in a node instead of entering these details again.
Mandatory Fields
| Field | Type | Required | Description |
|---|---|---|---|
host | String | Yes | SMTP server hostname or IP address (e.g., smtp.gmail.com, smtp.office365.com) |
port | String | Yes | SMTP server port. Common values: 25 (unencrypted), 465 (SSL/TLS), 587 (STARTTLS) |
username | String | Yes | Authentication username, typically the sender's email address |
password | String | Yes | Authentication password or app-specific password. Encrypted at rest. |
Advanced Fields
| Field | Type | Required | Description |
|---|---|---|---|
protocol | String | No | Mail protocol identifier. Set to smtp or smtps depending on encryption mode |
fromAddress | String | No | Default sender address if different from the username |
encryption | String | No | Encryption mode: TLS, SSL, or STARTTLS. Determines the port and handshake behavior |
timeout | String | No | Connection timeout in milliseconds |
Port and Encryption Reference
| Port | Encryption | Notes |
|---|---|---|
25 | None / STARTTLS | Standard SMTP. Many cloud providers block this port. |
465 | Implicit SSL/TLS | Legacy but widely supported. Connection is encrypted from the start. |
587 | STARTTLS | Recommended. Starts unencrypted, then upgrades via STARTTLS command. |
Setup Instructions
-
Identify your SMTP server. For corporate environments, check with your IT team. For cloud providers:
- Gmail:
smtp.gmail.com, port587(STARTTLS) or465(SSL). Requires an App Password if 2FA is enabled. - Microsoft 365:
smtp.office365.com, port587(STARTTLS). Requires SMTP AUTH to be enabled for the mailbox. - Amazon SES: Use the regional SES SMTP endpoint. Requires SES SMTP credentials (not IAM credentials).
- Gmail:
-
Obtain credentials. Use a service account or application-specific password rather than a personal account password.
-
Create the connection in the Global Configurator with the fields listed above.
-
Test the connection to verify that the platform can reach the SMTP server and authenticate successfully.
Troubleshooting
| Symptom | Likely Cause |
|---|---|
| Connection timeout | Firewall blocking the port, or incorrect host/port |
| Authentication failed | Wrong credentials, or SMTP AUTH not enabled on the mailbox |
530 5.7.57 SMTP; Client was not authenticated | Microsoft 365: SMTP AUTH is disabled for the user. Enable it in the Exchange admin center. |
534 Application-specific password required | Gmail: 2FA is on but you are using the account password instead of an App Password |