Programación de Servicios y Procesos
descarga PDFabre PDF
PSP Logo

5.1 Correo

Logo IES Doctor Balmis

Apuntes de PSP creados por Vicente Martínez bajo licencia CC BY-NC-SA 4.0

5.1 Correo

5.1.1 Jakarta Mail

Al buscar en Internet tutoriales sobre el envío de correos electrónicos usando Java, existe una alta probabilidad de que cada uno mencione algo llamado Jakarta Mail o Java Mail.

Durante mucho tiempo, Java Enterprise Edition (comúnmente conocido como Java EE), ha sido la plataforma de facto para desarrollar aplicaciones de misión crítica.

Recientemente, con el fin de impulsar la creación de aplicaciones nativas de la nube, varios proveedores de software prominentes se unieron para transferir tecnologías Java EE a la Fundación Eclipse, que es una organización sin fines de lucro encargada de administrar las actividades de la comunidad de software de código abierto Eclipse.

En consecuencia, Java EE ha sido renombrado a Jakarta EE.

A pesar del cambio de nombre, todas las clases principales y definiciones de propiedades siguen siendo las mismas tanto para Jakarta Mail como para JavaMail.

Jakarta vs Java Mail

Para evitar confusiones, es importante tener en cuenta que JavaMail es solo el nombre anterior de Jakarta Mail y los dos representan el mismo software.

Entonces, Jakarta Mail, o JavaMail como a algunos todavía les gusta llamarlo, es una API para enviar y recibir correos electrónicos a través de SMTP, POP3, así como IMAP y es la opción más popular que también admite la autenticación TLS y SSL. Es independiente de la plataforma, independiente del protocolo e integrado en la plataforma Jakarta EE.

También puede encontrar Jakarta Mail como un paquete opcional para su uso con la plataforma Java SE.

Uso de la librería

JakartaMail APIAbrir en una ventana nueva es la especificación de la API de correo de Jakarta. La implementación de referencia de esta especificación se puede encontrar en el repositorio de GitHub Jakarta Mail SpecificationAbrir en una ventana nueva.

JavaMail API

Como su nombre indica, JavaMail API es una API, no una implementación. Por lo tanto, no puede usarlo directamente en su proyecto. En cambio, debe usar una implementación de la API de correo de Jakarta, como la implementación de referencia de la especificación de la API de correo de Jakarta.

También puede encontrar el archivo jakarta.mail-api-X.Y.Z.jar en el repositorio de Maven y agregarlo con dependencias Maven:

    <dependencies>
        <dependency>
            <groupId>org.eclipse.angus</groupId>
            <artifactId>angus-mail</artifactId>
            <version>2.0.2</version>
            <type>jar</type>
        </dependency>
        <dependency>
            <groupId>jakarta.mail</groupId>
            <artifactId>jakarta.mail-api</artifactId>
            <version>2.1.2</version>
            <type>jar</type>
        </dependency>
    </dependencies>

Implementaciones de Jakarta Mail

En el ejemplo anterior hemos usado la implementación de Jakarta AngusMail, pero se pueden usar otras como la propia de Oracle, simplemente cambiando la dependencia.

        <dependency>
            <groupId>com.sun.mail</groupId>
            <artifactId>jakarta.mail</artifactId>
            <version>2.0.1</version>
        </dependency>

Al ser una implementación del API propuesta por Jakarta, el código debería funcionar sin cambios.

5.1.2 Clases principales de la API Jakarta Mail

La API de correo de Jakarta tiene una amplia gama de clases e interfaces que se pueden usar para enviar, leer y realizar otras acciones con mensajes de correo electrónico, al igual que en un sistema de correo típico.

Aunque hay varios paquetes en el Proyecto de Correo de Jakarta, dos de los más utilizados son jakarta.mail y jakarta.mail.internet.

El paquete jakarta.mail proporciona clases que modelan un sistema de correo y el paquete jakarta.mail.internet proporciona clases que se centran en los sistemas de correo de Internet.

A continuación tenemos una descripción de las clases principales de cada uno de los paquetes:

jakarta.mail.Session

La clase Session, que no tiene subclases, es la clase de nivel superior de la API de correo de Jakarta. Es un objeto multiproceso que actúa como fábrica de conexiones para la API de correo de Jakarta. además de recopilar las propiedades y los valores predeterminados de la API de correo, es responsable de los ajustes de configuración y la autenticación.

