ISPmanager API. Boîtes email (ISPmanager)
De ISPWiki.
- [#email Boîtes email]
- [#email.edit Création. Modification. Boîte email]
- [#email.vacation Auto-répondeur (vacation) . Affichage. Modification]
- [#email.filter Classement des messages]
- [#email.filter.edit Création. Modification. Filtre email]
- [#email.filter.delete Supprimer filtres émail]
- [#email.filter.cond Conditions de filtre émail]
- [#email.filter.cond.edit Création. Modification. Condition]
- [#email.filter.cond.delete Supprimer une condition]
- [#email.delete Supprimer boîtes email]
- [#email.clear Nettoyer les boîtes email sélectionnées]
- [#email.enable Activer boîtes email]
- [#email.disable Désactiver boîtes email]
- [#email.outlook Configuration Outlook Express. Affichage. Modification]
Boîtes email.
Fonction: email
Résultat: la [api.html#list liste des éléments]
- name - Nom.
- pop3 - Login POP3.
- disabled - Boîte email est temporairement désactivée.
- size - Taille. Attributs :
- used - Nombre utilisé.
- limit - Valeur maximale possible.
Création. Modification. Boîte email.
Fonction: email.edit
Cette fonction peut etre utilisée pour afficher un objet, modifier un objet existant et créer un nouvel objet.
Affichage d'un objet:
- Paramètres:
- elid - l'identificateur unique (l'élément "name" de la fonction "email")
- Résultat: la [api.html#param liste des paramètres d'objet]
Création d'un objet:
- Paramètres:
- sok - la valeur de paramètre doit etre égale à "yes".
- des paramètres de requete supplémentaires...
- Résultat: la [api.html#ok réussite de l'opération] ou le [api.html#error message d'erreur]
Modification d'un objet:
- Paramètres:
- sok - la valeur de paramètre doit etre égale à "yes".
- elid - l'identificateur unique (l'élément "name" de la fonction "email")
- des paramètres de requete supplémentaires...
- Résultat: la [api.html#ok réussite de l'opération] ou le [api.html#error message d'erreur]
Liste des paramètres d'objet ou des paramètres de requete supplémentaires (voir ci-dessus):
- name - Nom.
- domain - Domaine.
- aliases - Alias. (Une ou plusieurs valeurs séparées par un espace)
- passwd - Mot de passe.
- confirm - Confirmation.
- quota - Taille max.. (Valeur numérique. Pour spécifier la valeur illimitée veuillez utiliser "0".)
- forward - Rediriger courrier. (Une ou plusieurs valeurs séparées par un espace)
- rmlocal - Ne pas conserver dans la boîte. (Paramètre facultatif. Pour activer cette option veuillez utiliser la valeur "on".)
- greylist - Activer greylisting. (Paramètre facultatif. Pour activer cette option veuillez utiliser la valeur "on".)
- spamassassin - Activer SpamAssassin. (Paramètre facultatif. Pour activer cette option veuillez utiliser la valeur "on".)
Auto-répondeur (vacation) . Affichage. Modification.
Fonction: email.vacation
Cette fonction est utilisée pour afficher et modifier un objet
Affichage d'un objet:
- Paramètres:
- elid - l'identificateur unique (l'élément "name" de la fonction "email")
- Résultat: la [api.html#param liste des paramètres d'objet]
Modification d'un objet:
- Paramètres:
- sok - la valeur de paramètre doit etre égale à "yes".
- elid - l'identificateur unique (l'élément "name" de la fonction "email")
- des paramètres de requete supplémentaires ...
- Résultat: la [api.html#ok réussite de l'opération] ou le [api.html#error message d'erreur]
Liste des paramètres d' objet ou des paramètres de requete supplémentaires (voir ci-dessus):
- arfrom - De.
- arsubj - Objet.
- arbody - Message.
Classement des messages.
Fonction: email.filter
Paramètres:
- elid - l'identificateur unique (l'élément "name" de la fonction "email").
Résultat: la [api.html#list liste des éléments]
- name - Nom de filtre émail.
Création. Modification. Filtre email.
Fonction: email.filter.edit
Cette fonction est utilisée pour afficher un objet, modifier un objet existant et créer un nouvel objet.
Affichage d'un objet:
- Paramètres:
- plid - l'identificateur unique de la liste parent (l'élément "name" de la fonction "email").
- elid - l'identificateur unique (l'élément "name" de la fonction "email.filter")
- Résultat: la [api.html#param liste des paramètres d'objet]
Création d'un objet:
- Paramètres:
- sok - la valeur de paramètre doit etre égale à "yes".
- plid - l'identificateur unique de la liste parent (l'élément "name" de la fonction "email").
- des paramètres de requete supplémentaires ...
- Résultat: la [api.html#ok réussite de l'opération] ou le [api.html#error message d'erreur]
Modification d'un objet:
- Paramètres:
- sok - la valeur de paramètre doit etre égale à "yes".
- plid - l'identificateur unique de la liste parent (l'élément "name" de la fonction "email").
- elid - l'identificateur unique (l'élément "name" de la fonction "email.filter")
- des paramètres de requete supplémentaires ...
- Résultat: la [api.html#ok réussite de l'opération] ou le [api.html#error message d'erreur]
Liste des paramètres d'objet ou des paramètres de requete supplémentaires (voir ci-dessus):
- name - Nom.
- pos - Placer avant.
- cond_param - Paramètre.
- cond - Condition.
- cond_value - Valeur.
- act - Action.
- act_email - Email.
- act_imap - Répertoire IMAP.
- act_imap_new - Nouveau répertoire IMAP.
- act_command - Programme.
- copy - Travailler avec la copie. (Paramètre facultatif. Pour activer cette option veuillez utiliser la valeur "on".)
Supprimer filtres émail.
Fonction: email.filter.delete
Paramètres:
- plid - l'identificateur unique de la liste parent (l'élément "name" de la fonction "email").
- elid - un ou plusieurs identificateurs uniques de l'objet séparés par une virgule suivie d'un espace: ", ". L'identificateur unique est un élément "name" de la fonction "email.filter".
Résultat: la [api.html#ok réussite de l'opération] ou le [api.html#error message d'erreur]
Conditions de filtre émail.
Fonction: email.filter.cond
Paramètres:
- elid - l'identificateur unique (l'élément "name" de la fonction "email.filter").
Résultat: la [api.html#list liste des éléments]
- id - Identificateur unique d'un élément de liste.
- cond_param - Paramètre.
- cond - Condition.
- cond_value - Valeur .
Création. Modification. Condition.
Fonction: email.filter.cond.edit
Cette fonction est utilisée pour afficher un objet, modifier un objet existant et créer un nouvel objet.
Affichage d'un objet:
- Paramètres:
- plid - l'identificateur unique de la liste parent (l'élément "name" de la fonction "email.filter").
- elid - l'identificateur unique (l'élément "id" de la fonction "email.filter.cond")
- Résultat: la [api.html#param liste des paramètres d'objet]
Création d'un objet:
- Paramètres:
- sok - la valeur de paramètre doit etre égale à "yes".
- plid - l'identificateur unique de la liste parent (l'élément "name" de la fonction "email.filter").
- des paramètres de requete supplémentaires ...
- Résultat: la [api.html#ok réussite de l'opération] ou le [api.html#error message d'erreur]
Modification d'un objet:
- Paramètres:
- sok - la valeur de paramètre doit etre égale à "yes".
- plid - l'identificateur unique de la liste parent (l'élément "name" de la fonction "email.filter").
- elid - l'identificateur unique (l'élément "id" de la fonction "email.filter.cond")
- des paramètres de requete supplémentaires ...
- Résultat: la [api.html#ok réussite de l'opération] ou le [api.html#error message d'erreur]
Liste des paramètres d'objet ou des paramètres de requete supplémentaires (voir ci-dessus):
- cond_param - Paramètre.
- cond - Condition.
- cond_value - Valeur.
Supprimer une condition.
Fonction: email.filter.cond.delete
Paramètres:
- plid - l'identificateur unique de la liste parent (l'élément "name" de la fonction "email.filter").
- elid - un ou plusieurs identificateurs uniques de l'objet séparés par une virgule suivie d'un espace: ", ". L'identificateur unique est un élément "id" de la fonction "email.filter.cond".
Résultat: la [api.html#ok réussite de l'opération] ou le [api.html#error message d'erreur]
Supprimer boîtes email.
Fonction: email.delete
Paramètres:
- elid - un ou plusieurs identificateurs de l'objet séparés par une virgule suivie d'un espace: ", ". L'identificateur unique est un élément "name" de la fonction "email".
Résultat: la [api.html#ok réussite de l'opération] ou le [api.html#error message d'erreur]
Nettoyer les boîtes email sélectionnées.
Fonction: email.clear
Paramètres:
- elid - un ou plusieurs identificateurs de l'objet séparés par une virgule suivie d'un espace: ", ". L'identificateur unique est un élément "name" de la fonction "email".
Résultat: la [api.html#ok réussite de l'opération] ou le [api.html#error message d'erreur]
Activer boîtes email.
Fonction: email.enable
Paramètres:
- elid - un ou plusieurs identificateurs de l'objet séparés par une virgule suivie d'un espace: ", ". L'identificateur unique est un élément "name" de la fonction "email".
Résultat: la [api.html#ok réussite de l'opération] ou le [api.html#error message d'erreur]
Désactiver boîtes email.
Fonction: email.disable
Paramètres:
- elid - un ou plusieurs identificateurs de l'objet séparés par une virgule suivie d'un espace: ", ". L'identificateur unique est un élément "name" de la fonction "email".
Résultat: la [api.html#ok réussite de l'opération] ou le [api.html#error message d'erreur]
Configuration Outlook Express. Affichage. Modification.
Fonction: email.outlook
Cette fonction est utilisée pour afficher et modifier un objet
Affichage d'un objet:
- Paramètres:
- elid - l'identificateur unique (l'élément "name" de la fonction "email")
- Résultat: la [api.html#param liste des paramètres d'objet]
Modification d'un objet:
- Paramètres:
- sok - la valeur de paramètre doit etre égale à "yes".
- elid - l'identificateur unique (l'élément "name" de la fonction "email")
- des paramètres de requete supplémentaires ...
- Résultat: la [api.html#ok réussite de l'opération] ou le [api.html#error message d'erreur]
Liste des paramètres d' objet ou des paramètres de requete supplémentaires (voir ci-dessus):
