Docs - Sniper Link

Overview

Sniper Link streamlines email confirmation. Once a user provides their email, they can be shown a button that sends them directly to their respective inbox, filtered down to the given sender and bypassing the spam folder.

For support, email support@buttondown.email.

Basic usage

Sniper Link can be easily integrated into your app using the provided script and HTML tag:

<sniper-link
  recipient="me@gmail.com"
  sender="justin@buttondown.email"
/>

<script src="https://sniperl.ink/v1/sniper-link.js" defer></script>

Attributes:

recipient: The email address of the person expected to confirm their email.
sender: The email address from which the confirmation is sent.

Custom styling

The Sniper Link button is designed to be customized using CSS. There are four parts to the button:

container: A wrapper that holds the entire button.
button: The clickable element.
image: A logo representing the email provider.
text: A label, by default showing “Open in {provider}”.

You can use the ::part CSS selector to override the default styles:

sniper-link::part(container) {
  width: 100%;
}

sniper-link::part(button) {
  background-color: darkorange;
  justify-content: center;
  border-radius: 99px;
}

sniper-link::part(image) {
  background-color: white;
  padding: 1px 3px;
  border-radius: 4px;
  box-shadow: 0 0 4px hsla(0, 0%, 0%, 0.1);
}

sniper-link::part(text) {
  color: white;
  text-shadow: 0 0 4px hsla(0, 0%, 0%, 0.2);
}

Custom label text

The default text on the Sniper Link button is “Open in {provider}”, but you can change it using the template attribute:

Code Example:

<sniper-link
  recipient="me@gmail.com"
  sender="justin@buttondown.email"
  template="Confirm email using {provider}"
></sniper-link>

Unrecognized providers

We’re working on supporting as many providers as possible. Currently, we support Gmail, Yahoo, Proton, iCloud, Outlook, HEY, AOL, and Mail.ru, and we’re adding additional ones. Let us know (support@buttondown.email) if there’s a provider you’d like us to add!

When the email provider cannot be determined, the sniper-linkelement will have a hidden attribute. This attribute can be used for styling the button or the adjacent elements.

Advanced: Usage via the API

If you want to create your own custom button, you can directly depend on our API to construct it:

GET https://sniperl.ink/v1/render?recipient={recipient}&sender={sender}

It’s useful to do this API call from the frontend, because the endpoint also relies on the User-Agent to determine whether the device is desktop, iOS, or Android.

Ideally, the response will look like this:

{
  "url": "https://...",
  "image": "https://sniperl.ink/logos/gmail.png",
  "provider_pretty": "Gmail"
}

If the provider cannot be recognized, you’ll receive a `404` error:

// Status: 404
{
  "code": "unknown_email_provider",
  "detail": "Unknown email provider for fake@example.com",
  "metadata": {
    "recipient": "fake@example.com"
  }
}

We handle the DNS lookup, parsing, and caching, so this endpoint stays fast.

Behind the scenes

First we check whether the domain of the email address is obvious (i.e. it ends in @gmail.com or similar).
If the domain is not obvious, we do a DNS lookup to try to determine what email provider is being used for the domain.
Then, we determine the user’s platform (desktop, iOS, or Android) in order to provide the best possible URL for their provider and platform.
Finally, we serve the detected provider and URL to the user via the <sniper-link> component or API response.

Documentation