Skip to content
GitLab
Explore
Projects
Groups
Snippets
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
Martin Dinov
POD
Commits
ac7c0cc0
Unverified
Commit
ac7c0cc0
authored
3 years ago
by
Vasili Novikov
Browse files
Options
Download
Email Patches
Plain Diff
Add docs for send_email functionality
parent
4adb4e59
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/HTTP_API.md
+25
-2
docs/HTTP_API.md
with
25 additions
and
2 deletions
+25
-2
docs/HTTP_API.md
+
25
-
2
View file @
ac7c0cc0
...
...
@@ -315,8 +315,6 @@ Returns an empty object if the operation is successful.
# Plugins API
⚠️ Isn't fully implemented yet, assume the real implementation to arrive 2021-04 - 2021-05
Plugins help getting data into your Pod and enriching it.
Plugins must be authorized and started by the user.
...
...
@@ -339,6 +337,31 @@ See [Plugins](./Plugins.md) on how plugins are started exactly.
e.g. permission limitation.
# Email API
Email API is a temporary functionality of Pod that allows it to send emails.
### POST /v4/$owner_key/send_email
To send an item to a particular user via the Pod, make the following API request:
```
json5
{
"auth": $auth_json,
"payload": {
"to": "address@example.com",
"subject": "Example subject",
"body": "Example message body."
}
}
```
This will make Pod send that single email and return a success if the email was
accepted by the configured SMTP server.
No retries will be made if SMTP connection did not succeed.
No changes will be made to the database.
⚠️ UNSTABLE: the API is unstable and might be removed without prior notice.
# File API
### POST /v4/$owner_key/upload_file/$databaseKey/$sha256hashOfTheFile
...
...
This diff is collapsed.
Click to expand it.
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment
Menu
Explore
Projects
Groups
Snippets