E-mail¶

E-mail¶

Webové rozhraní API obsahuje prostředek pro odesílání e-mailů. Pro odesílání e-mailů je nutné, aby byla správně nastavena konfigurace SMTP a byla definována e-mailová adresa pro upozornění systému pro instanci DHIS2. Nastavení SMTP můžete provést na obrazovce nastavení e-mailu a e-mailová adresa upozornění systému z obrazovky obecného nastavení v DHIS2.

/api/33/email

Oznámení systému¶

Prostředek oznámení vám umožňuje odesílat systémová e-mailová oznámení s daným předmětem a textem v JSON nebo XML. E-mail bude odeslán na e-mailovou adresu s oznámením, jak je definováno v obecném nastavení systému DHIS2:

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

Systémové e-mailové oznámení můžete odeslat zveřejněním příspěvku do zdroje oznámení takto:

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

Odchozí e-maily¶

Můžete také poslat obecné e-mailové oznámení odesláním do zdroje oznámení, jak je uvedeno níže. Aby bylo možné použít tento API, musí být v systému oprávnění F_SEND_EMAIL nebo ALL. Parametr subjektu je volitelný. Řetězec „DHIS 2“ bude odeslán jako výchozí předmět, pokud není uveden v adrese URL. Adresa URL by měla být kódována, aby bylo možné používat toto API.

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

Zkušební zpráva¶

Chcete-li otestovat, zda je nastavení SMTP správné, zasláním testovacího e-mailu sami sobě, můžete komunikovat s prostředkem test. K odesílání testovacích e-mailů je nutné, aby měl váš uživatelský účet DHIS2 přidruženou platnou e-mailovou adresu. Můžete poslat zkušební e-mail takto:

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