アクションのトリガー：custom-email-providerのAPIオブジェクト

api.cache

実行間で維持されるデータの保管と取得を行います。

api.cache.delete(key)

提供されたkeyにキャッシュ済みの値が存在する場合は、それを記述したレコードを削除します。

値がキャッシュから削除されると、CacheWriteResultオブジェクトにtype: "success"を含めて返します。操作に失敗すると、type: "error"を返します。エラーの場合には、返すオブジェクトにcodeプロパティを含めて、失敗の詳細を示します。

api.cache.get(key)

提供されたkeyにキャッシュ済みの値が存在する場合は、それを記述したレコードを取得します。レコードが見つかった場合には、返されたオブジェクトのvalueプロパティにキャッシュ済みの値があります。

提供されたkeyにキャッシュ済みの項目が存在する場合は、それを記述したレコードを返します。キャッシュレコードは、キャッシュされた値のあるvalueプロパティと、レコードの最大有効期限をUNIXエポックからのミリ秒単位で示すexpires_atプロパティを含むオブジェクトです。

重要：このキャッシュは、短命で一時的なデータ向けに設計されています。項目が所定のライフタイム内であったとしても、後のトランザクションでは利用できないかもしれません。

api.cache.set(key, value, [options])

指定されたkeyのキャッシュに文字列値を保管または更新します。

このキャッシュに保管された値は、それを設定するトリガーにスコープが限定されます。これはアクションのキャッシュ制限の対象になります。

ここのように保管された値には、指定されたttlまたはexpires_at値までのライフタイムがあります。ライフタイムが指定されない場合には、デフォルトのライフタイムである15分が使用されます。ライフタイムはアクションのキャッシュ制限が定める最大値を超過してはいけません。

api.notification

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

api.notification.drop(reason)

呼び出されると、通知イベントは回復せずに失敗したと見なされます。

このイベント(fn)のエラーがログに記録されますが、今後アクションに再度送信されることはありません。

この通知イベントを再試行する必要がある場合は、代わりにapi.notification.retryを呼び出すことを検討してください。

api.notification.retry(reason)

呼び出されると、通知イベントは失敗したものと見なされますが、回復可能です。

このイベント(fn)のエラーがログに記録されますが、数分以内に最大5回再試行されます。

この通知イベントを再試行しない必要がある場合は、代わりにapi.notification.dropを呼び出すことを検討してください。