Mailbox

Nom de la ressource mailbox
URL https://api.alwaysdata.com/v1/mailbox
Description Boîtes emails
Operations create, read, update, delete, list

Fields

Nom Details
id

readonly: YES

integer

Resource ID.

href

readonly: YES

string

Resource location.

domain domain

Nom de domaine de l'adresse.

name string

Indiquez ici la partie de l'email précédant le signe @. Par exemple : paul.durand. Si vous voulez créer une adresse collectrice (catch-all), rentrez * (étoile).

password string

Mot de passe

antispam_enabled

default value: True

bool

Activer l'anti-spam

antispam_score

default value: 5

integer

L'anti-spam attribue à chaque message entrant un score suivant la probabilité qu'il s'agisse d'un spam. Les messages dépassant ce score seront stockés dans le dossier indiqué ci-dessous. À moins de savoir ce que vous faites, laissez la valeur par défaut (5).

antispam_folder

default value: Spam

string

Dossier dans lequel les spams seront déplacés.

antispam_score_delete

default value: 15

integer

Les messages dépassant ce score seront directement supprimés, sans même être stockés dans le dossier des spams. À moins de savoir ce que vous faites, laissez la valeur par défaut (15).

purge_enabled

default value: True

bool

Activer la purge

purge_days

default value: 30

integer

Les messages seront supprimés après cette durée.

purge_folders

default value: Trash Spam

string

Liste des dossiers à purger. Indiquez plusieurs dossiers en les séparant par un espace. Pour le dossier principal, indiquez INBOX. Pour les dossiers contenant un espace dans leur nom, indiquez-les entre guillemets.

redirect_enabled

default value: False

bool

Activer la redirection

redirect_to

default value: null

string

Indiquez les adresses vers lesquelles les emails seront redirigés. Séparez chaque adresse par un espace ou un retour à la ligne. Si vous souhaitez saisir un grand nombre d'adresses, préférez l'utilisation des listes de diffusion.

redirect_local_copy

default value: False

bool

En cochant cette case, tous les emails redirigés seront également copiés dans cette boîte email. Sinon, les emails ne seront pas stockés sur votre compte, uniquement redirigés.

autoresponder_enabled

default value: False

bool

Activer le répondeur automatique

autoresponder_days

default value: 7

integer

Un seul message automatique par adresse sera envoyé pour la durée de la période spécifiée (en jours). Indiquez 0 pour envoyer un message à chaque fois.

autoresponder_subject

default value: null

string

Sujet

autoresponder_message

default value: null

string

Message

quota_enabled

default value: False

bool

Activer le quota

quota_storage

default value: null

integer

Taille maximale (en Mo)

sieve_enabled

default value: False

bool

Si le script Sieve est activé, il sera exécuté après les opérations ci-dessus (antispam, redirection, etc.).

sieve_filter

default value: null

string

Script au format Sieve exécuté à la réception des emails.

annotation string

L'annotation est facultative et apparaitra dans le listing.