Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .envrc
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
export GPG_TTY=$(tty)
export JAVA_TOOL_OPTIONS='-Duser.language=en -Duser.country=US'
export MAILTRAP_ACCOUNT_ID="op://Mailtrap Dev/Mailtrap SDK Dev API Key/account_id"
export MAILTRAP_ORGANIZATION_ID="op://Mailtrap Dev/Mailtrap SDK Dev API Key/organization_id"
export MAILTRAP_API_KEY="op://Mailtrap Dev/Mailtrap SDK Dev API Key/account_api_token"
export MAILTRAP_ORGANIZATION_API_KEY="op://Mailtrap Dev/Mailtrap SDK Dev API Key/organization_api_token"
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the highlevel idea is to have shared configuration across all SDK, load config into env and run examples. Basically, I already have something like that but with custom scripts. Next step would be to figure out how to run examples and that could be good integration test

1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,4 @@ build/

### Mac OS ###
.DS_Store
.idea/
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -332,6 +332,12 @@ You can find the [Mailtrap Java API reference](https://mailtrap.github.io/mailtr
- [Accounts](examples/java/io/mailtrap/examples/general/AccountsExample.java)
- [Permissions](examples/java/io/mailtrap/examples/general/PermissionsExample.java)
- [Billing](examples/java/io/mailtrap/examples/general/BillingExample.java)
- [API Tokens](examples/java/io/mailtrap/examples/general/ApiTokensExample.java)
- [Webhooks](examples/java/io/mailtrap/examples/webhooks/WebhooksExample.java)

### Organizations API

- [Sub-Accounts](examples/java/io/mailtrap/examples/organizations/SubAccountsExample.java)

### Sending API

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,11 @@ public static void main(String[] args) {

System.out.println(createResponse);

final var getResponse = client.contactsApi().contacts()
.getContact(ACCOUNT_ID, EMAIL);

System.out.println(getResponse);

final var updateRequest = new UpdateContactRequest(
new UpdateContact(EMAIL, Map.of("first_name", "Nick"), List.of(LIST_1_ID, LIST_2_ID),
Collections.emptyList(), UNSUBSCRIBED));
Expand Down
48 changes: 48 additions & 0 deletions examples/java/io/mailtrap/examples/general/ApiTokensExample.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
package io.mailtrap.examples.general;

import io.mailtrap.config.MailtrapConfig;
import io.mailtrap.factory.MailtrapClientFactory;
import io.mailtrap.model.AccessLevel;
import io.mailtrap.model.ResourceType;
import io.mailtrap.model.request.apitokens.ApiTokenResource;
import io.mailtrap.model.request.apitokens.CreateApiTokenRequest;

import java.util.List;

public class ApiTokensExample {

private static final String TOKEN = "<YOUR MAILTRAP TOKEN>";
private static final long ACCOUNT_ID = 1L;

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

final var client = MailtrapClientFactory.createMailtrapClient(config);

// The full token value is returned only on creation — store it securely.
final var createRequest = new CreateApiTokenRequest(
"My token",
List.of(new ApiTokenResource(ResourceType.ACCOUNT, ACCOUNT_ID, AccessLevel.VIEWER)));

final var createdToken = client.generalApi().apiTokens()
.createApiToken(ACCOUNT_ID, createRequest);
System.out.println(createdToken);

final var tokenId = createdToken.getId();

final var allTokens = client.generalApi().apiTokens().getAllApiTokens(ACCOUNT_ID);
System.out.println(allTokens);

final var token = client.generalApi().apiTokens().getApiToken(ACCOUNT_ID, tokenId);
System.out.println(token);

// Reset expires the existing token and returns a new one with the same permissions.
// The new token value is only returned here.
final var resetToken = client.generalApi().apiTokens().resetApiToken(ACCOUNT_ID, tokenId);
System.out.println(resetToken);

client.generalApi().apiTokens().deleteApiToken(ACCOUNT_ID, resetToken.getId());
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
package io.mailtrap.examples.organizations;

import io.mailtrap.config.MailtrapConfig;
import io.mailtrap.factory.MailtrapClientFactory;
import io.mailtrap.model.request.subaccounts.CreateSubAccountRequest;
import io.mailtrap.model.request.subaccounts.SubAccountInput;

public class SubAccountsExample {

private static final String TOKEN = "<YOUR MAILTRAP TOKEN>";
private static final long ORGANIZATION_ID = 1L;
private static final String SUB_ACCOUNT_NAME = "Acme Marketing";

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

final var client = MailtrapClientFactory.createMailtrapClient(config);

// Requires sub account management permissions for the organization.
final var allSubAccounts = client.organizationsApi().subAccounts().getSubAccounts(ORGANIZATION_ID);
System.out.println(allSubAccounts);

final var createRequest = new CreateSubAccountRequest(new SubAccountInput(SUB_ACCOUNT_NAME));
final var createdSubAccount = client.organizationsApi().subAccounts()
.createSubAccount(ORGANIZATION_ID, createRequest);
System.out.println(createdSubAccount);
}
}
71 changes: 71 additions & 0 deletions examples/java/io/mailtrap/examples/webhooks/WebhooksExample.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
package io.mailtrap.examples.webhooks;

import io.mailtrap.config.MailtrapConfig;
import io.mailtrap.factory.MailtrapClientFactory;
import io.mailtrap.model.SendingStream;
import io.mailtrap.model.WebhookEventType;
import io.mailtrap.model.WebhookPayloadFormat;
import io.mailtrap.model.WebhookType;
import io.mailtrap.model.request.webhooks.CreateWebhookRequest;
import io.mailtrap.model.request.webhooks.UpdateWebhookRequest;
import io.mailtrap.model.request.webhooks.WebhookInput;

import java.util.List;

public class WebhooksExample {

private static final String TOKEN = "<YOUR MAILTRAP TOKEN>";
private static final long ACCOUNT_ID = 1L;
private static final String WEBHOOK_URL = "https://example.com/webhooks/mailtrap";
private static final String UPDATED_WEBHOOK_URL = "https://example.com/webhooks/mailtrap/v2";

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

final var client = MailtrapClientFactory.createMailtrapClient(config);

final var createRequest = new CreateWebhookRequest(
WebhookInput.builder()
.url(WEBHOOK_URL)
.webhookType(WebhookType.EMAIL_SENDING)
.active(true)
.payloadFormat(WebhookPayloadFormat.JSON)
.sendingStream(SendingStream.TRANSACTIONAL)
.eventTypes(List.of(
WebhookEventType.DELIVERY,
WebhookEventType.BOUNCE,
WebhookEventType.OPEN,
WebhookEventType.CLICK,
WebhookEventType.UNSUBSCRIBE))
.build());

// `signing_secret` is only returned on creation — store it securely.
final var createResponse = client.generalApi().webhooks()
.createWebhook(ACCOUNT_ID, createRequest);
System.out.println(createResponse);

final var webhookId = createResponse.getData().getId();

final var allWebhooks = client.generalApi().webhooks().getAllWebhooks(ACCOUNT_ID);
System.out.println(allWebhooks);

final var webhook = client.generalApi().webhooks().getWebhook(ACCOUNT_ID, webhookId);
System.out.println(webhook);

final var updateRequest = new UpdateWebhookRequest(
WebhookInput.builder()
.url(UPDATED_WEBHOOK_URL)
.active(false)
.eventTypes(List.of(WebhookEventType.DELIVERY, WebhookEventType.BOUNCE))
.build());

final var updateResponse = client.generalApi().webhooks()
.updateWebhook(ACCOUNT_ID, webhookId, updateRequest);
System.out.println(updateResponse);

final var deleteResponse = client.generalApi().webhooks().deleteWebhook(ACCOUNT_ID, webhookId);
System.out.println(deleteResponse);
}
}
56 changes: 56 additions & 0 deletions src/main/java/io/mailtrap/api/apitokens/ApiTokens.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
package io.mailtrap.api.apitokens;

import io.mailtrap.model.request.apitokens.CreateApiTokenRequest;
import io.mailtrap.model.response.apitokens.ApiToken;
import io.mailtrap.model.response.apitokens.ApiTokenWithToken;

import java.util.List;

public interface ApiTokens {

/**
* List all API tokens visible to the current API token.
*
* @param accountId unique account ID
* @return list of API tokens
*/
List<ApiToken> getAllApiTokens(long accountId);

/**
* Create a new API token for the account with the given name and resource permissions.
* The full token value is returned only on creation.
*
* @param accountId unique account ID
* @param request token name and resource permissions
* @return created token, including the full token value
*/
ApiTokenWithToken createApiToken(long accountId, CreateApiTokenRequest request);

/**
* Get a single API token by id.
*
* @param accountId unique account ID
* @param id API token ID
* @return API token
*/
ApiToken getApiToken(long accountId, long id);

/**
* Permanently delete an API token.
*
* @param accountId unique account ID
* @param id API token ID
*/
void deleteApiToken(long accountId, long id);

/**
* Reset an API token. Expires the requested token and creates a new one with the same
* permissions; the new token value is returned only once.
*
* @param accountId unique account ID
* @param id API token ID
* @return new token, including the full token value
*/
ApiTokenWithToken resetApiToken(long accountId, long id);

}
67 changes: 67 additions & 0 deletions src/main/java/io/mailtrap/api/apitokens/ApiTokensImpl.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
package io.mailtrap.api.apitokens;

import io.mailtrap.Constants;
import io.mailtrap.api.apiresource.ApiResource;
import io.mailtrap.config.MailtrapConfig;
import io.mailtrap.http.RequestData;
import io.mailtrap.model.AbstractModel;
import io.mailtrap.model.request.apitokens.CreateApiTokenRequest;
import io.mailtrap.model.response.apitokens.ApiToken;
import io.mailtrap.model.response.apitokens.ApiTokenWithToken;

import java.util.List;

public class ApiTokensImpl extends ApiResource implements ApiTokens {

public ApiTokensImpl(final MailtrapConfig config) {
super(config);
this.apiHost = Constants.GENERAL_HOST;
}

@Override
public List<ApiToken> getAllApiTokens(final long accountId) {
return httpClient.getList(
String.format(apiHost + "/api/accounts/%d/api_tokens", accountId),
new RequestData(),
ApiToken.class
);
}

@Override
public ApiTokenWithToken createApiToken(final long accountId, final CreateApiTokenRequest request) {
return httpClient.post(
String.format(apiHost + "/api/accounts/%d/api_tokens", accountId),
request,
new RequestData(),
ApiTokenWithToken.class
);
}

@Override
public ApiToken getApiToken(final long accountId, final long id) {
return httpClient.get(
String.format(apiHost + "/api/accounts/%d/api_tokens/%d", accountId, id),
new RequestData(),
ApiToken.class
);
}

@Override
public void deleteApiToken(final long accountId, final long id) {
httpClient.delete(
String.format(apiHost + "/api/accounts/%d/api_tokens/%d", accountId, id),
new RequestData(),
Void.class
);
}

@Override
public ApiTokenWithToken resetApiToken(final long accountId, final long id) {
return httpClient.post(
String.format(apiHost + "/api/accounts/%d/api_tokens/%d/reset", accountId, id),
(AbstractModel) null,
new RequestData(),
ApiTokenWithToken.class
);
}
}
10 changes: 10 additions & 0 deletions src/main/java/io/mailtrap/api/contacts/Contacts.java
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import io.mailtrap.model.request.contacts.CreateContactRequest;
import io.mailtrap.model.request.contacts.UpdateContactRequest;
import io.mailtrap.model.response.contacts.CreateContactResponse;
import io.mailtrap.model.response.contacts.GetContactResponse;
import io.mailtrap.model.response.contacts.UpdateContactResponse;

public interface Contacts {
Expand All @@ -16,6 +17,15 @@ public interface Contacts {
*/
CreateContactResponse createContact(long accountId, CreateContactRequest request);

/**
* Get contact using id or email (URL encoded)
*
* @param accountId unique account ID
* @param idOrEmail contact ID or Email
* @return contact details
*/
GetContactResponse getContact(long accountId, String idOrEmail);

/**
* Delete contact using id or email (URL encoded)
*
Expand Down
11 changes: 11 additions & 0 deletions src/main/java/io/mailtrap/api/contacts/ContactsImpl.java
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
import io.mailtrap.model.request.contacts.CreateContactRequest;
import io.mailtrap.model.request.contacts.UpdateContactRequest;
import io.mailtrap.model.response.contacts.CreateContactResponse;
import io.mailtrap.model.response.contacts.GetContactResponse;
import io.mailtrap.model.response.contacts.UpdateContactResponse;

import java.net.URLEncoder;
Expand All @@ -29,6 +30,16 @@ public CreateContactResponse createContact(final long accountId, final CreateCon
);
}

@Override
public GetContactResponse getContact(final long accountId, final String idOrEmail) {
return httpClient.get(
String.format(apiHost + "/api/accounts/%d/contacts/%s", accountId,
URLEncoder.encode(idOrEmail, StandardCharsets.UTF_8)),
new RequestData(),
GetContactResponse.class
);
}

@Override
public void deleteContact(final long accountId, final String idOrEmail) {
httpClient.delete(
Expand Down
29 changes: 29 additions & 0 deletions src/main/java/io/mailtrap/api/subaccounts/SubAccounts.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
package io.mailtrap.api.subaccounts;

import io.mailtrap.model.request.subaccounts.CreateSubAccountRequest;
import io.mailtrap.model.response.subaccounts.SubAccount;

import java.util.List;

public interface SubAccounts {

/**
* Get a list of sub accounts for the specified organization.
* Requires sub account management permissions for the organization.
*
* @param organizationId unique organization ID
* @return list of sub accounts
*/
List<SubAccount> getSubAccounts(long organizationId);

/**
* Create a new sub account under the specified organization.
* Requires sub account management permissions for the organization.
*
* @param organizationId unique organization ID
* @param request sub account data
* @return created sub account
*/
SubAccount createSubAccount(long organizationId, CreateSubAccountRequest request);

}
Loading
Loading