Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
protogrid:api_endpoints [2021-12-09 00:34] – [/api/v2/apps/<app_name>/mailsend] druprotogrid:api_endpoints [2021-12-20 15:38] (current) – [/api/v2/apps/<app_name>/protos/<proto_key>/card-keys] dru
Line 448: Line 448:
   "result": [   "result": [
     "card_keys":[     "card_keys":[
 +      "ExampleProtoKey",
 +      "ExampleSortstring",
       "ExampleCardKey"       "ExampleCardKey"
     ],     ],
Line 458: Line 460:
 [POST] Send an email [POST] Send an email
  
-To use this endpoint, mail server must be specified in the environment properties (fields "SMTP Server Hostname" and "SMTP Server Port"). The mail will be sent according to the currently logged in user (mail address specified in user profile and the field "SMTP Server Password" if requested by the mailserver)+To be able to use this endpoint, the SMTP mail server of your organization must first be configured as the designated mail relay server in your Environment. If this has not been done yet, please contact [[protogrid-customer-support@ategra.ch|Protogrid Support]].
  
-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 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 mail will be sent according to the currently logged in user (mail address specified in user profile and the field "SMTP Server Password" if requested by the mailserver).
  
 The following JSON data fields can be used: The following JSON data fields can be used:
Print/export