第12章 Liquid: メールテンプレート

3scale では、ご自分の組織独自のメッセージと用語を使用して、メールテンプレートをカスタマイズする機能を提供します。Liquid ドロップを活用して、各顧客に合わせてカスタマイズした情報を表示することもできます。

デベロッパーポータルで Liquid ドロップが使用されるのと同様に、各メールテンプレートには独自のコンテキストがあります。つまり、あるメールテンプレートで使用可能な Liquid ドロップが、他のメールテンプレートでも使用可能であるとは限りません。

本章では、内容ごとにグループ化されたメールテンプレートおよびそこでサポートされる Liquid ドロップのセットを使用して、どの Liquid ドロップをどこで使用できるのかについて概要を説明します。

12.1. アカウント管理

これらのメールテンプレートは、アカウント管理カテゴリーに分類されます。

  • Buyer Account confirmed
  • Buyer Account approved
  • Buyer account rejected

これらのテンプレートでは、以下の Liquid ドロップを使用できます。

  • user ⇒ User
  • domain ⇒ String
  • account ⇒ Account
  • provider ⇒ Provider
  • support_email ⇒ String

また、テンプレート

  • Password recovery for buyer

    これらの Liquid ドロップへのアクセスがあること。

  • user ⇒ User
  • provider ⇒ Provider
  • url ⇒ url

追加のユーザーをアカウントに招待するメールテンプレート

  • Invitation

    では、以下の Liquid ドロップを使用できます。

  • account ⇒ Account
  • provider ⇒ Provider
  • url ⇒ url

12.2. クレジットカードに関する通知

  • Credit card expired notification for provider
  • Credit card expired notification for buyer

以下の Liquid ドロップを使用できます。

  • user_account ⇒ Account
  • account ⇒ Account
  • provider_account ⇒ Provider
  • provider ⇒ Provider

12.3. 制限に対するアラート

  • Alert notification for provider (>= 100%)
  • Alert notification for buyer (>= 100%)
  • Alert notification for provider (< 100%)
  • Alert notification for buyer (< 100%)

では、以下の Liquid ドロップを使用できます。

  • application ⇒ Application
  • account ⇒ Account
  • provider ⇒ Provider
  • service ⇒ Service
  • alert ⇒ Alert

12.4. アプリケーション

以下のメールテンプレートは、すべてアプリケーションおよびアプリケーションプランの通知に関するものです。

  • Application created for provider

これらは以下の Liquid ドロップを使用できます。

  • url ⇒ url

アプリケーションプランの変更リクエストに関する通知のメールテンプレート:

  • Plan change request for buyer
  • Plan change request for provider

これらは以下の Liquid ドロップを使用できます。

  • application ⇒ Application
  • provider ⇒ Provider
  • account ⇒ Account
  • user ⇒ User
  • plan ⇒ Plan
  • credit_card_url ⇒ credit_card_url

以下のメールテンプレートには、以下のような利用可能なドロップが多数含まれています。

  • Application plan changed for buyer
  • Application plan changed for provider
  • Application trial period expired for buyer

これらは以下の Liquid ドロップを使用できます。

  • provider ⇒ Provider
  • account ⇒ Account
  • user ⇒ User
  • plan ⇒ Plan

上記のすべての Liquid ドロップに加え、アプリケーションプランに関するメッセージ

  • Application suspended for buyer
  • Application accepted for buyer
  • Application rejected for buyer
  • Application contract cancelled for provider

では、さらに以下の Liquid ドロップを使用できます。

  • application ⇒ Application
  • service ⇒ Service

アプリケーションキーに関する以下のメールテンプレートでは、さらに使用できる Liquid ドロップが増えます。

  • Application key created for buyer
  • Application key deleted for buyer
  • key ⇒ key

12.5. 請求

メールテンプレート

  • Review invoices prior to charging for provider

では、以下の Liquid ドロップを使用できます。

  • provider ⇒ Provider
  • url ⇒ String>

また、テンプレート

  • Invoice charge failure for provider without retry
  • Invoice upcoming charge for buyer
  • Invoice charge failure for provider with retry
  • Invoice charge failure for buyer without retry
  • Invoice charged successfully for buyer
  • Invoice charge failure for buyer with retry

では、以下の Liquid ドロップをすべて使用できます。

  • account ⇒ Account
  • provider ⇒ Provider
  • cost ⇒ cost
  • invoice_url ⇒ invoice_url
  • payment_url ⇒ payment_url

12.6. サービス

メールテンプレート

  • Service contract cancelled for provider
  • Service trial period expired for buyer
  • Service plan changed for provider
  • Service contract suspended for buyer

では、以下の Liquid ドロップを使用できます。

  • provider ⇒ Provider
  • account ⇒ Account
  • user ⇒ User
  • plan ⇒ Plan

上記の Liquid ドロップに加え、サービステンプレート

  • Service created for provider
  • Service accepted for buyer
  • Service rejected for buyer

では、さらに以下の Liquid ドロップを使用できます。

  • service ⇒ Service
  • service_contract ⇒ Contract
  • subscription ⇒ Contract

12.7. サインアップ

メールテンプレート

  • Sign-up notification for provider
  • Sign-up notification for buyer

では、以下の Liquid ドロップを使用できます。

  • user ⇒ User
  • provider ⇒ Provider
  • url ⇒ activate_url