S²LOW 1.1 API mail sécurisé. Eric Pommateau Sigmalis

Transcription

1 S²LOW 1.1 API mail sécurisé Eric Pommateau Sigmalis

2 Table des matières Liste des utilisateurs de la collectivité...3 Nombre de mails sur le système...3 Liste de mails...3 Détail d'un Objet : ce document décrit l'api HTTP permettant d'accéder via un programme au module de mail sécurisé du logiciel S²low. Tous les chemins de scripts indiqués par la suite sont relatifs à l'adresse de base du serveur (qui est de la forme L'ensemble des scripts est situé dans le répertoire /modules/mail/api/

3 Version de l'api Nom du script : version.php Un fichier texte ligne à ligne : version_api detail_version_api Liste des utilisateurs de la collectivité Nom du script : user-mail.php aucun Un fichier texte ligne à ligne ou chaque ligne désigne une entrée de l'annuaire. Les lignes sont formaté de la manière suivante : id_utilisateur: description[:groupe[:groupe ]] Nombre de mails pour la collectivité Nom du script : nb-mail.php aucun Le nombre de mail pour la collectivité. Liste des mails pour la collectivité Nom du script : list-mail.php limit Facultative entier Nombre maximum de mail listé

4 Offset facultative entier Sauter offset mail avant l'affichage Le script affiche limit mail classé par date inverse de création à partir de l' d'ordre offset. Chaque ligne représente les informations sur un de la manière suivante : id_mail:date creation:état confirmation:objet état confirmation est soit : aucune confirmation (aucun des destinataire n'a consulté le mail) ; confirmé partiellement (au moins un destinataire a consulté le mail) ; confirmé (tous les destinataires ont consulté le mail). Détail d'un Nom du script : detail-mail.php id Obligatoire entier Identifiant du mail retourné par le script list-mail.php un fichier contenant l'ensemble des informations sur le mail ***************************** id : identifiant du mail date_envoi : date d'envois du mail password : mot de passe éventuelle pour protéger le mail fn_download : code md5 permettant de récupérer les fichiers status : status de confirmation (identique liste mail) objet : sujet du mail emis:"description" < >:champs input:confirmé:date_confirmation ==message== Le message ******************************* champs input est soit : mailto, mailcc, mailbcc confirmé est soit t (vrai) ou f (faux)

5 date_confirmation est présent si confirmé est vrai Pour récupérer les fichiers il suffit d'interroger : modules/mail/template/download.php? filename=mail.zip&root=fn_download

6 Envoie d'un mail Nom du script : send-mail.php Méthode HTTP d'appel : POST mailto Obligatoire Liste d'adresse Destinataires mailcc facultative Liste d'adresse mail en copie mailcci facultative Liste d'adresse Mail en copie caché objet obligatoire Chaine Sujet du mail message Obligatoire Chaine message password Facultative Chaine Mot de passe de protection du message send_password Facultative Booléen 0 : le mot de passe n'est pas indiqué dans le mail 1 : le mot de passe est indiqué dans le mail. Par défaut à 0. uploadfilen Facultative File Fichier a attaché (autant que souhaité) uploadfile1 pour le premier uploadfile2 pour le second,... La liste des adresses est formaté comme suit : chaque adresse est séparée par une virgule une adresse est soit une adresse unique, soit un groupe une adresse unique peuvent s' écrire de la manière suivante : "description" < > ou < > un groupe est écrit de la manière suivante : nom du groupe (groupe) Exemple : "eric" [eric@sigmalis.com], "pierre" [pierre@adullact.org], service comptable (groupe) Si le mail a été accepté par le système : OK:id_mail Sinon : ERROR:raison de l'erreur

7 Suppression d'un Nom du script : delet .php id Obligatoire entier Identifiant du mail retourné par le script list-mail.php OK: si le mail a été supprimé, ERROR: suivie de la raison de l'erreur sinon. *****************************