Para obtener el objeto Session, puede llamar a cualquiera de los dos métodos siguientes:

  • getDefaultInstance(), que devuelve la sesión predeterminada
  • getInstance(), que devuelve una nueva sesión

jakarta.mail.Message

La clase Message es una clase abstracta que modela un mensaje de correo electrónico; Sus subclases soportan las implementaciones reales. Por lo general, su subclase MimeMessage (jakarta.mail.internet.MimeMessage) se utiliza para preparar los detalles del mensaje de correo electrónico que se enviará. Un MimeMessage es un mensaje de correo electrónico que utiliza el estilo de formato MIME (Multipurpose Internet Mail Extension) definido en el RFC822.

Estos son algunos de los métodos más utilizados de la clase MimeMessage:

MétodoDescripción
setFrom(Address addresses)Se utiliza para establecer el campo de encabezado "De".
setRecipients(Message.RecipientType type, String addresses)Se utiliza para establecer el tipo de destinatario indicado en las direcciones proporcionadas. Los posibles tipos de direcciones definidos son "Para" (Message.RecipientType.TO), "CC" (Message.RecipientType.CC) y "CCO" (Message.RecipientType.BCC).
setSubject(String subject)Se utiliza para establecer el campo de encabezado del asunto del correo electrónico.
setText(String text)Se utiliza para establecer la cadena proporcionada como contenido del correo electrónico, utilizando el tipo MIME de "texto / sin formato".
setContent(Object message, String contentType)Se utiliza para establecer el contenido del correo electrónico y se puede utilizar con un tipo MIME que no sea "text/html".

jakarta.mail.Address

La clase Address es una clase abstracta que modela las direcciones (direcciones To y From) en un mensaje de correo electrónico; Sus subclases soportan las implementaciones reales. Por lo general, su subclase InternetAddress, que denota una dirección de correo electrónico de Internet, es la que mas se usa.

jakarta.mail.Authenticator

La clase Authenticator es una clase abstracta que se utiliza para obtener autenticación para acceder a los recursos del servidor de correo, a menudo requiriendo la información del usuario. Por lo general, su subclase PasswordAuthentication es la que mas se usa.

jakarta.mail.Transport

La clase Transport es una clase abstracta que utiliza el protocolo SMTP para enviar y transportar mensajes de correo electrónico.

5.1.3 Enviar correos electrónicos básicos en Jakarta Mail

Básicamente, estos son los pasos para enviar un email utilizando la API de correo de Jakarta:

  1. Configurar detalles del servidor SMTP utilizando un objeto Java Properties. Puede obtener detalles del servidor SMTP de su proveedor de servicios de correo electrónico.
  2. Crear un objeto Session llamando al método getInstance(). Luego, pasar el nombre de usuario y contraseña de la cuenta a PasswordAuthentication. Al crear el objeto de sesión, siempre debe registrar el Authenticator con la sesión.
  3. Una vez creado el objeto Session, el siguiente paso es crear el email que se enviará. Para ello, empezaremos pasando el objeto de sesión creado al constructor de clase MimeMessage.
  4. A continuación, después de crear el objeto de mensaje, establecer los campos De, Para y Asunto del email.
  5. Utilizar el método setText() para establecer el contenido del mensaje de correo electrónico.
  6. Utilizar el objeto Transport para enviar el correo.
  7. Agregue excepciones para recuperar los detalles de cualquier posible error al enviar el mensaje.

Preparación de la sesión

El primer paso es obtener el objeto de sesión de correo. La clase Session es una clase singleton. Por lo tanto, no se puede crear directamente una instancia de la misma. Debemos llamar a uno de los métodos estáticos sobrecargados, generalmente getInstance().

Archivos/Objetos Properties

Un archivo de propiedades es un archivo de texto que contiene pares clave-valor para los valores de configuración de un proyecto.

Se pueden crear sobre la marcha como en los siguientes ejemplos, pero también se puede leer desde un archivo en el proyecto (esta es la forma preferida).

Aquí puedes encontrar algunos enlaces para echar un vistazo a cómo usar y acceder a estos archivos

http://www.instanceofjava.com/2018/01/how-to-read-values-from-properties-file.html

En la imagen anterior puedes ver dónde colocar el archivo de propiedades en un proyecto 'Maven'.

