README

Ship faster by treating email as code 🚀

Website • Get Your API Key • Twitter

Templateless lets you generate and send transactional emails quickly and easily so you can focus on building your product.

It's perfect for SaaS, web apps, mobile apps, scripts and anywhere you have to send email programmatically.

✨ Features

👋 Anti drag-and-drop by design — emails are a part of your code
✅ Components as code — function calls turn into email HTML components
💻 SDK for any language — use your favorite programming language
🔍 Meticulously tested — let us worry about email client compatibility
💌 Use your favorite ESP — Amazon SES, SendGrid, Mailgun + more
💪 Email infrastructure — rate-limiting, retries, scheduling + more
⚡ Batch sending — send 1 email or 1,000 with one API call

🚀 Getting started

Require this package, with Composer, in the root directory of your project.

composer require templateless/templateless

Then you can import the class into your application:

use Templateless\Templateless;

🔑 Get Your API Key

You'll need an API key for the example below ⬇️

3,000 emails per month
All popular email provider integrations
Start sending right away

👩‍💻 Quick example

This is all it takes to send a signup confirmation email:

<?php

require 'vendor/autoload.php';

use Templateless\Content;
use Templateless\Email;
use Templateless\EmailAddress;
use Templateless\Templateless;

try {
    $content = Content::builder()
        ->text("Hi, please **confirm your email**:")
        ->button("Confirm Email", "https://your-company.com/signup/confirm?token=XYZ")
        ->build();

    $email = Email::builder()
        ->to(EmailAddress::new("<YOUR_CUSTOMERS_EMAIL_ADDRESS>"))
        ->subject("Confirm your signup 👋")
        ->content($content)
        ->build();

    Templateless::new("<YOUR_API_KEY>")
        ->send($email);
} catch (\Exception $e) {
    echo $e;
}

There are more examples in the examples folder ✨

Note

🚧 The SDK is not stable yet. This API might change as more features are added. Please watch the repo for the changes in the CHANGELOG.

🏗 Debugging

You can generate test API keys by activating the Test Mode in your dashboard. By using these keys, you'll be able to view your fully rendered emails without actually sending them.

When you use a test API key in your SDK, the following output will appear in your logs when you try to send an email:

Templateless [TEST MODE]: Emailed user@example.com, preview: https://tmpl.sh/ATMxHLX4r9aE

The preview link will display the email, but you must be logged in to Templateless to view it.

🔳 Components

Emails are crafted programmatically by making function calls. There's no dealing with HTML or drag-and-drop builders.

All of the following components can be mixed and matched to create dynamic emails:

Text / Markdown

Text component allow you to insert a paragraph. Each paragraph supports basic markdown:

