Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
protogrid:api_endpoints [2021-12-02 11:10] – [/api/v2/apps/<app_name>/mailsend] dru | protogrid:api_endpoints [2021-12-09 00:34] – [/api/v2/apps/<app_name>/mailsend] dru | ||
---|---|---|---|
Line 143: | Line 143: | ||
* Example: limit=15 | * Example: limit=15 | ||
* Default value: 10 | * Default value: 10 | ||
- | * descending: If set to true the results will be in descending order. | + | * descending: If set to true the results will be in descending order. If set to true start_key and end_key must be exchanged. |
* Example: descending=true | * Example: descending=true | ||
* Default value: False | * Default value: False | ||
Line 152: | Line 152: | ||
| | ||
- | Note: you may only use either keys or start_key and end_key. | + | Please note: |
+ | * You may only use either | ||
+ | * Key values must be cut off after 300 characters (e. g. string values and sortstrings) because these values are also cut off in the view index. | ||
Details: For more details about the URL parameters see the [[http:// | Details: For more details about the URL parameters see the [[http:// | ||
Line 454: | Line 456: | ||
==== / | ==== / | ||
- | [POST] Send an email using the provided data | + | [POST] Send an email |
+ | |||
+ | To use this endpoint, a mail server must be specified in the environment properties (fields "SMTP Server Hostname" | ||
+ | |||
+ | Protogrid will fist try to establish a TLS session to the specified mail server and authenticate | ||
+ | |||
+ | If Sender Policy Framework (SPF) is used for the particular mail domain, the Protogrid server must be added to the SPF record of this domain. For this purpose, please contact [[protogrid-customer-support@ategra.ch|Protogrid Support]]. | ||
The following JSON data fields can be used: | The following JSON data fields can be used: | ||
Line 468: | Line 476: | ||
* attachments: | * attachments: | ||
- | To use this endpoint, a mail server | + | Attachments and inline images must already reside inside Protogrid, each attached to a Card. The logged in user must have read access to this Card(s). Attachments and inline images are specified |
+ | <code javascript> | ||
+ | { | ||
+ | | ||
+ | | ||
+ | } | ||
+ | </ | ||
- | Protogrid will fist try to establish | + | By default, users can send a mail to up to 10 recipients. This limit can be increased via the roles assigned |
- | + | ||
- | If Sender Policy Framework (SPF) is used for the particular | + | |
The returned result will include a success message or details about the particular error. | The returned result will include a success message or details about the particular error. | ||
Line 481: | Line 493: | ||
url: " | url: " | ||
data: JSON.stringify({ | data: JSON.stringify({ | ||
- | " | + | " |
- | " | + | " |
- | " | + | " |
- | " | + | " |
- | " | + | " |
- | " | + | " |
- | " | + | " |
- | " | + | " |
" | " | ||
{" | {" | ||
Line 502: | Line 514: | ||
</ | </ | ||
+ | As a response you receive a JSON with the following structure: | ||
+ | * errors [Array]: Contains information if no single email could be sent, otherwise it is empty. | ||
+ | * messages [Array]: Contains information if Protogrid could not establish the connection to the mail server with the most secure transport encryption, otherwise it is empty. | ||
+ | * result [Object]: Contains information regarding individual recipients to whom the email could not be delivered. If the email could be delivered to all recipients equals to { " | ||
- | Example | + | Example |
<code javascript> | <code javascript> | ||
{ | { | ||
- | | + | |
- | " | + | " |
- | "success": | + | [ |
- | } | + | " |
+ | " | ||
+ | ], | ||
+ | | ||
+ | | ||
+ | | ||
+ | [ | ||
+ | 554, | ||
+ | "5.7.1 < | ||
+ | ] | ||
+ | | ||
} | } | ||
</ | </ |