Mailtrap Java Client

https://github.com/mailtrap/mailtrap-java
Admin
An official Java SDK for Mailtrap, providing email sending functionality and API integration for...
Tokens:122,917
Snippets:811
Trust Score:8.2
License:MIT
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Bootstrap Mailtrap Java SDK client with sandbox config

Source: https://github.com/mailtrap/mailtrap-java/blob/main/README.md

Shows the full bootstrap logic for the Mailtrap Java SDK, including imports, constants, and client creation. Use it to initialize the client with a token, sandbox mode, and inbox ID before sending test emails.

```java
import io.mailtrap.client.MailtrapClient;
import io.mailtrap.config.MailtrapConfig;
import io.mailtrap.factory.MailtrapClientFactory;
import io.mailtrap.model.request.emails.Address;
import io.mailtrap.model.request.emails.MailtrapMail;

import java.util.List;

public class MailtrapJavaSDKSandboxTest {

    private static final String TOKEN = "<YOUR MAILTRAP TOKEN>";
    private static final String SENDER_EMAIL = "sender@domain.com";
    private static final String RECIPIENT_EMAIL = "recipient@domain.com";
    private static final long INBOX_ID = 1L;

    public static void main(String[] args) {
        final MailtrapConfig config = new MailtrapConfig.Builder()
            .token(TOKEN)
            .sandbox(true)
            .inboxId(INBOX_ID)
            .build();

        final MailtrapClient client = MailtrapClientFactory.createMailtrapClient(config);
```json
{
  
```

--------------------------------

### MailtrapConfig builder with sandbox flag

Source: https://github.com/mailtrap/mailtrap-java/blob/main/README.md

Initializes a MailtrapConfig with the sandbox flag enabled and an inbox ID. Use this to route test emails to the Email Sandbox instead of Production.

```java
        final MailtrapConfig config = new MailtrapConfig.Builder()
    .token("<YOUR MAILTRAP TOKEN>")
    .sandbox(true)
    .inboxId(123456)
    .build();
```

--------------------------------

### Minimal MailtrapClient configuration and usage

Source: https://github.com/mailtrap/mailtrap-java/blob/main/docs/getting-started.md

Configures MailtrapClient with a token and sends an email using the Mailtrap API. Requires JDK 11 or higher and an API token with the respective permissions and access level.

```java
import io.mailtrap.client.MailtrapClient;
import io.mailtrap.config.MailtrapConfig;
import io.mailtrap.factory.MailtrapClientFactory;
import io.mailtrap.model.request.emails.Address;
import io.mailtrap.model.request.emails.MailtrapMail;

import java.util.List;

public class Minimal {

    private static final String TOKEN = "<YOUR-API-TOKEN-HERE>";

    public static void main(String[] args) {
        MailtrapConfig config = new MailtrapConfig(TOKEN);
        MailtrapClient client = MailtrapClientFactory.createMailtrapClient(config);

        MailtrapMail mail = MailtrapMail.builder()
                .from(new Address(
```

--------------------------------

### Minimal usage (Transactional sending)

Source: https://github.com/mailtrap/mailtrap-java/blob/main/README.md

The quickest way to send a single transactional email with only the required parameters.

```java
import io.mailtrap.client.MailtrapClient;
import io.mailtrap.config.MailtrapConfig;

public class Main {
    public static void main(String[] args) {
        MailtrapClient client = new MailtrapClient("YOUR_API_TOKEN");

        client.sendTransactional("from@example.com", "to@example.com", "Subject", "Text body");
    }
}
```

--------------------------------

### Build email with MailtrapMail builder

Source: https://github.com/mailtrap/mailtrap-java/blob/main/README.md

Constructs a MailtrapMail message with category, custom variables, sender/recipient/reply-to addresses, subject, and HTML body. The HTML body includes a text block with inline CSS and a CID-referenced image (welcome.png).

```java
final var mail = MailtrapMail.builder()
                .category("Test message")
                .customVariables(Map.of(
                        "hello", "world",
                        "year", "2024",
                        "anticipated", "true"
                ))
                .from(new Address(SENDER_EMAIL))
                .to(List.of(new Address(RECIPIENT_EMAIL)))
                .replyTo(new Address(REPLY_TO_EMAIL, "Reply To"))
                .subject("Hello from Mailtrap!")
                .html("""
                        <!doctype html>
                        <html>
                          <head>
                            <meta http-equiv="Content-Type" content=
```

--------------------------------

### Gradle Kotlin DSL dependency for mailtrap-java

Source: https://github.com/mailtrap/mailtrap-java/blob/main/README.md

Adds the Mailtrap Java SDK as a Gradle Kotlin DSL dependency.

```kotlin
implementation("io.mailtrap:mailtrap-java:1.8.0")
```

--------------------------------

### Maven dependency for mailtrap-java 1.8.0

Source: https://github.com/mailtrap/mailtrap-java/blob/main/README.md

Add the Mailtrap Java SDK as a Maven dependency. Requires JDK 11+ and a Mailtrap account with a verified domain.

```xml
<dependency>
    <groupId>io.mailtrap</groupId>
    <artifactId>mailtrap-java</artifactId>
    <version>1.8.0</version>
</dependency>
```

--------------------------------

### Gradle Groovy dependency for mailtrap-java

Source: https://github.com/mailtrap/mailtrap-java/blob/main/README.md

Adds the Mailtrap Java SDK as a Gradle Groovy dependency. Use this snippet in the dependencies block of your build.gradle file.

```groovy
implementation 'io.mailtrap:mailtrap-java:1.8.0'
```
Tokens:
Raw