📖 Documentation — guides, examples with screenshots & release notes
Let this service build your html/text emails in a fluent manner. It doesn't try to reinvent the wheel - it simply extends the given email-template of postmark and backed it for java to use it for many purposes.
You can write your email content fluently and the template builder cares for the correct instyling, conversation to txt version etc...
-
2.7.x frameless + preheader
- 2.7.1: dark-mode readability fixes (attribute/table cells stay readable, button text-color not overridden anymore), table footer-rows now apply their number-format, gallery + side-image collapse correctly on small viewports
- new TbConfiguration.newInstanceFrameless() preset: no box-frame around the content, left aligned - like a personally written email (great for invitations or signature-style emails)
- new content.align config (center/left) to control the placement of the content-block
- new preheader(...) builder option: hidden preview-text shown by email-clients in the inbox-list
- fixed responsive behaviour: email now correctly collapses to full width below 600px viewport
- content.background is not hardcoded to white anymore - custom background-colors work through the whole email
- several template fixes: title-tag condition, h3 font-size config, footer-text escaping, removed stray characters
- upgraded dependencies (pebble 4.1.2, commonmark 0.29.0, junit 5.14.4, lombok 1.18.46)
- note: TbContentConfig all-args constructor got an additional align parameter - use newInstance() + setters instead
- removed obsolete gulp-based template folder (template was maintained directly for years)
-
2.6.x outlook improvements
- 2.6.1: added space-line + extra style-settings to get outlook specials possible, minor html fixes
- 2.6.0: improved link layouting + button margin, allow custom renderer modifications, upgraded dependencies
-
2.5.x jdk-11 baseline
- backported to jdk-11
- switched release process to new sonatype central publishing
-
2.x bases on new postmark templates
- pom artifact group changed to io.rocketbase.mail
- removed jsoup from dependency and changed api in many cases
- cleaned up a lot of code
- separated module in two pices
- common builder
- markdown (with markdown support)
-
1.x bases mailgun templates
- extra dependency on jsoup for auto inlining/transpiling to text
- doc for old api could be found in wiki
- generate html and text mail via one fluent build
- just pebble-template engine as dependency
- support for the following content-types
- Logo in the header
- Text also with HTML support and Alignment configuration
- Image with Alignment configuration and Link options
- Button with custom Styling
- Footer with HTML support and Alignment configuration
- Copyright with dynamic Year and Link options
- table with header, item/price, total
- key value pairs
- interface for tables to provide custom layouts
- extra module to transpile markdown
// generate html/text content
HtmlTextEmail htmlTextEmail = builder
.header()
.logo("https://www.rocketbase.io/img/logo-dark.png").logoHeight(41)
.and()
.text("Welcome, {{name}}!").h1().center().and()
.text("Thanks for trying [Product Name]. We’re thrilled to have you on board. To get the most out of [Product Name], do this primary next step:").and()
.button("Do this Next", "http://localhost").blue().and()
.text("For reference, here's your login information:").and()
.attribute()
.keyValue("Login Page", "{{login_url}}")
.keyValue("Username", "{{username}}")
.and()
.html("If you have any questions, feel free to <a href=\"mailto:{{support_email}}\">email our customer success team</a>. (We're lightning quick at replying.) We also offer <a href=\"{{live_chat_url}}\">live chat</a> during business hours.",
"If you have any questions, feel free to email our customer success team\n" +
"(We're lightning quick at replying.) We also offer live chat during business hours.").and()
.text("Cheers,\n" +
"The [Product Name] Team").and()
.copyright("rocketbase").url("https://www.rocketbase.io").suffix(". All rights reserved.").and()
.footerText("[Company Name, LLC]\n" +
"1234 Street Rd.\n" +
"Suite 1234").and()
.footerImage("https://cdn.rocketbase.io/assets/loading/no-image.jpg").width(100).linkUrl("https://www.rocketbase.io").and()
.build();
// sent email
MimeMessage message = emailSender.createMimeMessage();
MimeMessageHelper helper = new MimeMessageHelper(message,
MimeMessageHelper.MULTIPART_MODE_MIXED_RELATED,
StandardCharsets.UTF_8.name());
helper.setTo(to);
helper.setSubject(subject);
helper.setText(htmlTextEmail.getText(), htmlTextEmail.getHtml());
helper.setFrom(from);
emailSender.send(message);
Welcome, {{name}}!
Thanks for trying [Product Name]. We=E2=80=99re thrilled to have you on boa=
rd. To get the most out of [Product Name], do this primary next step:
Do this Next -> http://localhost
For reference, here's your login information:
Login Page: {{login_url}}
Username: {{username}}
If you have any questions, feel free to email our customer success team
(We're lightning quick at replying.) We also offer live chat during business hours.
Cheers,
The [Product Name] Team
TbConfiguration config = TbConfiguration.newInstance();
config.getContent().setFull(true);
HtmlTextEmail htmlTextEmail = builder
.configuration(config)
.header().text(header).and()
.text("Hi {{name}},").and()
.text("Thanks for using [Product Name]. This is an invoice for your recent purchase").and()
.tableSimple("#,##0.00 '€'")
.headerRow("Description", "Amount")
.itemRow("Special Product\n" +
"Some extra explanations in separate line", BigDecimal.valueOf(1333, 2))
.itemRow("Short service", BigDecimal.valueOf(103, 1))
.footerRow("Total", BigDecimal.valueOf(2363, 2))
.and()
.button("Download PDF", "http://localhost").gray().right().and()
.text("If you have any questions about this receipt, simply reply to this email or reach out to our support team for help.").and()
.copyright("rocketbase").url("https://www.rocketbase.io").suffix(". All rights reserved.").and()
.footerText("[Company Name, LLC]\n" +
"1234 Street Rd.\n" +
"Suite 1234").and()
.build();
TbConfiguration config = TbConfiguration.newInstance();
config.getContent().setWidth(800);
HtmlTextEmail htmlTextEmail = builder
.configuration(config)
.header().text(header).and()
.text("Hi {{name}},").and()
.text("Thanks for using [Product Name]. This is an invoice for your recent purchase").and()
.tableSimpleWithImage("#,##0.00 '€'")
.headerRow("Preview", "Description", "Amount")
.itemRow("https://cdn.shopify.com/s/files/1/0255/1211/6260/products/TCW1142-07052_small.jpg?v=1589200198", "Damen Harbour Tanktop × 1\n" +
"QUARTZ PINK / S", BigDecimal.valueOf(4995, 2))
.itemRow("https://cdn.shopify.com/s/files/1/0255/1211/6260/products/TCM1886-0718_201_fdf0be52-639f-4ea8-9143-6bd75e0821b1_small.jpg?v=1583509609", "Herren ten Classic T-Shirt\n"+
"FOREST GREEN HEATHER / XL", BigDecimal.valueOf(3995, 2))
.itemRow("https://cdn.shopify.com/s/files/1/0255/1211/6260/products/TCM1939-0439_1332_da6f3e7c-e18d-4778-be97-c6c0b482b643_small.jpg?v=1583509671", "Herren Joshua Hanfshorts\n" +
"DARK OCEAN BLUE / XL", BigDecimal.valueOf(6995, 2))
.footerRow("Sum", BigDecimal.valueOf(15985, 2))
.footerRow("Code - PLANT5", BigDecimal.valueOf(-799, 2))
.footerRow("Total incl. Tax\n", BigDecimal.valueOf(15186, 2))
.and()
.button("Download PDF", "http://localhost").gray().right().and()
.text("If you have any questions about this receipt, simply reply to this email or reach out to our support team for help.").and()
.copyright("rocketbase").url("https://www.rocketbase.io").suffix(". All rights reserved.").and()
.footerText("[Company Name, LLC]\n" +
"1234 Street Rd.\n" +
"Suite 1234").and()
.build();
A custom table example could be found in wiki.
docker run --rm -it -p 5555:80 -p 2525:25 rnwood/smtp4dev