Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
protogrid:api_endpoints [2021-12-02 12:12] – [/api/v2/apps/<app_name>/mailsend] dru | protogrid:api_endpoints [2021-12-20 15:38] (current) – [/api/v2/apps/<app_name>/protos/<proto_key>/card-keys] 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 446: | Line 448: | ||
" | " | ||
" | " | ||
+ | " | ||
+ | " | ||
" | " | ||
], | ], | ||
Line 454: | Line 458: | ||
==== / | ==== / | ||
- | [POST] Send an email using the provided data | + | [POST] Send an email |
- | To use this endpoint, | + | To be able to use this endpoint, |
- | Protogrid will fist try to establish a TLS session to the specified mail server and authenticate using the supplied credentials. If TLS is not available it will try to connect using SSL. Finally if SSL is not available the function tries to connect using unsecured SMTP protocol. | + | Protogrid will fist try to establish a TLS session to the specified mail relay server and authenticate using the supplied credentials. If TLS is not available it will try to connect using SSL. Finally if SSL is not available the function tries to connect using unsecured SMTP protocol. |
- | If Sender Policy Framework (SPF) is used for the particular | + | The mail will be sent according |
The following JSON data fields can be used: | The following JSON data fields can be used: | ||
Line 474: | Line 478: | ||
* attachments: | * attachments: | ||
- | 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 | + | 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 |
<code javascript> | <code javascript> | ||
{ | { | ||
" | " | ||
- | " | + | " |
} | } | ||
</ | </ | ||
- | By default, users can send a mail to up to 10 recipients. This limit can be increased via the roles assigned to the users using the field " | + | By default, users can send a mail to up to 10 recipients. This limit can be increased via the roles assigned to the users using the field " |
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 491: | Line 495: | ||
url: " | url: " | ||
data: JSON.stringify({ | data: JSON.stringify({ | ||
- | " | + | " |
- | " | + | " |
- | " | + | " |
- | " | + | " |
- | " | + | " |
- | " | + | " |
- | " | + | " |
- | " | + | " |
" | " | ||
{" | {" | ||
Line 512: | Line 516: | ||
</ | </ | ||
+ | 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 < | ||
+ | ] | ||
+ | | ||
} | } | ||
</ | </ |