> ## 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 オブジェクトについて説明します。

# Actions トリガー: custom-email-provider - API オブジェクト

custom-email-provider Actions トリガーの API オブジェクトには、次のものが含まれます：

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

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

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

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

<ResponseField name="key" type="string">
  削除するキャッシュレコードのキー。
</ResponseField>

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

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

<ResponseField name="key" type="string">
  キャッシュに保存されているレコードのキー。
</ResponseField>

<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) に記載された最大時間を超えることはできません。

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

<ResponseField name="key" type="string">
  保存するレコードのキー。
</ResponseField>

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

<ResponseField name="options" type="cachesetoptions" post={["optional"]}>
  キャッシュの動作を調整するためのオプション。

  <Expandable title="options のプロパティ" defaultOpen>
    <ResponseField name="expires_at" type="number" post={["optional"]}>
      Unix エポックからの経過時間をミリ秒で表した絶対有効期限です。
      キャッシュされたレコードはこれより前に削除される場合がありますが、
      指定された `expires_at` を過ぎて保持されることはありません。

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

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

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

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

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

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

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

<ResponseField name="reason" type="string">
  この理由はログエントリの一部となり、エラーの詳細な分析に役立ちます。このフィールドは 1024 文字までに制限されており、それを超える場合は切り詰められます。
</ResponseField>

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

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

<ResponseField name="reason" type="string">
  この理由はログエントリの一部となり、エラーの詳細な分析に役立ちます。このフィールドは 1024 文字までに制限されており、それを超える場合は切り詰められます。
</ResponseField>