跳至主要内容

邮件通知

LiteLLM 电子邮件通知

概述​

向 LiteLLM Proxy 用户发送特定事件的电子邮件。

类别详情
支持的事件• 用户被添加为 LiteLLM Proxy 用户
• 为用户创建了 Proxy API Key
• 为用户轮换了 Proxy API Key
支持的电子邮件集成• Resend API
• SMTP

用法​

信息

LiteLLM Cloud：此功能已为所有 LiteLLM Cloud 用户启用，无需进行任何配置。

1. 配置电子邮件集成​

获取 SMTP 凭据以完成设置

proxy_config.yaml
litellm_settings:
    callbacks: ["smtp_email"]

将以下内容添加到您的代理环境变量中

SMTP_HOST="smtp.resend.com"
SMTP_TLS="True"
SMTP_PORT="587"
SMTP_USERNAME="resend"
SMTP_SENDER_EMAIL="notifications@alerts.litellm.ai"
SMTP_PASSWORD="xxxxx"

2. 创建新用户​

在 LiteLLM Proxy UI 上，转到 users > create a new user。

创建新用户后，他们将收到一封发送到您在创建用户时指定的电子邮件地址的邀请邮件。

3. 配置预算警报（可选）​

通过将 "email" 添加到代理配置的 alerts 列表中来启用预算警报电子邮件

proxy_config.yaml
general_settings:
  alerts: ["email"]

预算警报类型​

软预算警报 (Soft Budget Alerts)：当密钥超过其软预算限制时自动触发。这些警报有助于您在达到关键阈值之前监控支出。

最大预算警报 (Max Budget Alerts)：当密钥达到其最大预算的指定百分比（默认：80%）时自动触发。这些警报会在您接近预算耗尽时发出警告。

为防止垃圾邮件，两种警报类型每 24 小时最多发送一封电子邮件。

配置选项​

使用这些环境变量自定义预算警报行为

.env
# Percentage of max budget that triggers alerts (as decimal: 0.8 = 80%)
EMAIL_BUDGET_ALERT_MAX_SPEND_ALERT_PERCENTAGE=0.8

# Time-to-live for alert deduplication in seconds (default: 24 hours)
EMAIL_BUDGET_ALERT_TTL=86400

电子邮件模板​

1. 用户被添加为 LiteLLM Proxy 用户​

当您在 LiteLLM Proxy 上创建新用户时，会发送此电子邮件。

如何触发此事件

在 LiteLLM Proxy UI 上，转到 Users > Create User > 输入用户的电子邮件地址 > Create User。

2. 为用户创建 Proxy API Key​

当您在 LiteLLM Proxy 上为用户创建新的 API Key 时，会发送此电子邮件。

如何触发此事件

在 LiteLLM Proxy UI 上，转到 Virtual Keys > Create API Key > 选择 User ID

在创建 Key 的模态框中，选择 Advanced Settings > 将 Send Email 设置为 True。

3. 为用户轮换 Proxy API Key​

当您在 LiteLLM Proxy 上为用户轮换 API Key 时，会发送此电子邮件。

如何触发此事件

在 LiteLLM Proxy UI 上，转到 Virtual Keys > 点击某个 Key > 点击 "Regenerate Key"

信息

确保该 Key 关联了 user_id。这通常在创建 Key 时设置。

重新生成 Key 后，用户将收到一封包含以下内容的电子邮件通知：

  • 关于轮换的安全消息
  • 新的 API Key（如果 EMAIL_INCLUDE_API_KEY=false，则显示占位符）
  • 更新应用程序的说明
  • 安全最佳实践

电子邮件自定义​

信息

自定义电子邮件品牌是企业版功能 联系我们获取免费试用

LiteLLM 允许您自定义电子邮件通知的各个方面。以下是所有可自定义字段的完整参考：

字段环境变量类型默认值示例描述
Logo URLEMAIL_LOGO_URLstringLiteLLM logo"https://your-company.com/logo.png"指向您公司 Logo 的公开 URL
支持联系方式EMAIL_SUPPORT_CONTACTstringsupport@berri.ai"support@your-company.com"用于用户支持的电子邮件地址
电子邮件签名EMAIL_SIGNATURE字符串 (HTML)标准 LiteLLM 页脚"<p>Best regards,<br/>Your Team</p><p><a href='https://your-company.com'>Visit us</a></p>"所有电子邮件的 HTML 格式页脚
邀请邮件主题EMAIL_SUBJECT_INVITATIONstring"LiteLLM: New User Invitation""Welcome to Your Company!"邀请邮件的主题行
Key 创建邮件主题EMAIL_SUBJECT_KEY_CREATEDstring"LiteLLM: API Key Created""Your New API Key is Ready"Key 创建邮件的主题行
Key 轮换邮件主题EMAIL_SUBJECT_KEY_ROTATEDstring"LiteLLM: API Key Rotated""Your API Key Has Been Rotated"Key 轮换邮件的主题行
包含 API KeyEMAIL_INCLUDE_API_KEY布尔值true"false"是否在电子邮件中包含实际 API Key（设置为 false 以增强安全性）
Proxy 基础 URLPROXY_BASE_URLstringhttp://0.0.0.0:4000"https://proxy.your-company.com"LiteLLM Proxy 的基础 URL（用于电子邮件链接）

