mailslurp-examples - java-jakarta-mail

https://github.com/mailslurp/examples

Table of Contents

java-jakarta-mail/pom.xml

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>jakarta-mail-example</groupId>
  <artifactId>example</artifactId>
  <version>1.0-SNAPSHOT</version>
  <name>example</name>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.source>1.7</maven.compiler.source>
    <maven.compiler.target>1.7</maven.compiler.target>
  </properties>

  <dependencies>
    <dependency>
      <groupId>jakarta.mail</groupId>
      <artifactId>jakarta.mail-api</artifactId>
      <version>2.1.0</version>
    </dependency>
    <dependency>
      <groupId>com.mailslurp</groupId>
      <artifactId>mailslurp-client-java</artifactId>
      <version>15.13.17</version>
    </dependency>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.11</version>
      <scope>test</scope>
    </dependency>
  </dependencies>

  <build>
    <pluginManagement>
      <plugins>
        <plugin>
          <artifactId>maven-clean-plugin</artifactId>
          <version>3.1.0</version>
        </plugin>
        <plugin>
          <artifactId>maven-resources-plugin</artifactId>
          <version>3.0.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-compiler-plugin</artifactId>
          <version>3.8.0</version>
        </plugin>
        <plugin>
          <artifactId>maven-surefire-plugin</artifactId>
          <version>2.22.1</version>
        </plugin>
        <plugin>
          <artifactId>maven-jar-plugin</artifactId>
          <version>3.0.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-install-plugin</artifactId>
          <version>2.5.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-deploy-plugin</artifactId>
          <version>2.8.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-site-plugin</artifactId>
          <version>3.7.1</version>
        </plugin>
        <plugin>
          <artifactId>maven-project-info-reports-plugin</artifactId>
          <version>3.0.0</version>
        </plugin>
      </plugins>
    </pluginManagement>
  </build>
</project>

java-jakarta-mail/README.md

# Java Jakarta Mail email example

Install maven:

```shell
brew install maven
```

Setup a new project:

```shell
mvn archetype:generate -DarchetypeGroupId=org.apache.maven.archetypes -DarchetypeArtifactId=maven-archetype-quickstart -DarchetypeVersion=1.4
```

Add Jakarta mail [dependency](https://mvnrepository.com/artifact/jakarta.mail/jakarta.mail-api) then run:

```shell
mvn dependency:resolve
```

java-jakarta-mail/Makefile

-include ../.env

test:
	API_KEY=$(API_KEY) mvn test

java-jakarta-mail/src/test/java/example/AppTest.java

package example;

import static org.junit.Assert.assertTrue;

import com.mailslurp.apis.ApiUserControllerApi;
import com.mailslurp.apis.InboxControllerApi;
import com.mailslurp.clients.ApiClient;
import com.mailslurp.clients.ApiException;
import com.mailslurp.clients.Configuration;
import com.mailslurp.models.ImapSmtpAccessDetails;
import com.mailslurp.models.InboxDto;
import com.mailslurp.models.InboxPreview;
import com.mailslurp.models.PageInboxProjection;
import jakarta.mail.PasswordAuthentication;
import jakarta.mail.Session;
import org.junit.Before;
import org.junit.Test;

import java.util.Properties;
import java.util.UUID;

/**
 * Unit test to demonstrate email sending using Jakarta Mail
 */
public class AppTest {


    private String host;
    private int port;
    private String username;
    private String password;
    private String emailAddress;
    private UUID inboxId;

    //<gen>jakarta_test_before
    @Before
    public void beforeTest() throws ApiException {
        // configure a mailslurp client using an API_KEY set environment variable
        String apiKey = System.getenv("API_KEY");
        if (apiKey == null || apiKey.length() == 0) {
            throw new RuntimeException("API_KEY environment variable must be set");
        }
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setApiKey(apiKey);
        InboxControllerApi inboxControllerApi = new InboxControllerApi(defaultClient);

        // get an smtp inbox belonging to our mailslurp account
        PageInboxProjection inboxes = inboxControllerApi.getAllInboxes(0, 1, null, null, null, null, null, null, null, InboxDto.InboxTypeEnum.SMTP_INBOX.toString(), null);
        InboxPreview inbox = inboxes.getContent().get(0);
        this.emailAddress = inbox.getEmailAddress();
        this.inboxId = inbox.getId();

        // get smtp access details for our mailslurp smtp mailserver
        ImapSmtpAccessDetails imapSmtpAccess = inboxControllerApi.getImapSmtpAccess(null);
        this.host = imapSmtpAccess.getSmtpServerHost();
        this.port = imapSmtpAccess.getSmtpServerPort();
        this.username = imapSmtpAccess.getSmtpUsername();
        this.password = imapSmtpAccess.getSmtpPassword();
    }
    //</gen>

    @Test
    public void canSendAnEmailWithJakarta() {
        //<gen>jakarta_test_configure
        // configure smtp mailserver properties
        Properties props = new Properties();
        props.put("mail.smtp.auth", "true");
        props.put("mail.smtp.starttls.enable", "false");
        props.put("mail.smtp.host", host);
        props.put("mail.smtp.port", port);
        //</gen>

        //<gen>jakarta_test_session
        // create an authentication session
        Session session = Session.getInstance(props,
                new jakarta.mail.Authenticator() {
                    protected PasswordAuthentication getPasswordAuthentication() {
                        return new PasswordAuthentication(username, password);
                    }
                });
        //</gen>
    }
}