Vue (@frontmail/vue)

npm install @frontmail/vue

Requires Vue 3.3+. Works with Nuxt in client-side code.

Plugin

import { createApp } from 'vue';
import { Frontmail } from '@frontmail/vue';
import App from './App.vue';

createApp(App)
  .use(Frontmail, { publicKey: 'pk_4f2a…', blockHeadless: true })
  .mount('#app');

Options are the same as init(). The plugin also registers <FrontmailForm> globally.

FrontmailForm

<template>
  <FrontmailForm
    service-id="svc_01J9…"
    template-id="tpl_contact"
    turnstile-site-key="YOUR_TURNSTILE_SITE_KEY"
    @success="(r) => console.log(r.status)"
    @error="(e) => console.error(e.code)"
    v-slot="{ status, error }"
  >
    <input name="name" required />
    <input name="email" type="email" required />
    <textarea name="message" required />
    <button :disabled="status === 'sending'">Send</button>
    <p v-if="status === 'sent'">Thank you!</p>
    <p v-else-if="status === 'held'">Received – it will be delivered shortly.</p>
    <p v-if="error" role="alert">{{ error.message }}</p>
  </FrontmailForm>
</template>

Props: serviceId, templateId, turnstileSiteKey, turnstileOptions, sendOptions, resetOnSuccess (default true). Events: success, error, status. The default slot gets { status, error, result }.

turnstileSiteKey is the site key of your own Turnstile widget (Security → Bot protection (Turnstile) in the dashboard) – see Cloudflare Turnstile. Leave it out if the template doesn’t require a CAPTCHA.

useSendEmail

<script setup lang="ts">
import { ref } from 'vue';
import { useSendEmail } from '@frontmail/vue';

const email = ref('');
const { send, status, error } = useSendEmail('svc_01J9…', 'tpl_newsletter');
</script>

<template>
  <form @submit.prevent="send({ email })">
    <input v-model="email" type="email" />
    <button :disabled="status === 'sending'">Subscribe</button>
    <p v-if="status === 'error'">{{ error?.message }}</p>
  </form>
</template>

status, error and result are readonly refs. serviceId and templateId may be refs or getters.

useFrontmail

useFrontmail() returns the client provided by the plugin (for getStatus and low-level calls).

Example project: examples/vue.