Files
WeHub Mirror 6bf8bebf51
CI / Test and Build (push) Failing after 1s
CI / Migrate Dev DB (push) Has been skipped
CI / Migrate DB (push) Has been skipped
CodeQL / Analyze actions (push) Has been cancelled
CodeQL / Analyze javascript-typescript (push) Has been cancelled
CI / Detect Version (push) Has been cancelled
CI / Detect Desktop Changes (push) Has been cancelled
CI / Build AMD64 (blacksmith-2vcpu-ubuntu-2404, ./docker/cron.Dockerfile, ubuntu-latest, ghcr.io/simstudioai/cron) (push) Has been cancelled
CI / Build AMD64 (blacksmith-2vcpu-ubuntu-2404, ./docker/db.Dockerfile, ECR_MIGRATIONS, ubuntu-latest, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build AMD64 (blacksmith-4vcpu-ubuntu-2404, ./docker/pii.Dockerfile, ECR_PII, ubuntu-latest, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build AMD64 (blacksmith-4vcpu-ubuntu-2404, ./docker/realtime.Dockerfile, ECR_REALTIME, ubuntu-latest, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Build AMD64 (blacksmith-8vcpu-ubuntu-2404, ./docker/app.Dockerfile, ECR_APP, linux-x64-8-core, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (blacksmith-4vcpu-ubuntu-2404-arm, ./docker/cron.Dockerfile, ubuntu-24.04-arm, ghcr.io/simstudioai/cron) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (blacksmith-4vcpu-ubuntu-2404-arm, ./docker/db.Dockerfile, ubuntu-24.04-arm, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (blacksmith-4vcpu-ubuntu-2404-arm, ./docker/pii.Dockerfile, ubuntu-24.04-arm, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (blacksmith-4vcpu-ubuntu-2404-arm, ./docker/realtime.Dockerfile, ubuntu-24.04-arm, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (blacksmith-8vcpu-ubuntu-2404-arm, ./docker/app.Dockerfile, linux-arm64-8-core, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Check Docs Changes (push) Has been cancelled
Publish CLI Package / publish-npm (push) Has been cancelled
Publish Python SDK / publish-pypi (push) Has been cancelled
CI / Deploy Trigger.dev (Dev) (push) Has been cancelled
Helm Chart / Lint, test, and validate chart (push) Has been cancelled
Helm Chart / Chart version bumped (push) Has been cancelled
Publish TypeScript SDK / publish-npm (push) Has been cancelled
CI / Build Dev ECR (blacksmith-8vcpu-ubuntu-2404, ./docker/app.Dockerfile, ECR_APP, linux-x64-8-core) (push) Has been cancelled
CI / Promote Images (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/cron) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Build Dev ECR (blacksmith-2vcpu-ubuntu-2404, ./docker/db.Dockerfile, ECR_MIGRATIONS, ubuntu-latest) (push) Has been cancelled
CI / Build Dev ECR (blacksmith-4vcpu-ubuntu-2404, ./docker/pii.Dockerfile, ECR_PII, ubuntu-latest) (push) Has been cancelled
CI / Build Dev ECR (blacksmith-4vcpu-ubuntu-2404, ./docker/realtime.Dockerfile, ECR_REALTIME, ubuntu-latest) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Process Docs (push) Has been cancelled
CI / Create GitHub Release (push) Has been cancelled
CI / Check Desktop Signing Secrets (push) Has been cancelled
CI / Desktop Release (push) Has been cancelled
CI / Create Desktop Prerelease (push) Has been cancelled
CI / Desktop Prerelease Build (push) Has been cancelled
CI / Publish Desktop Prerelease (push) Has been cancelled
CI / Prune Desktop Prereleases (push) Has been cancelled
Helm Chart / Install on kind and run helm test (push) Has been cancelled
WeHub snapshot of cb28d14c6f2c081de7a0d8729a8c816c9adef67a
2026-08-10 11:17:50 +08:00

157 lines
4.0 KiB
TypeScript

import type { SendMailParams, SendMailResult } from '@/tools/sendgrid/types'
import type { ToolConfig } from '@/tools/types'
export const sendGridSendMailTool: ToolConfig<SendMailParams, SendMailResult> = {
id: 'sendgrid_send_mail',
name: 'SendGrid Send Mail',
description: 'Send an email using SendGrid API',
version: '1.0.0',
params: {
apiKey: {
type: 'string',
required: true,
visibility: 'user-only',
description: 'SendGrid API key',
},
from: {
type: 'string',
required: true,
visibility: 'user-or-llm',
description: 'Sender email address (must be verified in SendGrid)',
},
fromName: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Sender name',
},
to: {
type: 'string',
required: true,
visibility: 'user-or-llm',
description: 'Recipient email address',
},
toName: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Recipient name',
},
subject: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Email subject (required unless using a template with pre-defined subject)',
},
content: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Email body content (required unless using a template with pre-defined content)',
},
contentType: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Content type (text/plain or text/html)',
},
cc: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'CC email address',
},
bcc: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'BCC email address',
},
replyTo: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Reply-to email address',
},
replyToName: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Reply-to name',
},
attachments: {
type: 'file[]',
required: false,
visibility: 'user-or-llm',
description: 'Files to attach to the email (UserFile objects)',
},
templateId: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'SendGrid template ID to use',
},
dynamicTemplateData: {
type: 'json',
required: false,
visibility: 'user-or-llm',
description: 'JSON object of dynamic template data',
},
},
request: {
url: '/api/tools/sendgrid/send-mail',
method: 'POST',
headers: () => ({
'Content-Type': 'application/json',
}),
body: (params) => ({
apiKey: params.apiKey,
from: params.from,
fromName: params.fromName,
to: params.to,
toName: params.toName,
subject: params.subject,
content: params.content,
contentType: params.contentType,
cc: params.cc,
bcc: params.bcc,
replyTo: params.replyTo,
replyToName: params.replyToName,
templateId: params.templateId,
dynamicTemplateData: params.dynamicTemplateData,
attachments: params.attachments,
}),
},
transformResponse: async (response): Promise<SendMailResult> => {
const data = await response.json()
if (!data.success) {
return {
success: false,
output: {
success: false,
messageId: undefined,
to: '',
subject: '',
},
error: data.error || 'Failed to send email',
}
}
return {
success: true,
output: data.output,
}
},
outputs: {
success: { type: 'boolean', description: 'Whether the email was sent successfully' },
messageId: { type: 'string', description: 'SendGrid message ID', optional: true },
to: { type: 'string', description: 'Recipient email address' },
subject: { type: 'string', description: 'Email subject' },
},
}