电子邮件签名中的 HTML 支持​

EMAIL_SIGNATURE 字段支持 HTML 格式，可用于制作丰富且具品牌特色的电子邮件页脚。以下是您可以包含的内容示例：

<p>Best regards,<br/>The LiteLLM Team</p>
<p>
  <a href='https://docs.litellm.com.cn'>Documentation</a> |
  <a href='https://github.com/BerriAI/litellm'>GitHub</a>
</p>
<p style='font-size: 12px; color: #666;'>
  This is an automated message from LiteLLM Proxy
</p>

支持的 HTML 功能

  • 文本格式（加粗、斜体等）
  • 换行 (<br/>)
  • 链接 (<a href='...'>)
  • 段落 (<p>)
  • 基本内联样式
  • 公司信息和社交媒体链接
  • 法律声明或服务条款链接

环境变量​

您可以通过环境变量自定义电子邮件的以下方面

# Email Branding
EMAIL_LOGO_URL="https://your-company.com/logo.png"  # Custom logo URL
EMAIL_SUPPORT_CONTACT="support@your-company.com"     # Support contact email
EMAIL_SIGNATURE="<p>Best regards,<br/>Your Company Team</p><p><a href='https://your-company.com'>Visit our website</a></p>"  # Custom HTML footer/signature

# Email Subject Lines
EMAIL_SUBJECT_INVITATION="Welcome to Your Company!"  # Subject for invitation emails
EMAIL_SUBJECT_KEY_CREATED="Your API Key is Ready"    # Subject for key creation emails
EMAIL_SUBJECT_KEY_ROTATED="Your API Key Has Been Rotated"  # Subject for key rotation emails

# Security Settings
EMAIL_INCLUDE_API_KEY="false"  # Set to false to hide API keys in emails (default: true)

# Proxy Configuration
PROXY_BASE_URL="https://proxy.your-company.com"      # Base URL for the LiteLLM Proxy (used in email links)

安全：在电子邮件中隐藏 API Key​

为了增强安全性，您可以将 LiteLLM 配置为不在电子邮件通知中包含实际的 API Key。这在以下情况下很有用：

  • 您想降低通过电子邮件拦截导致 Key 泄露的风险
  • 您的安全策略要求只能从安全仪表板检索 Key
  • 您担心电子邮件转发或存储安全性

禁用后，电子邮件将显示：[Key hidden for security - retrieve from dashboard]，而不是实际的 API Key。

配置

# Hide API keys in emails (enhanced security)
EMAIL_INCLUDE_API_KEY="false"

# Include API keys in emails (default behavior)
EMAIL_INCLUDE_API_KEY="true"  # or omit this variable

行为

设置Key 已创建电子邮件Key 已轮换电子邮件
true (默认)显示实际的 sk-xxxxx Key显示实际的 sk-xxxxx Key
false显示占位消息显示占位消息

用户始终可以从 LiteLLM Proxy 仪表板检索他们的 Key。

电子邮件签名中的 HTML 支持​

EMAIL_SIGNATURE 环境变量支持 HTML 格式，允许您创建丰富、有品牌的电子邮件页脚。您可以包含：

  • 文本格式（加粗、斜体等）
  • 使用 <br/> 进行换行
  • 使用 <a href='...'> 添加链接
  • 使用 <p> 添加段落
  • 公司信息和社交媒体链接
  • 法律声明或服务条款链接

HTML 签名示例

<p>Best regards,<br/>The LiteLLM Team</p>
<p>
  <a href='https://docs.litellm.com.cn'>Documentation</a> |
  <a href='https://github.com/BerriAI/litellm'>GitHub</a>
</p>
<p style='font-size: 12px; color: #666;'>
  This is an automated message from LiteLLM Proxy
</p>

默认模板​

如果未设置环境变量，LiteLLM 将使用默认模板

  • 默认 logo：LiteLLM logo
  • 默认支持联系方式：support@berri.ai
  • 默认签名：标准 LiteLLM 页脚
  • 默认主题："LiteLLM: {event_message}"（替换为实际事件消息）

模板变量​

设置自定义电子邮件主题时，您可以使用模板变量，这些变量将被替换为实际值

# Examples of template variable usage
EMAIL_SUBJECT_INVITATION="Welcome to \{company_name\}!"
EMAIL_SUBJECT_KEY_CREATED="Your \{company_name\} API Key"

系统在发送电子邮件时会自动将 \{event_message\} 和其他模板变量替换为它们的实际值。

常见问题解答​

PROXY_BASE_URL 环境变量用于构建电子邮件链接。如果您在本地环境中使用 LiteLLM Proxy，您将在电子邮件链接中看到 "http://0.0.0.0:4000"。

如果您在生产环境中使用 LiteLLM Proxy，您将看到 LiteLLM Proxy 的实际基础 URL。

您可以将 PROXY_BASE_URL 环境变量设置为 LiteLLM Proxy 的实际基础 URL。

PROXY_BASE_URL="https://proxy.your-company.com"
🚅
LiteLLM 企业版
SSO/SAML、审计日志、支出跟踪、多团队管理和护栏 —— 专为生产环境构建。
了解更多 →