Interface EmailApi

All Known Implementing Classes:
EmailController

public interface EmailApi
Interfaz de la API encargada de definir los endpoints para el envío de correos electrónicos.
  • Method Summary

    Modifier and Type
    Method
    Description
    jakarta.ws.rs.core.Response
    emailPost(String emailAddress, String message)
    Endpoint POST: Procesa la solicitud para enviar un correo electrónico a un destinatario.
  • Method Details

    • emailPost

      @POST @Produces({"text/plain","application/json","text/json"}) jakarta.ws.rs.core.Response emailPost(@QueryParam("emailAddress") String emailAddress, @QueryParam("message") String message)
      Endpoint POST: Procesa la solicitud para enviar un correo electrónico a un destinatario.

      Precondición: emailAddress y message no son nulos.

      Postcondición: Crea un objeto de respuesta indicando que la operación fue un éxito y devuelve una respuesta HTTP 201 (Created) lista para ser enviada al cliente.

      Parameters:
      emailAddress - la dirección de correo del destinatario.
      message - el contenido del correo a enviar.
      Returns:
      la respuesta HTTP empaquetada con el estado de la operación.