Skip to content

Latest commit

 

History

History
52 lines (29 loc) · 2.98 KB

api-apps.md

File metadata and controls

52 lines (29 loc) · 2.98 KB
Raw

By accessing control panel you can manage your apps.

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.

For creating a new app cikc NEW APP button and you will acess the following screen:

You must set your app name at lest. Moreover you can define:

  1. Retain sensitive info: If checked, sensitive email info (subject, body and url attachments) will be retained in database until you will delete it manually. Otherwise, this info will not be stored in database.

  2. Use blacklist: If checked, recipients can block receiving future emails by clicking 'unsubscribe link'.

  3. Use auto-blacklist: If checked, system can block future emails for recipients with permanent or repetitive problems.

  4. Strategy: If app uses PRIORITY or RANDOM strategy to select SMTP server will be used for send emails. For free-tier only RANDOM strategy works.

  5. Seconds between emails: Minimun time between emails. For free-tier 60 seconds minimun always.

  6. Origin hosts/IPs: If set, you can send emails just from these hosts/IPs. Comma separated for multiple values.

  7. Test email address: Email recipient to test sending emails. Email address used at sign up by default.

  8. Default sender email address: Sender address email by defaul for this app. Email address used at sign up by default.

  9. Default sender name: Sender name by default for this app. Email address used at sign up by default.

  10. Webhook URL for email is sent ok: URL called when emails are sent sucessfully. This URL will receive parameter qm_idsending with email id as value.

  11. Webhook URL for email is not sent: URL llamada cuando los emails fallan. Esta URL recibe el parámetro qm_idsending con el id del email como valor.

  12. Webhook URL for email opened: URL called when a recipient opens email. This URL will receive parameter qm_idsending with email id as value and parameter qm_email with recipient email address as value.

  13. Webhook URL for link clicked: URL called when a recipient clicks a link on the received email. This URL will receive parameter qm_idsending with email id as value, parameter qm_email with recipient email address as value and qm_url with URL of link clicked as value.

  14. Webhook URL for recipient added to blacklist: URL called when a recipient requests to be included in the app blacklist. This URL will receive parameter qm_idsending with email id as value and parameter qm_email with recipient email address as value.

When completed these data we will click SAVE button and we can see app API ID value we will use for make API calls: