mirror of
https://github.com/simstudioai/sim.git
synced 2026-10-29 18:47:25 +08:00
* feat(docs): update favicon, fix icon contrast, add integration intros - replace docs favicon/icon assets with new sim logo - fix light-tile icon contrast in BlockInfoCard so icons like Daytona no longer render invisible (white-on-white); matches sim toolbar's brightness-based contrast logic - add missing MANUAL-CONTENT-START:intro sections to 30 integration docs pages that lacked context/links * chore(docs): normalize spacing from generate-docs pass Ran the docs generator to verify our new intro sections survive regeneration cleanly. It reformats the blank line before "## Usage Instructions" to match every other manually-annotated page. * fix(context-dev): remove prefetch and simplified-brand tools - remove context_dev_prefetch_domain, context_dev_prefetch_by_email, and context_dev_get_brand_simplified tools and their block operation entries; these aren't meant for general use - regenerate docs to drop their sections from context_dev.mdx
69 lines
2.9 KiB
Plaintext
69 lines
2.9 KiB
Plaintext
---
|
|
title: SMTP
|
|
description: Send emails via any SMTP mail server
|
|
---
|
|
|
|
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
|
|
|
<BlockInfoCard
|
|
type="smtp"
|
|
color="#2D3748"
|
|
/>
|
|
|
|
{/* MANUAL-CONTENT-START:intro */}
|
|
The SMTP block sends email through any standard SMTP mail server, including Gmail, Outlook, and self-hosted or custom mail servers. It connects directly using the server hostname, port, and credentials you provide rather than a vendor-specific API.
|
|
|
|
With the SMTP block, you can:
|
|
|
|
- **Connect to any SMTP server**: Configure host, port, and security protocol (TLS, SSL, or none) for the mail server of your choice
|
|
- **Control message content and formatting**: Set sender, recipients, subject, and body, with support for either plain text or HTML content
|
|
- **Reach multiple recipients and attach files**: Add CC and BCC recipients, set a reply-to address, and attach files to the outgoing email
|
|
|
|
In Sim, the SMTP block allows your agents to send emails as part of a workflow by supplying connection details and message content, then confirming delivery through the returned success status and message ID. This makes it possible to notify recipients, deliver generated reports, or trigger email-based alerts directly from a workflow, with the block reporting the message ID on success or an error message if sending fails.
|
|
{/* MANUAL-CONTENT-END */}
|
|
|
|
|
|
## Usage Instructions
|
|
|
|
Send emails using any SMTP server (Gmail, Outlook, custom servers, etc.). Configure SMTP connection settings and send emails with full control over content, recipients, and attachments.
|
|
|
|
|
|
|
|
## Actions
|
|
|
|
### `smtp_send_mail`
|
|
|
|
Send emails via SMTP server
|
|
|
|
#### Input
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `smtpHost` | string | Yes | SMTP server hostname \(e.g., smtp.gmail.com\) |
|
|
| `smtpPort` | number | Yes | SMTP server port \(587 for TLS, 465 for SSL\) |
|
|
| `smtpUsername` | string | Yes | SMTP authentication username |
|
|
| `smtpPassword` | string | Yes | SMTP authentication password |
|
|
| `smtpSecure` | string | Yes | Security protocol \(TLS, SSL, or None\) |
|
|
| `from` | string | Yes | Sender email address |
|
|
| `to` | string | Yes | Recipient email address |
|
|
| `subject` | string | Yes | Email subject |
|
|
| `body` | string | Yes | Email body content |
|
|
| `contentType` | string | No | Content type \(text or html\) |
|
|
| `fromName` | string | No | Display name for sender |
|
|
| `cc` | string | No | CC recipients \(comma-separated\) |
|
|
| `bcc` | string | No | BCC recipients \(comma-separated\) |
|
|
| `replyTo` | string | No | Reply-to email address |
|
|
| `attachments` | file[] | No | Files to attach to the email |
|
|
|
|
#### Output
|
|
|
|
| Parameter | Type | Description |
|
|
| --------- | ---- | ----------- |
|
|
| `success` | boolean | Whether the email was sent successfully |
|
|
| `messageId` | string | Message ID from SMTP server |
|
|
| `to` | string | Recipient email address |
|
|
| `subject` | string | Email subject |
|
|
| `error` | string | Error message if sending failed |
|
|
|
|
|