Skip to content

Commit

Permalink
Minor fix
Browse files Browse the repository at this point in the history
  • Loading branch information
queuemail committed Jul 13, 2023
1 parent 9aa55cc commit bc7fafb
Show file tree
Hide file tree
Showing 7 changed files with 20 additions and 20 deletions.
8 changes: 4 additions & 4 deletions api-apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@ Each app should correspond to a project or project part which has different beha
|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 mail sent is ok | No |
|webhook_sending_error | URL called when mail sent fails | No |
|webhook_tracking_opened | URL called when mail is opened | 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 mail address is added to blacklist | No |
|webhook_blacklisted_added | URL called when email address is added to blacklist | No |

**STATUS CODES:**

Expand Down
2 changes: 1 addition & 1 deletion api-blacklists.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ You will get a JSON response like this:
}
```

- **idsending** mail sending id if blacklist has been created due to a mail sending.
- **idsending** email sending id if blacklist has been created due to a email sending.
- **ip** ip origin of blacklist add.
- **created** when the email has been added to blacklist.

Expand Down
6 changes: 3 additions & 3 deletions api-emails.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ You will get a JSON response like this:

|Parameter|Description|Required| Default |
|---------|-----------|--------|---------|
|idmail | Mail id | Yes | |
|idmail | Email id | Yes | |

**STATUS CODES:**

Expand Down Expand Up @@ -160,7 +160,7 @@ You will get a JSON response like this:

|Parameter|Description|Required| Default |
|---------|-----------|--------|---------|
|idmail | Mail id | Yes | |
|idmail | Email id | Yes | |

**STATUS CODES:**

Expand Down Expand Up @@ -202,7 +202,7 @@ You will get a JSON response like this:
}
```

**status** field = C means the mail has been canceled.
**status** field = C means the email send has been canceled.



Expand Down
4 changes: 2 additions & 2 deletions api-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Using these endpoint you can get email logs.

|Parameter|Description|Required| Default |
|---------|-----------|--------|---------|
|idmail | Mail id | Yes | |
|idmail | Email id | Yes | |

**STATUS CODES:**

Expand Down Expand Up @@ -54,7 +54,7 @@ You will get a JSON response like this:
]
```

- Response is composed by an array with all operations associated with the mail sent (**idsending**)
- Response is composed by an array with all operations associated with the email sent (**idsending**)
- **idsmtp** is the id of the SMTP used for sending.
- **resultcode** can be "OK" for sucess sending. "BLACKLISTED" if recipient has been included in blacklsit. "AUTOBLACKLISTED" if recipient has been included in auto-blacklist. Also can be a specific error code (ATTACHMENT_PROBLEM, SMTP_CONNECT_FAILS, SMTP_CONNECT_TIMEOUT, etc.)
- **created** is the operation date/time.
Expand Down
8 changes: 4 additions & 4 deletions api-tracking.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Using this endpoint you can manage email tracking: opened emails and email link

|Parameter|Description|Required| Default |
|---------|-----------|--------|---------|
|idmail | Mail id | Yes | |
|idmail | Email id | Yes | |

**STATUS CODES:**

Expand Down Expand Up @@ -54,13 +54,13 @@ You will get a JSON response like this:
]
```

- Response is composed by an array with all operations associated with the mail sent (**idsending**)
- Response is composed by an array with all operations associated with the email sent (**idsending**)
- **idmailing** is the id of the mailing (if exists) asociated with this email sending
- **email** is the recipient asocciated with this tracking info (who opened mail or clicked link)
- **email** is the recipient asocciated with this tracking info (who opened email or clicked email link)
- **type** is OPEN for tracking opened emails and CLICK for tracking clicked links.
- **created** is the operation date/time.
- **idapp** is the id of the App used but only has value in some operations.
- **ip** is the origin ip from the recipient opened mail or clicked link.
- **ip** is the origin ip from the recipient opened email or clicked email link.
- **url** is the target URL in an clicked link tracking info.


Expand Down
2 changes: 1 addition & 1 deletion features-smtpstrategies.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ When [creating/editing your app](apps.md), you can choose beetween RANDOM and PR

If you don't specify *strategy* parameter, RANDOM strategy is assumed by default.

If you specify *strategy=PRIORITY*, in each mail sending SMTP server with higher priority will be use at first. In case of error, next SMTP with higher priority will be used, and so on.
If you specify *strategy=PRIORITY*, in each email sending SMTP server with higher priority will be use at first. In case of error, next SMTP with higher priority will be used, and so on.

You can define priority for each SMTP when [creating/editing your SMTP servers](api-smtps.md).

Expand Down
10 changes: 5 additions & 5 deletions features-webhooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@ Webhooks feature let you to configure your own URLs in order to run processes wh

There are the following webhook events:

- *sending_finished*: URL is called with param *qm_idsending* (id of sent mail) when email is sucessfully sent.
- *sending_error*: URL is called with param *qm_idsending* (id of sent mail) when email send fails.
- *tracking_opened*: URL is called with params *qm_idsending* (id of sent mail) and *qm_email* (recipient email) when email is opened.
- *tracking_clicked*: URL is called with params *qm_idsending* (id of sent mail), *qm_email* (recipient email) and *qm_url* (url clicked) when recipient clicks a link email (qm_url).
- *blacklisted_added*: URL is called with params *qm_idsending* (id of sent mail) and *qm_email* (email address to blacklist) when an email address is added to blacklist.
- *sending_finished*: URL is called with param *qm_idsending* (id of email sent) when email is sucessfully sent.
- *sending_error*: URL is called with param *qm_idsending* (id of email sent) when email send fails.
- *tracking_opened*: URL is called with params *qm_idsending* (id of email sent) and *qm_email* (recipient email) when email is opened.
- *tracking_clicked*: URL is called with params *qm_idsending* (id of email sent), *qm_email* (recipient email) and *qm_url* (url clicked) when recipient clicks a link email (qm_url).
- *blacklisted_added*: URL is called with params *qm_idsending* (id of email sent) and *qm_email* (email address to blacklist) when an email address is added to blacklist.

You can configure your webhooks URLs when [creating/editing your app](api-apps.md).

Expand Down

0 comments on commit bc7fafb

Please sign in to comment.