Bold text: **bold text**
Italic text: _italic text_
Link: [link text](https://example.com)
Also a link: <https://example.com>
Headers (h1-h6):
- # Big Header
- ###### Small Header
Unordered list:
```
- item one
- item two
- item three
```
Ordered list:
```
1. item one
1. item two
1. item three
```

Content::builder()
  ->text("## Thank you for signing up")
  ->text("Please **verify your email** by [clicking here](https://example.com/confirm?token=XYZ)")
  ->build();

Link

Link component adds an anchor tag. This is the same as a text component with the link written in markdown:

Content::builder()
  ->link("Confirm Email", "https://example.com/confirm?token=XYZ")
  ->build();

Button

Button can also be used as a call to action. Button color is set via your dashboard's app color.

Content::builder()
  ->button("Confirm Email", "https://example.com/confirm?token=XYZ")
  ->build();

Image

Image component will link to an image within your email. Keep in mind that a lot of email clients will prevent images from being loaded automatically for privacy reasons.

Content::builder()
  ->image(
    "https://placekitten.com/300/200",  // where the image is hosted
    "https://example.com",              // [optional] link url, if you want it to be clickable
    300,                                // [optional] width
    200,                                // [optional] height
    "Alt text",                         // [optional] alternate text
  )
  ->build();

Only the src parameter is required; everything else is optional.

If you have "Image Optimization" turned on:

Your images will be cached and distributed by our CDN for faster loading. The cache does not expire. If you'd like to re-cache, simply append a query parameter to the end of your image url.
Images will be converted into formats that are widely supported by email clients. The following image formats will be processed automatically:
- Jpeg
- Png
- Gif
- WebP
- Tiff
- Ico
- Bmp
- Svg
Maximum image size is 5MB for free accounts and 20MB for paid accounts.
You can specify width and/or height if you'd like (they are optional). Keep in mind that images will be scaled down to fit within the email theme, if they're too large.

One-Time Password

OTP component is designed for showing temporary passwords and reset codes.

Content::builder()
  ->text("Here's your **temporary login code**:")
  ->otp("XY78-2BT0-YFNB-ALW9")
  ->build();

Social Icons

You can easily add social icons with links by simply specifying the username. Usually, this component is placed in the footer of the email.

These are all the supported platforms:

Content::builder()
  ->socials([
    new SocialItem(Service::WEBSITE, "https://example.com"),
    new SocialItem(Service::EMAIL, "username@example.com"),
    new SocialItem(Service::PHONE, "123-456-7890"), // `tel:` link
    new SocialItem(Service::FACEBOOK, "Username"),
    new SocialItem(Service::YOUTUBE, "ChannelID"),
    new SocialItem(Service::TWITTER, "Username"),
    new SocialItem(Service::X, "Username"),
    new SocialItem(Service::GITHUB, "Username"),
    new SocialItem(Service::INSTAGRAM, "Username"),
    new SocialItem(Service::LINKEDIN, "Username"),
    new SocialItem(Service::SLACK, "Org"),
    new SocialItem(Service::DISCORD, "Username"),
    new SocialItem(Service::TIKTOK, "Username"),
    new SocialItem(Service::SNAPCHAT, "Username"),
    new SocialItem(Service::THREADS, "Username"),
    new SocialItem(Service::TELEGRAM, "Username"),
    new SocialItem(Service::MASTODON, "@Username@example.com"),
    new SocialItem(Service::RSS, "https://example.com/blog"),
  ])
  ->build();

View in Browser

If you'd like your recipients to be able to read the email in a browser, you can add the "view in browser" component that will automatically generate a link. Usually, this is placed in the header or footer of the email.

You can optionally provide the text for the link. If none is provided, default is used: "View in browser"

Anyone who knows the link will be able to see the email.

Content::builder()
  ->view_in_browser(Some("Read Email in Browser".to_string()))
  ->build();

Store Badges

Link to your mobile apps via store badges:

Content::builder()
  ->store_badges([
    new StoreBadgeItem(StoreBadge::APP_STORE, "https://apps.apple.com/us/app/example/id1234567890"),
    new StoreBadgeItem(StoreBadge::GOOGLE_PLAY, "https://play.google.com/store/apps/details?id=com.example"),
    new StoreBadgeItem(StoreBadge::MICROSOFT_STORE, "https://apps.microsoft.com/detail/example"),
  ])
  ->build();

QR Code

You can also generate QR codes on the fly. They will be shown as images inside the email.

Here are all the supported data types:

// url
Content::builder()
  ->qr_code("https://example.com")
  ->build();

// email
Content::builder()
  ->component(QrCode::email("user@example.com"))
  ->build();

// phone
Content::builder()
  ->component(QrCode::phone("123-456-7890"))
  ->build();

// sms / text message
Content::builder()
  ->component(QrCode::sms("123-456-7890"))
  ->build();

// geo coordinates
Content::builder()
  ->component(QrCode::coordinates(37.773972, -122.431297))
  ->build();

// crypto address (for now only Bitcoin and Ethereum are supported)
Content::builder()
  ->component(QrCode::cryptocurrencyAddress(Cryptocurrency::BITCOIN, "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa"))
  ->build();

// you can also encode any binary data
Content::builder()
  ->component(new QrCode(implode(array_map(function($byte) { return chr($byte); }, [1, 2, 3]))))
  ->build();

Signature

Generated signatures can be added to your emails to give a bit of a personal touch. This will embed an image with your custom text using one of several available fonts:

// signature with a default font
Content::builder()
  ->signature("John Smith")
  ->build();

// signature with a custom font
Content::builder()
  ->component("John Smith", SignatureFont::REENIE_BEANIE)
  ->build();

These are the available fonts:

SignatureFont::REENIE_BEANIE preview →
SignatureFont::MEOW_SCRIPT preview →
SignatureFont::CAVEAT preview →
SignatureFont::ZEYADA preview →
SignatureFont::PETEMOSS preview →

Signature should not exceed 64 characters. Only alphanumeric characters and most common symbols are allowed.

Components can be placed in the header, body and footer of the email. Header and footer styling is usually a bit different from the body (for example the text is smaller).

$header = Collection::builder() // header of the email
  ->text("Smaller text")
  ->build();

$content = Content::builder() // body of the email
  ->text("Normal text")
  ->build();

Currently there are 2 themes to choose from: Theme::UNSTYLED and Theme::SIMPLE

$content = Content::builder()
  ->theme(Theme::SIMPLE)
  ->text("Hello world")
  ->build();

🤝 Contributing

Contributions are more than welcome
Please star this repo for more visibility <3

📫 Get in touch

For customer support feel free to email us at github@templateless.com
Have suggestions or want to give feedback? Here's how to reach us:
- For feature requests, please start a discussion
- Found a bug? Open an issue!
- Say hi @Templateless 👋

🍻 License

MIT

templateless / templateless

Maintainers

Details