> ## 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.

> Découvrez l’objet API du déclencheur Action custom-email-provider.

# Objet API

L’objet API du déclencheur Actions custom-email-provider comprend :

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

Modifiez le cache.

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

Supprime l’enregistrement associé à une valeur mise en cache pour la
clé fournie, s’il existe.

**Paramètres**

<Expandable title="Paramètres" defaultOpen>
  <ParamField body="key" type="string">
    La clé de l’enregistrement mis en cache à supprimer.
  </ParamField>
</Expandable>

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

Récupère un enregistrement décrivant une valeur mise en cache associée à la clé fournie,
s’il existe. Si un enregistrement est trouvé, la valeur mise en cache se trouve
dans la propriété `value` de l’objet retourné.

**Paramètres**

<Expandable title="Paramètres" defaultOpen>
  <ParamField body="key" type="string">
    La clé de l’enregistrement stocké dans le cache.
  </ParamField>
</Expandable>

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

Stocke ou met à jour une valeur de type chaîne dans le cache sous la clé indiquée.

Les valeurs stockées dans ce cache sont limitées au déclencheur dans lequel elles
sont définies. Elles sont soumises aux [limites du cache Actions](https://auth0.com/docs/customize/actions/limitations).

Les valeurs stockées de cette manière auront une durée de vie pouvant aller *jusqu’aux* valeurs
`ttl` ou `expires_at` indiquées. Si aucune durée de vie n’est indiquée, une durée de vie
par défaut de 15 minutes sera utilisée. Les durées de vie ne peuvent pas dépasser la durée
maximale indiquée dans les [limites du cache Actions](https://auth0.com/docs/customize/actions/limitations).

**Important** : Ce cache est conçu pour des données éphémères de courte durée. Les éléments peuvent ne pas être
disponibles lors de transactions ultérieures, même si leur durée de vie indiquée n’est pas écoulée.

**Paramètres**

<Expandable title="Paramètres" defaultOpen>
  <ParamField body="key" type="string">
    La clé de l’enregistrement à stocker.
  </ParamField>

  <ParamField body="value" type="string">
    La valeur de l’enregistrement à stocker.
  </ParamField>

  <ParamField body="options" type="cachesetoptions">
    Options permettant d’ajuster le comportement du cache.
    Facultatif.

    <Expandable title="propriétés des options">
      <ParamField body="expires_at" type="number">
        L’heure d’expiration absolue, en millisecondes depuis l’époque Unix.
        Bien que les enregistrements mis en cache puissent être évincés plus tôt, ils
        ne seront jamais conservés au-delà de la valeur `expires_at` indiquée.

        *Remarque* : Cette valeur ne doit pas être fournie si une valeur est également
        fournie pour `ttl`. Si les deux options sont fournies, la date d’expiration
        la plus rapprochée sera utilisée.
        Facultatif.
      </ParamField>

      <ParamField body="ttl" type="number">
        La durée de vie de cette entrée de cache, en millisecondes.
        Bien que les valeurs mises en cache puissent être évincées plus tôt, elles
        ne seront jamais conservées au-delà de la valeur `ttl` indiquée.

        *Remarque* : Cette valeur ne doit pas être fournie si une valeur est également
        fournie pour `expires_at`. Si les deux options sont fournies, la date d’expiration
        la plus rapprochée sera utilisée.
        Facultatif.
      </ParamField>
    </Expandable>
  </ParamField>
</Expandable>

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

Indique si l’événement de notification doit être réessayé ou abandonné.
Consultez chacune de ces méthodes pour en savoir plus sur le comportement réel.
Si plusieurs appels sont effectués, seul le dernier est pris en compte.

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

Lorsqu’elle est appelée, l’événement de notification est considéré comme ayant échoué, sans possibilité de rétablissement :
Nous consignerons une erreur pour cet événement, mais ne l’enverrons plus à l’Action à l’avenir.
Si cet événement de notification doit être réessayé, appelez plutôt retry.

**Paramètres**

<Expandable title="Paramètres" defaultOpen>
  <ParamField body="reason" type="string">
    cette raison sera incluse dans l’entrée de journal, ce qui vous aidera à analyser l’erreur plus en profondeur. Veuillez noter que ce champ est limité à 1 024 caractères et sera tronqué s’il est plus long.
  </ParamField>
</Expandable>

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

Lorsqu’elle est appelée, l’événement de notification est considéré comme ayant échoué, mais peut être récupéré :
Nous consignerons une erreur pour cet événement, mais nous le réessaierons jusqu’à cinq fois dans les prochaines minutes.
Si vous estimez que cet événement de notification ne devrait pas être réessayé, appelez plutôt drop.

**Paramètres**

<Expandable title="Paramètres" defaultOpen>
  <ParamField body="reason" type="string">
    cette raison sera incluse dans l’entrée de journal et vous aidera à analyser l’erreur plus en détail. Veuillez noter que ce champ est limité à 1 024 caractères et sera tronqué s’il est plus long.
  </ParamField>
</Expandable>