Skip to content

Commit

Permalink
Minor corrections
Browse files Browse the repository at this point in the history
  • Loading branch information
queuemail committed Jul 13, 2023
1 parent 91e94ad commit a759a72
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Some sample features:

- 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-mails.md) you can discard sending errors before you start a SMTP session.
- 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).

Expand Down
2 changes: 1 addition & 1 deletion _sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
* [Login](api-login.md)
* [Apps](api-apps.md)
* [SMTP servers](api-smtps.md)
* [Mails](api-mails.md)
* [Mails](api-emails.md)
* [Blacklists](api-blacklists.md)
* [Logs](api-logs.md)
* [Tracking](api-tracking.md)
Expand Down
10 changes: 5 additions & 5 deletions api-mails.md → api-emails.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Using these endpoint you can send (queue up) emails, get emails send information

**REQUEST:**

*POST* /private/mails/send
*POST* /private/emails/send

|Parameter|Description|Required| Default |
|---------|-----------|--------|---------|
Expand Down Expand Up @@ -96,7 +96,7 @@ You will get a JSON response like this:

**REQUEST:**

*GET* /private/mails/info
*GET* /private/emails/info

|Parameter|Description|Required| Default |
|---------|-----------|--------|---------|
Expand Down Expand Up @@ -156,7 +156,7 @@ You will get a JSON response like this:

**REQUEST:**

*POST* /private/mails/cancel
*POST* /private/emails/cancel

|Parameter|Description|Required| Default |
|---------|-----------|--------|---------|
Expand Down Expand Up @@ -206,14 +206,14 @@ You will get a JSON response like this:



<!-- tab:Remove a email -->
<!-- tab:Remove an email -->

Remove a finished email. Also remove all logs and tracking info.

**REQUEST:**


*POST* /private/mails/remove
*POST* /private/emails/remove

|Parameter|Description|Required| Default |
|---------|-----------|--------|---------|
Expand Down
4 changes: 2 additions & 2 deletions features-dataretention.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ Apps, by default, retain subject and body data **until email is sucessfully sent

If you want to retain these data permanently, you must use *retaindata=true* when [creating/editing your app](api-apps.md).

If you want to use *attachmenttype=URL* when you [send an email](api-mails.md), you must use *retaindata=true* in your app.
If you want to use *attachmenttype=URL* when you [send an email](api-emails.md), you must use *retaindata=true* in your app.

Whether you use *retaindata=true* or not you can call [/private/mails/remove](api-mails.md) endpoint to remove all data and logs of finished emails.
Whether you use *retaindata=true* or not you can call [/private/emails/remove](api-emails.md) endpoint to remove all data and logs of finished emails.

Due to traceability reasons, we do not remove any email address.

Expand Down
2 changes: 1 addition & 1 deletion features-limitorigin.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
When [creating/editing your app](api-apps.md) optionally you can set a origin server or IP in order to limit servers/IPs from which [call to send emails](api-mails.md) can be made.
When [creating/editing your app](api-apps.md) optionally you can set a origin server or IP in order to limit servers/IPs from which [call to send emails](api-emails.md) can be made.

If you don't set this parameter your app can be used from any IP without checking request origin.

Expand Down

0 comments on commit a759a72

Please sign in to comment.