Hedgehog SDK

Appearance

Return to top
On this page

stage.ref.admin.email.template

ステージに紐づく各種メールテンプレートのオペレータです。

メソッド

create() admin

引数必須型内容
type✓EmailTypeメールの種類
data✓stringテンプレートデータ
formatboolean改行コードを<br/>に変更するかどうか
type
Promise<EmailTemplate>

メールテンプレートを作成します。

使用方法

ts
// 物販の場合
await Hedgehog.stage
  .ref("ステージのUUID")
  .admin.email.template.create(EmailType.Product, {
    title: "タイトル",
    body: "メール本文",
  });

delete() admin

引数必須型内容
type✓EmailTypeメールの種類
type
Promise<EmailTemplate>

メールテンプレートを削除します。

使用方法

ts
// 物販の場合
await Hedgehog.stage
  .ref("ステージのUUID")
  .admin.email.template.delete(EmailType.Product);

get() admin

引数必須型内容
type✓EmailTypeメールの種類
type
Promise<(EmailTemplate|undefined)>

メールテンプレートを取得します。

使用方法

ts
// 物販の場合
const template = await Hedgehog.stage
  .ref("ステージのUUID")
  .admin.email.template.get(EmailType.Product);

update() admin

引数必須型内容
type✓EmailTypeメールの種類
data✓stringテンプレートデータ
formatboolean改行コードを<br/>に変更するかどうか
type
Promise<EmailTemplate>

メールテンプレートを更新します。

使用方法

ts
// 物販の場合
await Hedgehog.stage
  .ref("ステージのUUID")
  .admin.email.template.update(EmailType.Product, {
    title: "タイトル",
    body: "メール本文",
  });

variables() admin

引数必須型内容
type✓EmailTypeメールの種類
type
Promise<Array<EmailVariable>>

メールテンプレートで使用できる変数を取得します。

使用方法

ts
// 物販の場合
const vals = await Hedgehog.stage
  .ref("ステージのUUID")
  .admin.email.template.variables(EmailType.Product);