Child pages
  • Manuel d'installation de l'api mail

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

Table of Contents

Installation de l'api mail du service SMS-U

L'application de Back office est disponible sur github. Il est conseillé d'utiliser git pour télécharger les sources :

Code Block
git clone https://github.com/EsupPortail/esup-smsu-api-mail.git

N'hésitez pas également à utiliser GIT en interne pour exploiter et maintenir à jour vos instances.

Vous pouvez aussi trouver des zip sur cette page : https://github.com/EsupPortail/esup-smsu-api-mail/tags.


Déploiement de l'application api-mail

Le api-mail se déploie en mode servlet.

Créez src/main/resources/properties/config.properties en s'inspirant de config.sample.properties. Si vous utilisez git pour l'exploitation et la mise à jour, il est conseillé de faire :

Code Block
ln -s config.sample.properties src/main/resources/properties/config.properties
git add src/main/resources/properties/config.properties
git commit -m 'utiliser config.sample.properties comme base de configuration'

Il faut configurer les fichiers suivants :

  • src/main/resources/properties/config.properties
    • le paramétrage général de l'application.
  • src/main/resources/properties/logging/log4j.properties
    • Vérifier le chemin d'accès du fichier de log

Lancement simple avec jetty

Code Block
mvn jetty:run
# ou ant jetty.run

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 :

    Code Block
    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 :

    Code Block
    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 :

    Code Block
    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 :

    Code Block
    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 :

    Code Block
    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 :

    Code Block
    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 :

    Code Block
    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:

    Code Block
    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 :

    Code Block
    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 :

    Code Block
    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 :

    Code Block
    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 :

    Code Block
    smsuapi.ws.address=https://host.domain.fr:8081/
    

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

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

    Code Block
    smsuapimailquartz.mailToSmsTrigger.cronExpression=0/40 * * * * ?
    

    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.