First spanish version

queuemail · Jul 17, 2023 · 83cccb3 · 83cccb3
1 parent 39eff5a
commit 83cccb3
Show file tree

Hide file tree

Showing 35 changed files with 1,866 additions and 0 deletions.
diff --git a/es/.nojekyll b/es/.nojekyll
diff --git a/es/README.md b/es/README.md
@@ -0,0 +1,26 @@
+# QUEUEMAIL.DEV - Reliable email delivery API. Free tier. Send asynchronously.
+
+Main docs page here --> [https://docs.queuemail.dev/](https://docs.queuemail.dev/)
+
+QUEUEMAIL.DEV allows you to send emails via API using one or more SMTP servers in order to ensure deliverability and avoid SMTP stress.
+
+Some sample features:
+
+- You can program sending emails in a synchronous or asynchronous way: With [logs endpoint](api-logs.md) you can check send status for every email sent. 
+
+- Also, with [webhooks](features-webhooks.md), you can run processes when an event (like email sucessfully sent) occurs for a complete integration.
+
+- With [sending email endpoint](api-emails.md) you can discard sending errors before you start a SMTP session.
+
+- Track opened emails and clicked email links with [tracking endpoint](api-tracking.md).
+
+- ...and much more at [docs](https://docs.queuemail.dev).
+
+Free tier does not support Queuemail professional SMTP servers. So you must to configure [free SMTP servers](other-freesmtps.md) or your custom SMTP server.
+
+
+
+### CLIENTS AND EXAMPLES:
+
+* [queuemail-client: A basic Java client to use QUEUEMAIL.DEV API](https://github.com/queuemail/docs-and-examples/tree/main/queuemail-client)
+
diff --git a/es/_sidebar.md b/es/_sidebar.md
@@ -0,0 +1,32 @@
+### &nbsp; Features:
+* [Fault tolerance strategies](features-smtpstrategies.md)
+* [Loging activity and erros](features-loging.md)
+* [Blacklists](features-blacklists.md)
+* [Webhooks](features-webhooks.md)
+* [Limit origin](features-limitorigin.md)
+* [Data retention](features-dataretention.md)
+
+
+### &nbsp; API Reference:
+* [API limitations](api-limitations.md)
+* [API access](api-access.md)
+* [Login](api-login.md)
+* [Apps](api-apps.md)
+* [SMTP servers](api-smtps.md)
+* [Emails](api-emails.md)
+* [Blacklists](api-blacklists.md)
+* [Logs](api-logs.md)
+* [Tracking](api-tracking.md)
+
+
+### &nbsp; Other:
+* [FAQs](other-faqs.md)
+* [Free SMTP servers](other-freesmtps.md)
+
+
+### &nbsp; Legal:
+* [Private policy](legal-privatepolicy.md)
+* [Contact us](legal-contact.md)
+
+
+
diff --git a/es/api-access.md b/es/api-access.md
@@ -0,0 +1,15 @@
+
+
+
+For accessing QUEUEMAIL API you need to [register here](xsignup.md). Then, with your username and password, you can [login](api-login.md) and get a token you will use in all API operations.
+
+Token expiration = 24 hours.
+
+### API endpoint base URL:
+
+https://api.queuemail.dev/api 
+
+
+
+
+
diff --git a/es/api-apps.md b/es/api-apps.md
@@ -0,0 +1,250 @@
+You need to create at least an app to use QUEUEMAIL. 
+
+Each app should correspond to a project or project part which has different behaviour.
+
+<!-- tabs:start -->
+
+<!-- tab:Create/edit an app -->
+
+
+**REQUEST:** 
+
+*POST* /private/apps/save
+
+|Parameter|Description|Required| Default |
+|---------|-----------|--------|---------|
+|idapp | App id | Yes for editing, No for creating |  |
+|name | App name  | Yes for creating, No for editing |  |
+|retaindata | If this app must preserve subject, body and url attachments | No | No |
+|strategy | RANDOM / PRIORITY  | No  | RANDOM |
+|originserver | If set, you can make calls just from this servers/IPs (comma separated for multiple values) | No  |
+|defaultfromemail | Default from email when sending emails | No | User's email |
+|defaultfromname | Default from name when sending emails | No | User's email |
+|testemail | Recipient email for testing emails  | No | User's email |
+|timebetweenemails | Seconds between emails  | No | 60 |
+|useblacklist | If this app must use black list  | No | No |
+|useautoblacklist | If this app must use auto black list  | No | No |
+|webhook_sending_finished | URL called when email send finish sucessfully  | No |
+|webhook_sending_error | URL called when email send fails  | No |
+|webhook_tracking_opened | URL called when email is opened  | No |
+|webhook_tracking_clicked | URL called when when link in email is clicked | No |
+|webhook_blacklisted_added | URL called when email address is added to blacklist | No |
+
+**STATUS CODES:**
+
+|Code|Description|
+|----|-------|
+|200 | Success |
+|400 | Missing required parameter or wrong parameter type |
+|401 | User not authorized |
+|403 | Credentials not valid |
+|406 | Specific error |
+|500 | Internal error|
+
+Specific errors:
+
+1. Already exists an APP with the same name
+2. App not found
+3. Must provide a name
+4. You can choose between setting originserver (backend apps) or setting origindomain (frontend apps)
+
+
+
+**RESPONSE:**
+
+You will get a JSON response like this:
+
+```
+{
+    "token": "eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiI2M2JiZTU4NmRkMDcwYjc4ZmI0OTVlZDIiLCJzdWIiOiJ1c2VyMSIsImF1ZCI6InVzZXIiLCJpc3MiOiJDSS0xNTFhY2U2OS1kZTkyLTQwYjQtYmY5NC04OGRmZWIzNTc1ZjQiLCJpYXQiOjE2ODQ3NDg0MTUsImV4cCI6MTY4NDgzNDgxNX0.CcNyo8Ug45dNLNZ0Q41wpPObrFI-hagaJdat3ryxqdo",
+    "role": "user",
+    "userId": "63bbe586dd070b78fb495ed2",
+    "username": "username",
+    "clientId": "CI-151ace69-de92-40b4-bf94-88dfeb3575f4"
+}
+```
+
+Now, you can use the value of **token** field in header *Authorization* in all API operations as a Bearer token:
+
+```
+Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiI2M2JiZTU4NmRkMDcwYjc4ZmI0OTVlZDIiLCJzdWIiOiJ1c2VyMSIsImF1ZCI6InVzZXIiLCJpc3MiOiJDSS0xNTFhY2U2OS1kZTkyLTQwYjQtYmY5NC04OGRmZWIzNTc1ZjQiLCJpYXQiOjE2ODQ3NDg0MTUsImV4cCI6MTY4NDgzNDgxNX0.CcNyo8Ug45dNLNZ0Q41wpPObrFI-hagaJdat3ryxqdo
+```
+<!-- tab:List all apps -->
+
+
+
+**REQUEST:** 
+
+*GET* /private/apps/findAll
+
+|Parameter|Description|Required| Default |
+|---------|-----------|--------|---------|
+|page | Initial page | Yes |  |
+|size | Page máximun size | Yes |  |
+
+**STATUS CODES:**
+
+|Code|Description|
+|----|-------|
+|200 | Success |
+|400 | Missing required parameter or wrong parameter type |
+|401 | User not authorized |
+|403 | Credentials not valid |
+|500 | Internal error|
+
+
+
+**RESPONSE:**
+
+
+You will get a JSON response like this:
+
+```
+{
+    "content": [
+        {
+            "_id": "63ca50f0c9557c7ac25f1715",
+            "iduser": "63bbe586dd070b78fb495ed2",
+            "name": "APP2",
+            "strategy": "PRIORITY",
+            "origindomain": null,
+            "defaultfromemail": "user1@email.xxx",
+            "defaultfromname": "Jonh Smith",
+            "testemail": "user1@email.xxx",
+            "timebetweenemails": 0,
+            "useblacklist": true,
+            "useautoblacklist": false,
+            "webhook_sending_finished": null,
+            "webhook_sending_error": null,
+            "webhook_tracking_opened": null,
+            "webhook_tracking_clicked": null,
+            "webhook_blacklisted_added": null,
+            "webhook_mailing_finished": null,
+            "language": "EN",
+            "created": "2023-01-20T08:29:36.763",
+            "modified": "2023-01-20T08:29:36.763",
+            "status": "A"
+        }
+    ],
+    "pageable": {
+        "sort": {
+            "empty": true,
+            "sorted": false,
+            "unsorted": true
+        },
+        "offset": 1,
+        "pageNumber": 1,
+        "pageSize": 1,
+        "paged": true,
+        "unpaged": false
+    },
+    "last": false,
+    "totalPages": 6,
+    "totalElements": 6,
+    "size": 1,
+    "number": 1,
+    "sort": {
+        "empty": true,
+        "sorted": false,
+        "unsorted": true
+    },
+    "first": false,
+    "numberOfElements": 1,
+    "empty": false
+}
+```
+
+Field **content** is a list containing all the existing apps for the logged account.
+
+
+<!-- tab:App info -->
+
+
+
+
+**REQUEST:** 
+
+*GET* /private/apps/findById
+
+|Parameter|Description|Required| Default |
+|---------|-----------|--------|---------|
+|idapp | App id | Yes |  |
+
+**STATUS CODES:**
+
+|Code|Description|
+|----|-------|
+|200 | Success |
+|400 | Missing required parameter or wrong parameter type |
+|401 | User not authorized |
+|403 | Credentials not valid |
+|500 | Internal error|
+
+
+
+**RESPONSE:**
+
+
+You will get a JSON response like this:
+
+```
+{
+    "_id": "63ca50f0c9557c7ac25f1715",
+    "iduser": "63bbe586dd070b78fb495ed2",
+    "name": "APP2",
+    "strategy": "PRIORITY",
+    "origindomain": null,
+    "defaultfromemail": "user2@xxx.xxx",
+    "defaultfromname": "Jonh Smith",
+    "testemail": "user2@xxx.xxx",
+    "timebetweenemails": 0,
+    "useblacklist": true,
+    "useautoblacklist": false,
+    "webhook_sending_finished": null,
+    "webhook_sending_error": null,
+    "webhook_tracking_opened": null,
+    "webhook_tracking_clicked": null,
+    "webhook_blacklisted_added": null,
+    "webhook_mailing_finished": null,
+    "language": "EN",
+    "created": "2023-01-20T08:29:36.763",
+    "modified": "2023-01-20T08:29:36.763",
+    "status": "A"
+}
+```
+
+
+
+<!-- tab:Delete an app -->
+
+**REQUEST:** 
+
+
+*POST* /private/apps/remove
+
+|Parameter|Description|Required| Default |
+|---------|-----------|--------|---------|
+|idapp | App id | Yes |  |
+
+**STATUS CODES:**
+
+|Code|Description|
+|----|-------|
+|200 | Success |
+|400 | Missing required parameter or wrong parameter type |
+|401 | User not authorized |
+|403 | Credentials not valid |
+|406 | Specific error |
+|500 | Internal error|
+
+Specific errors:
+
+1. App not found
+
+
+**RESPONSE:**
+
+*empty*
+
+<!-- tabs:end -->
+