电子邮件¶

电子邮件¶

Web API 具有用于发送电子邮件的资源。对于电子邮件 发送 需要已正确设置 SMTP 配置 并且 DHIS2 实例的系统通知电子邮件地址具有 被定义。您可以从电子邮件设置屏幕设置 SMTP 设置 和来自常规设置屏幕的系统通知电子邮件地址 在 DHIS2 中。

/ api / 33 /电子邮件

系统通知¶

notification 资源可让您发送系统电子邮件通知 使用 JSON 或 XML 格式的给定主题和文本。电子邮件将发送至 DHIS2 通用系统中定义的通知电子邮件地址 设置：

{
  "subject": "Integrity check summary",
  "text": "All checks ran successfully"
}

您可以通过发布到通知来发送系统电子邮件通知 像这样的资源：

curl -d @email.json "localhost/api/33/email/notification" -X POST 
  -H "Content-Type:application/json" -u admin:district

出站电子邮件¶

您还可以通过发布到 通知资源如下所述。 F_SEND_EMAIL 或 ALL 权限必须在系统中才能使用这个 api。主题 参数是可选的。 “DHIS 2”字符串将作为默认主题发送 如果 url 中没有提供。应该对 URL 进行编码才能使用它 应用程序接口。

curl "localhost/api/33/email/notification?recipients=xyz%40abc.com&message=sample%20email&subject=Test%20Email" 
  -X POST -u admin:district

enrollment

/api/messages?enrollment=6yWDMa0LP7

event

/api/messages?event=SllsjpfLH2

测试讯息¶

通过发送测试电子邮件来测试 SMTP 设置是否正确 您可以自己与 test 资源进行交互。发送测试邮件 您的 DHIS2 用户帐户必须具有有效的电子邮件地址 与之相关。您可以像这样发送测试电子邮件：

curl "localhost/api/33/email/test" -X POST -H "Content-Type:application/json" -u admin:district