|
| 1 | +package io.mailtrap.examples.emailcampaigns; |
| 2 | + |
| 3 | +import io.mailtrap.config.MailtrapConfig; |
| 4 | +import io.mailtrap.factory.MailtrapClientFactory; |
| 5 | +import io.mailtrap.model.DeliveryMode; |
| 6 | +import io.mailtrap.model.request.emailcampaigns.CreateEmailCampaign; |
| 7 | +import io.mailtrap.model.request.emailcampaigns.CreateEmailCampaignRequest; |
| 8 | +import io.mailtrap.model.request.emailcampaigns.TemplateAttributes; |
| 9 | +import io.mailtrap.model.request.emailcampaigns.UpdateEmailCampaign; |
| 10 | +import io.mailtrap.model.request.emailcampaigns.UpdateEmailCampaignRequest; |
| 11 | +import io.mailtrap.model.response.emailcampaigns.DeliveryOptions; |
| 12 | +import io.mailtrap.model.response.emailcampaigns.ReplyTo; |
| 13 | + |
| 14 | +import java.time.OffsetDateTime; |
| 15 | +import java.time.ZoneOffset; |
| 16 | + |
| 17 | +public class EmailCampaignsExample { |
| 18 | + |
| 19 | + private static final String TOKEN = "<YOUR MAILTRAP TOKEN>"; |
| 20 | + // ID of a verified sending domain on the account. |
| 21 | + private static final long MAILSEND_DOMAIN_ID = 123L; |
| 22 | + |
| 23 | + public static void main(String[] args) { |
| 24 | + final var config = new MailtrapConfig.Builder() |
| 25 | + .token(TOKEN) |
| 26 | + .build(); |
| 27 | + |
| 28 | + final var client = MailtrapClientFactory.createMailtrapClient(config); |
| 29 | + |
| 30 | + // The campaign endpoints are token-scoped: the account is resolved from the API token. |
| 31 | + final var campaigns = client.emailCampaignsApi().emailCampaigns(); |
| 32 | + |
| 33 | + // List campaigns (newest first). `search` filters by name; `token` is the page number. |
| 34 | + final var page = campaigns.getEmailCampaigns(50, "Spring", 1); |
| 35 | + System.out.println(page); |
| 36 | + |
| 37 | + // Create a campaign — it starts in the `draft` state. |
| 38 | + final var createRequest = new CreateEmailCampaignRequest( |
| 39 | + CreateEmailCampaign.builder() |
| 40 | + .name("Spring Sale") |
| 41 | + .mailsendDomainId(MAILSEND_DOMAIN_ID) |
| 42 | + .fromDisplayName("Acme Marketing") |
| 43 | + .fromLocalPart("news") |
| 44 | + .replyTo(ReplyTo.builder() |
| 45 | + .displayName("Acme Support") |
| 46 | + .localPart("support") |
| 47 | + .domain("acme.com") |
| 48 | + .build()) |
| 49 | + .templateAttributes(TemplateAttributes.builder() |
| 50 | + .subject("Spring is here — 30% off") |
| 51 | + .build()) |
| 52 | + .build()); |
| 53 | + |
| 54 | + final var created = campaigns.createEmailCampaign(createRequest); |
| 55 | + System.out.println(created); |
| 56 | + |
| 57 | + final var campaignId = created.getId(); |
| 58 | + |
| 59 | + // Retrieve a single campaign. |
| 60 | + final var fetched = campaigns.getEmailCampaign(campaignId); |
| 61 | + System.out.println(fetched); |
| 62 | + |
| 63 | + // Update is a PATCH — only the provided fields change. Schedule it for later and pass the |
| 64 | + // existing template id to update the subject in place. |
| 65 | + final var updateRequest = new UpdateEmailCampaignRequest( |
| 66 | + UpdateEmailCampaign.builder() |
| 67 | + .name("Spring Sale (updated)") |
| 68 | + .deliveryMode(DeliveryMode.SCHEDULED) |
| 69 | + .scheduledFor(OffsetDateTime.of(2026, 6, 1, 9, 0, 0, 0, ZoneOffset.UTC)) |
| 70 | + .deliveryOptions(DeliveryOptions.builder().emailsPerHour(1000).build()) |
| 71 | + .templateAttributes(TemplateAttributes.builder() |
| 72 | + .id(fetched.getTemplate().getId()) |
| 73 | + .subject("New subject") |
| 74 | + .build()) |
| 75 | + .build()); |
| 76 | + |
| 77 | + final var updated = campaigns.updateEmailCampaign(campaignId, updateRequest); |
| 78 | + System.out.println(updated); |
| 79 | + |
| 80 | + // Aggregated performance statistics (all zeros until the campaign has been started). |
| 81 | + final var stats = campaigns.getEmailCampaignStats(campaignId); |
| 82 | + System.out.println(stats); |
| 83 | + |
| 84 | + // Delete returns the deleted campaign object. |
| 85 | + final var deleted = campaigns.deleteEmailCampaign(campaignId); |
| 86 | + System.out.println(deleted); |
| 87 | + } |
| 88 | +} |
0 commit comments