Child pages
  • Manuel d'installation de l'api mail v1.x
Skip to end of metadata
Go to start of metadata

Documentation pour l'ancienne version de SMS-U

Installation de l'api mail du service SMS-U

L'application de api mail packagée se trouve dans le dossier /dist du projet.
Dézippez le contenue de la distribution la plus récente de esup-smsuapimail dans un répertoire de travail.
Le paramétrage suivant est à effectuer dans le dossier ainsi créé.

Déploiement de l'application api-mail

Le api-mail se déploie en mode servlet.
Il faut tout d'abord vérifier la configuration des fichiers suivant :

  • properties/config.properties
    • le paramétrage général de l'application.
  • build.properties
    • le mode quick start doit être activé
  • properties/logging/log4j.properties
    • Vérifier le chemin d'accès du fichier de log

Lancement de l'application

L'application se lance par la tache ant start :

ant start

Paramétrage de l'api mail du service SMS-U

Un fichier de propriété permet aux exploitants de paramétrer l'api mail du service SMS-U.
Voici la liste des paramètres disponibles :

  • Le nom du compte d'imputation par défaut qui sera utilisé par le service mail :

    smsuapimail.account.label=
    

    Ce paramètre défini le compte d'imputation qui sera utilisé pour envoyer des SMS lorsque l'email reçu ne spécifie pas de compte d'imputation.

  • La taille maximale d'un message :

    smsuapimail.message.maxLength=160
    

    Ce paramètre défini la taille maximale (en nombre de caractères) que peut faire le message avant que celui ci ne soit tronqué.

  • L'adresse du serveur pop :

    smsuapimail.pop.serverAddress=pop.example.fr
    

    Ce paramètre défini l'adresse du serveur pop où se trouve la boite email à scruter.

  • Le login de la boite email sur le serveur pop :

    smsuapimail.pop.serverLogin=aLogin
    

    Ce paramètre défini le login à utiliser pour se connecter au serveur pop où se trouve la boite email à scruter.

  • Le mot de passe de la boite email sur le serveur pop :

    smsuapimail.pop.serverPassword=aPassword
    

    Ce paramètre défini le mot de passer à utiliser pour se connecter au serveur pop où se trouve la boite email à scruter.

  • Le nom du répertoire où se trouve les emails :

    smsuapimail.pop.folderName=INBOX
    

    Ce paramètre défini le nom du dossier dans lequel sont déposés les emails à traiter.

  • La balise qui est attendue dans les emails pour définir les destinataires :

    smsuapimail.pop.recipientsTag=destinataires
    

    Ce paramètre défini la balise qui doit se trouver dans les emails reçus et qui définie les destinataires.

  • La balise qui est attendue dans les emails pour définir le compte d'imputation:

    smsuapimail.pop.accountTag=compte
    

    Ce paramètre défini la balise qui doit se trouver dans les emails reçus et qui définie le compte d'imputation.

  • La balise qui est attendue dans les emails pour définir le message :

    smsuapimail.pop.contentTag=message
    

    Ce paramètre défini la balise qui doit se trouver dans les emails reçus et qui définie le message.

  • Le pattern définissant un numéro de téléphone valide :

    smsuapimail.pop.phoneNumerPattern=(06|07)[0-9]{8}
    

    Ce paramètre défini le pattern qui est utilisé pour définir ce qu'est un numéro de téléphone valide.

  • L'encodage de caractère utiliser dans les emails :

    smsuapimail.pop.mailCharset=UTF-8
    

    Ce paramètre défini l'encodage utilisé dans les emails reçus.

  • L'adresse du web service du back office :

    smsuapimail.ws.backOfficeAddress=https://host.domain.fr:8081/xfire
    

    Ce paramètre défini l'adresse du web service du back office.

  • .La localisation du truststore :

    smsuapimail.ws.trustStore=/an/example/trustStore.jks
    

    Ce paramètre défini la localisation du trustStore de l'application.

  • Le mot de passe du truststore :

    smsuapimail.ws.trustStorePassword=password
    

    Ce paramètre défini le mot de passe du trustStore.

  • La localisation du keyStore :

    smsuapimail.ws.keyStore=/an/example/keyStore.jks
    

    Ce Ce paramètre défini la localisation du keyStore de l'application.

  • Le mot de passe du keyStore :

    smsuapimail.ws.keyStorePassword=password
    

    Ce paramètre défini le mot de passe du keyStore

  • Fichier de sauvegarde de l'identifiant message :

    smsuapimail.ws.messageIdFileName=[Chemin_Accès]/properties/messageId.txt
    

    Ce fichier conserve le dernier identifiant d'envoi de message envoyé en back office. Il permet de regrouper les SMS provenant un même mail.

  • L'identifiant d'expéditeur envoyé au back office :

    smsuapimail.ws.senderId=
    

    Ce paramètre défini l'identifiant d'expéditeur transmis au back office (ce paramètre peut rester vide)

  • L'identifiant de groupe d'expéditeur envoyé au back office :

    smsuapimail.ws.groupSenderId=
    

    Ce paramètre défini l'identifiant du groupe de l'expéditeur transmis au back office (ce paramètre peut rester vide)

  • L'identifiant du service envoyé au back office :

    smsuapimail.ws.serviceId=
    

    Ce paramètre défini l'identifiant du service transmis au back office (ce paramètre peut rester vide)

  • La fréquence d'exécution de la tache mail vers SMS :

    smsuapimailquartz.mailToSmsTrigger.cronExpression= 0 0/10 * * * ?
    

    Ce paramètre défini l'expression cron qui définie la fréquence de polling de la boite email et du processus d'envoi.

  • La fréquence d'exécution de la tache mail vers SMS :

    smsuapimail.quartz.configFileLocation=/example/smsuapimail_quartz.properties
    

    Ce paramètre défini la localisation du fichier de configuration de Quartz.

  • No labels