> ## Documentation Index
> Fetch the complete documentation index at: https://translations.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

> custom-email-provider Action トリガーの API object について説明します。

# API Object

custom-email-provider Actions トリガーの API object には、以下が含まれます。

<div id="apicache">
  ## `api.cache`
</div>

キャッシュを変更します。

<div id="apicachedeletekey">
  ### `api.cache.delete(key)`
</div>

指定されたキーに対応するキャッシュ値のレコードが存在する場合は、削除します。

**パラメータ**

<Expandable title="パラメータ" defaultOpen>
  <ParamField body="key" type="string">
    削除するキャッシュレコードのキー。
  </ParamField>
</Expandable>

<div id="apicachegetkey">
  ### `api.cache.get(key)`
</div>

指定されたキーに対応するキャッシュ値のレコードが存在する場合、それを取得します。レコードが見つかった場合、キャッシュ値は返されるオブジェクトの `value` プロパティに格納されています。

**パラメータ**

<Expandable title="パラメータ" defaultOpen>
  <ParamField body="key" type="string">
    キャッシュに保存されているレコードのキー。
  </ParamField>
</Expandable>

<div id="apicachesetkey-value-options">
  ### `api.cache.set(key, value, options)`
</div>

指定したキーにキャッシュ内の文字列値を保存または更新します。

このキャッシュに保存される値は、設定されたトリガーのスコープ内に限定されます。
また、[Actions Cache Limits](https://auth0.com/docs/customize/actions/limitations) の制限が適用されます。

この方法で保存された値の有効期間は、指定した
`ttl` または `expires_at` の値までです。有効期間を指定しない場合は、デフォルトで
15分が使用されます。有効期間は、[Actions Cache Limits](https://auth0.com/docs/customize/actions/limitations) に記載された最長
期間を超えることはできません。

**重要**: このキャッシュは、短期間の一時的なデータ向けに設計されています。指定した有効期間内であっても、項目が
後続のトランザクションで利用できない場合があります。

**パラメータ**

<Expandable title="パラメータ" defaultOpen>
  <ParamField body="key" type="string">
    保存するレコードのキー。
  </ParamField>

  <ParamField body="value" type="string">
    保存するレコードの値。
  </ParamField>

  <ParamField body="options" type="cachesetoptions">
    キャッシュの動作を調整するためのオプション。
    任意。

    <Expandable title="options プロパティ">
      <ParamField body="expires_at" type="number">
        Unixエポックからのミリ秒単位の絶対有効期限。
        キャッシュされたレコードはそれより前に削除される場合がありますが、
        指定した `expires_at` を過ぎて保持されることはありません。

        *注*: `ttl` にも値が
        指定されている場合は、この値を指定しないでください。両方のオプションを指定した場合は、
        2つのうち早い方の有効期限が使用されます。
        任意。
      </ParamField>

      <ParamField body="ttl" type="number">
        このキャッシュエントリのミリ秒単位の有効期間。
        キャッシュ値はそれより前に削除される場合がありますが、
        指定した `ttl` を過ぎて保持されることはありません。

        *注*: `expires_at` にも値が
        指定されている場合は、この値を指定しないでください。両方のオプションを指定した場合は、
        2つのうち早い方の有効期限が使用されます。
        任意。
      </ParamField>
    </Expandable>
  </ParamField>
</Expandable>

<div id="apinotification">
  ## `api.notification`
</div>

通知イベントを再試行するか破棄するかを指定します。
実際の動作の詳細については、各メソッドを参照してください。
複数回呼び出された場合は、最後の呼び出しのみが考慮されます。

<div id="apinotificationdropreason">
  ### `api.notification.drop(reason)`
</div>

呼び出されると、通知イベントは復旧せずに失敗したものと見なされます。
このイベントのエラーはログに記録されますが、今後この Action に再送信されることはありません。
この通知イベントを再試行する必要がある場合は、代わりに retry を呼び出してください。

**パラメータ**

<Expandable title="パラメータ" defaultOpen>
  <ParamField body="reason" type="string">
    この理由はログエントリの一部として記録され、エラーの詳細な分析に役立ちます。このフィールドは1024文字までで、それを超える場合は切り詰められます。
  </ParamField>
</Expandable>

<div id="apinotificationretryreason">
  ### `api.notification.retry(reason)`
</div>

呼び出すと、通知イベントは失敗として扱われますが、復旧可能です。
このイベントのエラーはログに記録され、以降数分間に最大5回再試行されます。
この通知イベントを再試行すべきでない場合は、代わりに drop を呼び出すことを検討してください。

**パラメータ**

<Expandable title="パラメータ" defaultOpen>
  <ParamField body="reason" type="string">
    この理由はログエントリの一部となり、エラーの詳細な分析に役立ちます。このフィールドは1024文字までに制限されており、超過した場合は切り詰められます。
  </ParamField>
</Expandable>