// Prepare SMTP configuration into a Property object
final Properties prop = new Properties();
prop.put("mail.smtp.username", "usuario@gmail.com");
prop.put("mail.smtp.password", "passwordEmail");
prop.put("mail.smtp.host", "smtp.gmail.com");
prop.put("mail.smtp.port", "587");
prop.put("mail.smtp.auth", "true");
prop.put("mail.smtp.starttls.enable", "true"); // TLS

// Create the Session with the user credentials
Session mailSession = Session.getInstance(prop, new jakarta.mail.Authenticator() {
    @Override
    protected PasswordAuthentication getPasswordAuthentication() {
        return new PasswordAuthentication(prop.getProperty("mail.smtp.username"), 
                    prop.getProperty("mail.smtp.password"));
    }
});

En el código anterior, acabamos de crear el objeto Session con propiedades y el objeto Authenticator.

Las propiedades son las siguientes.

  • mail.smtp.username – Nombre de usuario para acceder al servidor SMTP
  • mail.smtp.password – Contraseña de acceso al servidor SMTP
  • mail.smtp.host – Host del servidor SMTP
  • mail.smtp.port – Puerto
  • mail.smtp.auth – Se requiere autenticación.
  • mail.smtp.starttls.enable – TLS habilitado o no.

El Authenticator es una clase abstracta. Su objeto se crea proporcionando una implementación anónima del método getPasswordAuthentication(). La clase PasswordAuthentication se utiliza como marcador para almacenar credenciales de usuario.

Este es un código de ejemplo para leer las propiedades de un archivo en el proyecto.

    private void loadSMTPConfiguration() {
        try ( InputStream input = this.getClass().getResourceAsStream("/" + propertiesFile)) {

            smtpConfiguration = new Properties();
            // load a properties file
            smtpConfiguration.load(input);

            // get the property value and print it out
            smtpConfiguration.forEach((key, value) -> System.out.println("Key : " + key + ", Value : " + value));

        } catch (IOException ex) {
            System.err.println("Cant open properties file: " + ex.getLocalizedMessage());
            ex.printStackTrace();
        }
    }

El contenido del archivo de propiedades podría ser así

# Data to send emails from a GMAIL account
mail.from=cuenta@iesdoctorbalmis.com ó cuenta@gmail.com
mail.username=cuenta@iesdoctorbalmis.com
mail.password=***contraseña de la cuenta habilitando apps poco seguras o contraseña de app con 2FA***

mail.smtp.host=smtp.gmail.com
mail.smtp.port=587
mail.smtp.auth=true
mail.smtp.starttls.enable=true

Composición del mensaje (texto sin formato)

A continuación, redactaremos el mensaje de correo electrónico. La clase jakarta.mail.Message representa un mensaje en Java mail API. Dado que es una clase abstracta, usaremos su clase de implementación concreta jakarta.mail.internet.MimeMessage. Java Mail API permite enviar correo en texto plano o en contenido HTML. Comencemos enviando un mensaje de texto sin formato.

// Prepare the MimeMessage
Message message = new MimeMessage(mailSession);
// Set From and subject email properties
message.setFrom(new InternetAddress("no-reply@gmail.com"));
message.setSubject("Sending Mail with pure Java Mail API ");

// Set to, cc & bcc recipients        
InternetAddress[] toEmailAddresses = 
        InternetAddress.parse("user1@gmail.com, user2@gmail.com");
InternetAddress[] ccEmailAddresses = 
        InternetAddress.parse("user21@gmail.com, user22@gmail.com");
InternetAddress[] bccEmailAddresses = 
        InternetAddress.parse("user31@gmail.com");
            
message.setRecipients(Message.RecipientType.TO,toEmailAddresses);
message.setRecipients(Message.RecipientType.CC,ccEmailAddresses);
message.setRecipients(Message.RecipientType.BCC,bccEmailAddresses);

/* Mail body with plain Text */
message.setText("Hello User," 
        + "\n\n If you read this, means mail sent with Java Mail API is successful");







 














Para enviar un correo electrónico en texto sin formato, simplemente pasamos el texto en el método message.setText().

Enviar mensaje

Hasta ahora, hemos creado una sesión y redactado el mensaje. Ahora es el momento de enviar el mensaje a los destinatarios. Usaremos la clase jakarta.mail.Transport para hacerlo. La clase proporciona métodos send() sobrecargados.

    // Send the configured message in the session
    Transport.send(message);

Emails temporales

