Newsletter - AquilaCMS/aquila-connector GitHub Wiki

/src/api/newsletter/index.js

Functions

Get data of a subscription for an email

getNewsletter(email)
  • email - string : Email of user
Example
import { getNewsletter } from '@aquilacms/aquila-connector/api/newsletter';
const res = await getNewsletter(user.email);

Subscribe / Unsubscribe a user to a newsletter

setNewsletter(email, name, optin)
  • email - string : Email of user
  • name - string? : Newsletter's segmentation ("DefaultNewsletter" is the default value) - Optional
  • optin - boolean : Subscription boolean
Example
import { setNewsletter } from '@aquilacms/aquila-connector/api/newsletter';
const res = await getNewsletter(user.email);
import { setNewsletter } from '@aquilacms/aquila-connector/api/newsletter';
const res = await setNewsletter(user.email, 'DefaultNewsletter', optinNewsletter);
⚠️ **GitHub.com Fallback** ⚠️