Skip to content

Commit

Permalink
Control panel accces. Apps and SMTP servers must be created via contr…
Browse files Browse the repository at this point in the history
…ol panel. API calls for manage apps and SMTP servers are removed.
  • Loading branch information
queuemail committed Sep 1, 2023
1 parent 3df37c1 commit 4d14d14
Show file tree
Hide file tree
Showing 17 changed files with 209 additions and 9 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ Free tier does not support Queuemail professional SMTP servers. So you must to c


### CHANGELOG:

* **2023-09-01**: <a href="https://queuemail.dev/qmadmin/login">Control panel</a> accces. Apps and SMTP servers must be created via control panel. API calls for manage apps and SMTP servers are removed.

* **2023-07-21**: Added example: [Hardy Client: A robust Java client to use QUEUEMAIL.DEV API](examples-hardyservice.md).

* **2023-07-18**: Added *senddate* parameter to [sending emails endpoint](api-emails.md) in order to schedule emails to send.
7 changes: 5 additions & 2 deletions _sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,17 @@
* [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; Control Panel:
* [Apps](api-apps.md)
* [SMTP servers](api-smtps.md)


### &nbsp; Other:
* [FAQs](other-faqs.md)
* [Free SMTP servers](other-freesmtps.md)
Expand Down
4 changes: 2 additions & 2 deletions api-access.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ Then, you need to follow these steps:

1. Log in <a target="_blank" href="https://queuemail.dev/qmadmin/">control panel</a> using your username and password,

2. Create an app from control panel. Each app has an ID you will use for API requests.
2. [Create an app from control panel](api-apps.md). Each app has an ID you will use for API requests.

3. Create, at least, a SMTP server asociated to that app from control panel. Each SMTP server has an ID you will use for API requests.
3. [Create, at least, a SMTP server asociated to that app from control panel](api-smtps.md). Each SMTP server has an ID you will use for API requests.

4. Then, with your user and password you can [login](api-login.md) and get a token you will use in all API operations.

Expand Down
52 changes: 52 additions & 0 deletions api-apps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
By accessing <a target="_blank" href="https://queuemail.dev/qmadmin/login">control panel</a> 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.

<div style="width:100%; text-align:center;">
<img src="/list-apps.png" />
</div>

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

<div style="width:100%; text-align:center;">
<img src="/new-app.png">
</div>

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

1. <b>Retain sensitive info</b>: 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. <b>Use blacklist</b>: If checked, recipients can block receiving future emails by clicking 'unsubscribe link'.

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

4. <b>Strategy</b>: 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. <b>Seconds between emails</b>: Minimun time between emails. For free-tier 60 seconds minimun always.

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

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

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

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

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

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

12. <b>Webhook URL for email opened</b>: 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. <b>Webhook URL for link clicked</b>: 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. <b>Webhook URL for recipient added to blacklist</b>: 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:

<div style="width:100%; text-align:center;">
<img src="/list-apps-2.png" />
</div>
43 changes: 43 additions & 0 deletions api-smtps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
By accessing <a target="_blank" href="https://queuemail.dev/qmadmin/login">control panel</a> you can manage your SMTP servers.

You must define at least a SMTP server asociated to your app in order you can use QUEUEMAIL for free.

If you use QUEUEMAIL professional plan (not free) you don't need to define any SMTP server because for your mail send you will use QUEUEMAIL professional SMTP servers.

If you don't have an own SMTP server you can [get a free SMTP server here](other-freesmtps.md).

<div style="width:100%; text-align:center;">
<img src="/list-smtps.png" />
</div>

For creating a new SMTP server click NEW SMTP SERVER button and you will access the following screen:

<div style="width:100%; text-align:center;">
<img src="/new-smtp.png">
</div>

You must set at lest app you want to asociate to SMTP server, host (or IP) of the server and port used by SMTP server. Moreover, you can define:

1. <b>Use authentication</b>: If SMTP server needs user and password authentication for sending emails.

2. <b>Use STARTTLS</b>: If SMTP server uses <a href="https://en.wikipedia.org/wiki/Opportunistic_TLS">STARTTLS</a>.

3. <b>Use SSLTLS</b>: If SMTP server uses <a href="https://en.wikipedia.org/wiki/Transport_Layer_Security">SSLTLS</a>.

4. <b>Priority</b>: Used for select SMTP to use if app has PRIORITY strategy (lower value, higher priority).

5. <b>User name</b>: User name used for authentification on the SMTP server.

6. <b>Password</b>: Password used for authefication on the SMTP server.

7. <b>Default sender email address</b>: If set, sender email address is always replaced by this value for all emails sent using this SMTP server.

8. <b>Default sender name</b>: If set, sender name is always replaced by this value for all emails sent using this SMTP server.

When completed these data we will click CHECK AND SAVE to check if SMTP server works ok by sending an email to test email address of the asociated app. If works, SMTP server will be shown as enabled (green circle). Otherwise it will be shown as disabled (red circle) and it will remain disabled until we edit it and save it with correct data.

Anyway, the new SMTP sever API ID will be show. We need this info in order to make API calls.

<div style="width:100%; text-align:center;">
<img src="/list-smtps-2.png" />
</div>
2 changes: 2 additions & 0 deletions es/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ La capa gratuita no incluye el uso de los servidores SMTP profesionales de Queue

### REGISTRO DE CAMBIOS:

* **2023-09-01**: Acceso al <a href="https://queuemail.dev/qmadmin/login">panel de control</a>. Apps y servidores SMTP deben ser creadas mediante el panel de control. Se eliminan llamadas de la API para esto.

* **2023-07-21**: Añadido el ejemplo: [Hardy Client: Un cliente en Java robusto para usar QUEUEMAIL.DEV API](examples-hardyservice.md).

* **2023-07-18**: Se añade el parámetro *senddate* a la llamada para [enviar emails](api-emails.md) que permite programar envíos en el futuro.
Expand Down
5 changes: 3 additions & 2 deletions es/_sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,14 @@
* [Limitaciones de la API](api-limitations.md)
* [Acceso a la API](api-access.md)
* [Login](api-login.md)
* [Apps](api-apps.md)
* [Servidores SMTP](api-smtps.md)
* [Emails](api-emails.md)
* [Blacklists](api-blacklists.md)
* [Logs](api-logs.md)
* [Tracking](api-tracking.md)

### &nbsp; Panel de control:
* [Apps](api-apps.md)
* [Servidores SMTP](api-smtps.md)

### &nbsp; Otros:
* [Preguntas frecuentes](other-faqs.md)
Expand Down
4 changes: 2 additions & 2 deletions es/api-access.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ Una vez te hayas registrado debes seguir los siguientes pasos:

1. Entrar en el <a target="_blank" href="https://queuemail.dev/qmadmin/">panel de control</a> con tu usuario y contraseña.

2. Crear una app desde el panel de control. Cada app creada tiene un ID que usarás en las peticiones a la API.
2. [Crear una app desde el panel de control](api-apps.md). Cada app creada tiene un ID que usarás en las peticiones a la API.

3. Crear al menos un servidor SMTP asociado a esa app desde el panel de control. Cada smtp creado tiene un ID que usarás en las peticiones a la API.
3. [Crear al menos un servidor SMTP asociado a esa app desde el panel de control](api-smtps.md). Cada smtp creado tiene un ID que usarás en las peticiones a la API.

4. Luego, con tu usuario y contraseña, puedes hacer [login](api-login.md) y obtener el token que usarás en todas las peticiones a la API.

Expand Down
52 changes: 52 additions & 0 deletions es/api-apps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
Una vez accedes al <a target="_blank" href="https://queuemail.dev/qmadmin/login">panel de control</a> tienes la posibilidad de gestionar tus apps.

Necesitas crear al menos una app para usar QUEUEMAIL.

Cada app puede corresponder a un proyecto o parte del proyecto con diferente comportamiento.

<div style="width:100%; text-align:center;">
<img src="/list-apps.png" />
</div>

Para crear una app pulsarás el botón NEW APP y aparecerá la siguiente pantalla:

<div style="width:100%; text-align:center;">
<img src="/new-app.png">
</div>

Como mínimo debes completar el nombre de tu APP. El resto de parámetros significa lo siguiente:

1. <b>Retain sensitive info</b>: Si se marca, la información sensitiva del email (asunto, cuerpo y url de adjuntos) serán conservados en la base de datos hasta que no se borren manualmente. En otro caso esta información no se guardará en la base de datos.

2. <b>Use blacklist</b>: Si se marca, los receptores de los emails podrán bloquear futuros envíos pulsando el enlace de baja.

3. <b>Use auto-blacklist</b>: Si se marca, el sistema puede bloquear envíos a receptores con problemas permanentes o repetitivos.

4. <b>Strategy</b>: Si la app usa la estrategia de prioridad (PRIORITY) o aleatoria (RANDOM) para seleccionar el servidor SMTP que se usará para el envío. Para la capa gratuita solo es posible RANDOM.

5. <b>Seconds between emails</b>: Este valor controla cuanto tiempo mínimo se espera entre el envío de emails para esta APP. Para la capa gratuita será siempre un mínimo de 60 segundos.

6. <b>Origin hosts/IPs</b>: Si se marca, solo puedes enviar emails desde los hosts/IPs especificados. Se pueden poner varios separados por comas.

7. <b>Test email address</b>: Dirección de correo de pruebas. Si no se especifica será la dirección de correo del usuario registrado.

8. <b>Default sender email address</b>: Dirección de correo del emisor del envío por defecto. Si al envíar un correo no se especifica dirección de correo del emisor (from) se usará esta dirección de correo. Si no se especifica será la dirección de correo del usuario registrado.

9. <b>Default sender name</b>: Nombre del emisor del envío por defecto. Si al envíar un correo no se especifica nombre de emisor (fromname) se usará este nombre. Si no se especifica será la dirección de correo del usuario registrado.

10. <b>Webhook URL for email is sent ok</b>: URL llamada cuando los emails son enviados correctamente. Esta URL recibe el parámetro qm_idsending con el id del email como valor.

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

12. <b>Webhook URL for email opened</b>: URL llamada cuando el destinatario abre un email. Esta URL recibe el parámetro qm_idsending con el id del email como valor y el parámetro qm_email con la dirección de correo del destinatario que ha abierto el email como valor.

13. <b>Webhook URL for link clicked</b>: URL llamada cuando el destinatario hace click en un enlace del email recibido. Esta URL recibe el parámetro qm_idsending con el id del email como valor, el parámetro qm_email con la dirección de correo del destinatario que ha abierto el email como valor y el parámetro qm_url con la URL del enlace accedido como valor.

14. <b>Webhook URL for recipient added to blacklist</b>: URL llamada cuando el destinatario se añade a la blacklist. Esta URL recibe el parámetro qm_idsending con el id del email como valor y el parámetro qm_email con la dirección de correo del destinatario que se añade la blacklist como valor.


Una vez completado los datos de la app pulsaremos SAVE y en nuestro listado aparecerá la app creada con el valor de API ID que debemos usar para las llamadas a la API:

<div style="width:100%; text-align:center;">
<img src="/list-apps-2.png" />
</div>
2 changes: 1 addition & 1 deletion es/api-limitations.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#### Debes considerar que la **capa gratuita de la API** tiene las siguientes limitaciones:

- Puedes enviar hasta 10.000 emails por mes. Esto es suficiente para la mayoría de proyectos pequeños y medianos.
- PUedes usar solamente tus propios servidores SMTP o bien servidores SMTP de terceros (Google, Outlook, etc.). No tienes acceso a los servidores SMTP profesionales de Queuemail.dev.
- Puedes usar solamente tus propios servidores SMTP o bien servidores SMTP de terceros (Google, Outlook, etc.). No tienes acceso a los servidores SMTP profesionales de Queuemail.dev.
- Los logs son eliminados a los 30 días.
- Todos los datos son almacenados en nuestra infraestructura. No tienes acceso a configurar tu propia infraestructura (base de datos).
- Procesamiento de cola normal (no tienes prioridad para enviar los emails más rápido).
Expand Down
44 changes: 44 additions & 0 deletions es/api-smtps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
Una vez accedes al <a target="_blank" href="https://queuemail.dev/qmadmin/login">panel de control</a> tienes la posibilidad de gestionar tus servidores SMTP.

Debes definir al menos un servidor SMTP asociado a tu app para poder usar QUEUEMAIL de forma gratuita.

Si usas la opción profesional (no gratuita) de QUEUEMAIL no es necesario que definas ningún servidor SMTP ya que para tus envíos se usarán los servidores profesionales de QUEUEMAIL.

Si no dispones de un servidor SMTP propio puedes [conseguir un servidor SMTP gratis aquí](other-freesmtps.md).

<div style="width:100%; text-align:center;">
<img src="/list-smtps.png" />
</div>

Para crear un servidor SMTP pulsarás el botón NEW SMTP SERVER y aparecerá la siguiente pantalla:

<div style="width:100%; text-align:center;">
<img src="/new-smtp.png">
</div>

Debes establecer como mínimo la app a la que está asociada el servidor SMTP que estás creando, el host (o IP) del servidor SMTP y el puerto usado por el servidor SMTP. El resto de parámetros significa lo siguiente:

1. <b>Use authentication</b>: Si el servidor necesita autentificarse mediante usuario y contraseña para enviar.

2. <b>Use STARTTLS</b>: Si el servidor usa <a href="https://es.wikipedia.org/wiki/STARTTLS">STARTTLS</a>.

3. <b>Use SSLTLS</b>: Si el servidor usa <a href="https://es.wikipedia.org/wiki/Seguridad_de_la_capa_de_transporte">SSLTLS</a>.

4. <b>Priority</b>: Usado para seleccionar el servidor SMTP a utilizar en el envío cuando la app utiliza la estrategia PRIORITY (a menor valor, mayor prioridad).

5. <b>User name</b>: Nombre de usuario utilizado para la autentificación en el servidor.

6. <b>Password</b>: Contraseña utilizada para la autentificación en el servidor.

7. <b>Default sender email address</b>: Si se marca, la dirección de correo del remitente es reemplazada siempre por este valor cuando se usa este servidor SMTP.

8. <b>Default sender name</b>: Si se marca, el nombre del remitente es reemplazado siempre por este valor cuando se usa este servidor SMTP.

Una vez completado los datos del servidor SMTP pulsaremos CHECK AND SAVE y se comprobará si el servidor SMTP funciona correctamente enviando un correo a la dirección de correo de test de la app asociada. Si funciona aparecerá en el listado como habilitado (círculo verde). En otro caso aparecerá como deshabilitado (círculo rojo) y hasta que no lo editemos y grabemos con datos correctos permanecerá deshabilitado.

En cualquier caso en nuestro listado aparecerá el servidor SMTP creado con el valor de API ID que debemos usar para las llamadas a la API:

<div style="width:100%; text-align:center;">
<img src="/list-smtps-2.png" />
</div>

Binary file added list-apps-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added list-apps.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added list-smtps-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added list-smtps.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added new-app.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added new-smtp.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4d14d14

Please sign in to comment.