YopMailAbrir en una ventana nueva es un servicio de correo electrónico temporal que se puede utilizar para recibir correos electrónicos de forma anónima. No se requiere registro para usar el servicio. Puede usar cualquier dirección de correo electrónico de su elección para recibir correos electrónicos. El servicio es gratuito y se puede utilizar para recibir correos electrónicos de forma anónima. El servicio es gratuito y se puede utilizar para recibir correos electrónicos de forma anónima.

5.1.4 Enviar mensajes HTML

En términos de usabilidad, el contenido HTML es muy superior al texto sin formato. Por lo tanto, la mayoría de las veces enviamos emails en formato HTML. Java Mail API admite el envío de correos electrónicos en formato HTML. Para enviar un correo electrónico con contenido HTML, debemos reemplazar el método message.setText() con el siguiente código.

...
message.setContent("Just discovered that Jakarta Mail is fun and easy to use", 
"text/html");
...

usaremos el método setContent() para establecer el contenido y especificar "text/html" en el segundo argumento, lo que indica que el mensaje tiene formato HTML.

5.1.5 Enviar correo electrónico con archivos adjuntos

Además de los pasos mencionados anteriormente, estos son los diferentes pasos involucrados en el uso de la API de correo de Jakarta para enviar archivos adjuntos de correo electrónico:

  1. Creamos una instancia del objeto MimeMultipart que se utilizará como envoltorio o wrapper para las distintas partes MimeBodyPart. Un MultiPart actúa como un contenedor que guarda varias partes individuales, y viene con métodos para obtener y configurar sus diversas subpartes.
  2. Luego, establecemos la primera parte del objeto Multipart pasándole el mensaje real.
  3. A continuación, establecemos la segunda y las siguientes parte del objeto Multipart agregando los datos adjuntos.
  4. Incluimos el objeto Multipart en el mensaje a enviar.
  5. Enviamos el mensaje

Estructura del mensaje MIME Multipart

 // create an instance of multipart object
Multipart multipart = new MimeMultipart();

// create the 1st message body part
MimeBodyPart messageBodyPart = new MimeBodyPart();
// Add a plain message (HTML can also be added with setContent)
messageBodyPart.setText("Please find the attachment sent using Jakarta Mail");
// Add the BodyPart to the Multipart object
multipart.addBodyPart(messageBodyPart);            

// 2nd. bodyPart with an attached file
messageBodyPart = new MimeBodyPart();
String filename = "C:/temp/file1.pdf";
messageBodyPart.attachFile(filename);
// Add the BodyPart to the Multipart object
multipart.addBodyPart(messageBodyPart);            

// Add the multipart object to the message
message.setContent(multipart);

// Send the message with multipart MIME objects
Transport.send(message);

 


 



 


 



 


 



5.1.6 Enviar correos electrónicos HTML con imágenes

Para agregar una imagen a su correo electrónico HTML en Jakarta Mail, puede elegir cualquiera de las tres opciones comunes:

  • Insertando imágenes CID.
  • Insertando imágenes en línea o codificación Base64.
  • Enlazando imágenes.

Insertando imágenes CID (Content-ID)

Para insertar imágenes CID, debemos crear un mensaje MIME multipart/related usando el siguiente código:

// 1st part of the message. An HTML code with a CID referenced image
Multipart multipart = new MimeMultipart("related");
MimeBodyPart htmlPart = new MimeBodyPart();
//add reference to your image to the HTML body <img src="cid:some-image-cid" alt="img" />
String messageBody = "<p></p><img src=\"cid:my-test-image-cid\" alt=\"embedded img\" /></p>";
htmlPart.setText(messageBody, "utf-8", "html");
// Add the BodyPart to the Multipart object
multipart.addBodyPart(htmlPart);

// 2nd part of the message. The image with special CID header markers
MimeBodyPart imgPart = new MimeBodyPart();
// imageFile is the file containing the image
imgPart.attachFile(imageFile);
// or, if the image is in a byte array in memory, use
// imgPart.setDataHandler(new DataHandler(
//      new ByteArrayDataSource(bytes, "image/whatever")));
imgPart.setContentID("<my-test-image-cid>");
// Add the multipart object to the message
multipart.addBodyPart(imgPart);

// Add the multipart object to the message
message.setContent(multipart);

// Send the message with multipart MIME objects
Transport.send(message);

 


 











 








Insertando imágenes en línea (Base64)

Para la inserción en línea o la codificación Base64, debe incluir los datos de imagen codificados en el cuerpo HTML de forma similar a esta:

<img src="data:image/jpeg;base64,base64-encoded-data-here" />

tamaño del HTML

Cada dígito Base64 representa 6 bits de datos, por lo que el código generado para una imagen real será bastante grande.

Como esto afecta el tamaño total del mensaje HTML, es mejor no usar imágenes grandes en línea.

Para codificar/decodificar una secuencia en Base 64 podemos usar la clase java.util.Base64

byte[] fileContent = new FileInputStream(imageFile).readAllBytes();
String base64EncodedData = Base64.getEncoder().encodeToString(fileContent);

Codificación base64

Base64 es una buena opción para enviar datos binarios a través de protocolos de texto como HTTP, sin pérdida de información.

Esta operación se puede aplicar a cualquier archivo binario. Es útil cuando necesitamos transferir contenido binario en formato JSON, por ejemplo desde la aplicación móvil al endpoint de conexión REST.

Image to Base64 String Conversion - BaeldungAbrir en una ventana nueva

Linked images

Por último, tenemos imágenes vinculadas que son esencialmente imágenes alojadas en algún servidor externo al que luego crea un enlace. Podemos hacerlo usando la etiqueta img en el cuerpo HTML de la siguiente manera.

<img src="/wp-content/uploads/2018/11/blog/-illustration-email-embedding-images.png" alt="img" />

Debug Jakarta Mail

La depuración juega un papel fundamental en las pruebas de envío de correo electrónico.

En Jakarta Mail, es bastante sencillo. Tan solo hay que establecer debug a true en las propiedades de configuración de la sesión:

props.put("mail.debug", "true");

Como resultado, obtendremos una descripción paso a paso de cómo se ejecuta el código. Si aparece algún problema con el envío del mensaje, comprenderemos instantáneamente lo que ha sucedido y en qué paso.

5.1.7 Lectura de emails con Jakarta Mail

El API de correo de Jakarta también proporciona soporte para leer correos electrónicos. Para leer correos electrónicos, debe usar la clase javax.mail.Store. La clase Store es una clase abstracta que modela un almacén de mensajes y su protocolo de acceso, y es una subclase de las clases POP3Store e IMAPStore.

Leer correos electrónicos almacenados en un servidor IMAP consta de los siguientes pasos:

  • Creación de la sesión IMAP (Session), indicando el protocolo, el nombre del host, el puerto, si usa SSL y el servidor de autenticación asociado.
  • Configuración y obtención del almacén (Store).
  • Obtención de la conexión a través del almacén, indicando el identificador de la cuenta y la contraseña.
  • Obtención de la carpeta a leer.
  • Apertura de la carpeta.
  • Obtención de los mensajes
  • Procesamiento de mensajes
  • Cierre de la carpeta y del almacén.
  • Cierre de la sesión y de la conexión
    // Prepare IMAP configuration into a Property object
    final Properties prop = new Properties();
    prop.put("mail.imap.host", "imap.gmail.com");
    prop.put("mail.imap.port", "993");
    prop.put("mail.imap.ssl.enable", "true");
    prop.put("mail.imap.auth", "true");

    // Create the Session with the user credentials
    Session mailSession = Session.getInstance(prop, new jakarta.mail.Authenticator() {
        @Override
        protected PasswordAuthentication getPasswordAuthentication() {
            return new PasswordAuthentication(prop.getProperty("mail.imap.username"), 
                        prop.getProperty("mail.imap.password"));
        }
    });

    // Get the Store object and connect to the current host using the specified username and password.
    Store store = mailSession.getStore("imap");
    store.connect(prop.getProperty("mail.imap.host"), 
            prop.getProperty("mail.imap.username"), 
            prop.getProperty("mail.imap.password"));

    // Get the folder and open it
    Folder folder = store.getFolder("INBOX");
    folder.open(Folder.READ_ONLY);

    // Get the messages
    Message[] messages = folder.getMessages();

    // Process the messages
    for (int i = 0; i < messages.length; i++) {
        Message message = messages[i];
        System.out.println("Message " + (i + 1));
        System.out.println("From: " + message.getFrom()[0]);
        System.out.println("Subject: " + message.getSubject());
        System.out.println("Sent Date: " + message.getSentDate());
        System.out.println("Text: " + message.getContent().toString());
    }

    // Close the folder and store objects
    folder.close(false);
    store.close();
Última actualización:
Editores: Vicente Martínez