Utilisation de l'API JavaMail [40 mn de lecture - paru le 9/4/2003 - Public : Débutant]

Auteur

Julie MUESSER Elève-Ingénieur Supinfo Paris Promotion SUPINFO 2005    Lui écrire    Tous les projets de cet auteur    Le mini-CV de cet auteur

2. Présentation des classes importantes de l’API JavaMail

2.1 La classe Session

La classe Session établit la connexion avec le serveur de mail. C'est elle qui encapsule les données liées à la connexion (options de configuration et données d'authentification : login, password, nom du serveur).

C'est à partir d'un objet Session que toutes les actions concernant les mails sont réalisées. En effet, avant n'importe quelle action, il faut récupérer une Session.

Une session peut être unique ou partagée par plusieurs entités.

Pour créer ces sessions on utilise les méthodes :

getInstance( Properties, Authenticator) : session unique
getDefaultInstance(Properties, Authenticator ) : session partagée

Pour obtenir une session, deux paramètres sont attendus :

Un objet Properties qui contient les paramètres d'initialisation. Un tel objet est obligatoire
Un objet Authenticator optionnel qui permet d'authentifier l'utilisateur auprès du serveur de mail.

La méthode setDebug() qui attend en paramètre un booléen est très pratique pour debugger car avec le paramètre true, elle affiche des informations lors de l'utilisation de la session notamment le détail des commandes envoyées au serveur de mail.

2.2 La classe Message

La classe Message est une classe abstraite qui encapsule un message.

Lorsque vous avez votre objet Session, le message peut être créé.

Avant de commencer, il faut savoir qu'un message est composé de deux parties :

Une en-tête qui contient un ensemble d'attributs (auteur, destinataire, sujet ...)

Ces attributs peuvent être:

TO : Adresse Internet du destinataire
FROM : Adresse Internet de l’expéditeur
Date : date et heure de l’expédition
Subject : Le sujet du message
Message-ID : numéro d’identification du message

Un corps qui contient les données à envoyer (contenu)

Pour la plupart de ces données, la classe Message implémente l'interface Part qui encapsule les attributs nécessaires à la distribution du message (auteur, destinataire, sujet ...) et le corps du message.

Le contenu du message est stocké sous forme d'octets.
Pour accéder à son contenu, il faut utiliser un objet du JavaBean Activation Framework (JAF) : DataHandler.
Ceci permet une séparation des données nécessaires à la transmission et du contenu du message. Ce dernier peut ainsi prendre n'importe quel format.( texte, Html, image ....)

La classe Message ne connaît pas directement le type du contenu du corps du message.
JavaMail fournit en standard une classe fille nommée MimeMessage pour les messages possédant un type MIME.
Il y a deux façons d'obtenir un objet de type Message : instancier un objet de type MimeMessage pour créer un nouveau message ou utiliser un objet de type Folder pour obtenir un message existant.

La classe Message définie deux constructeurs en plus du constructeur par défaut :

La classe Message possède de nombreuses méthodes pour initialiser les données du message :

La méthode setText() permet de facilement mettre une chaîne de caractères dans le corps du message avec un type MIME « text/plain ». (voir définition du protocole chapitre 1)
Pour envoyer un message dans un format différent, par exemple HTML, il utilise la méthode setContent() qui prend en paramètre un objet et un chaîne qui contient le type MIME du message.

MultiPart Message : Un message peut contenir plusieurs objets, dans ce cas l'objet DataHandler contient un objet Multipart.
Cet objet à son tour contient des objets BodyPart. La structure d'un objet BodyPart ressemble à celle d'un simple objet Message. Donc chaque objet BodyPart contient des attributs et un contenu.

Vous retrouverez l'utilisation de ces différents points au chapitre suivant.

2.3 La classe Transport

La classe Transport se charge d'envoyer le message avec le protocole adéquat grâce à sa méthode send(). C'est une classe abstraite.
Il est possible d'obtenir un objet Transport dédié au protocole particulier utilisé par la session en utilisant la méthode getTransport() d'un objet Session. Dans ce cas, il faut :

1. Etablir la connexion en utilisant la méthode connect() avec le nom du serveur, le nom de l'utilisateur et son mot de passe

2. envoyer le message en utilisant la méthode sendMessage() avec le message et les destinataires. La méthode getAllRecipients() de la classe message permet d'obtenir ceux contenus dans le message.

3. fermer la connexion en utilisant la méthode close()

Il est préférable d'utiliser une instance de Transport tel qu'expliqué ci dessus lorsqu'il y a plusieurs mails à envoyer car on peut maintenir a connexion avec le serveur ouverte pendant les envois.

La méthode static send() ouvre et ferme la connexion à chacun de ces appels.

2.4 La classe Adress

La classe Address est une classe abstraite dont héritent toutes les classes qui encapsulent une adresse dans un message. Deux classes filles sont actuellement définies :

InternetAddress
NewsAddress

Un objet InternetAddress est nécessaire pour chaque émetteur et destinataire de mail.
Cependant JavaMail ne vérifie pas l’existence des adresses, c’est le serveur mail qui s’en chargera.

Pour créer une adresse mail, il suffit de passer cette adresse au constructeur :

Si vous désirez que le nom apparaisse à coté de l’adresse mail, il suffit de passer au constructeur, l’adresse et le nom:

Vous devez aussi précisez l’adresse de l’expéditeur du message. Pour identifier cet expéditeur, on peut utiliser les méthodes setFrom() et setReplyTo() de la classe Message.

Si votre message doit montrer plusieurs adresses d’expéditeur, alors on utilise la méthode addFrom() en passant en paramètre un tableau d’adresse :

Il existe trois types prédéfinis de la classe Adress:

Message.RecipientType.TO : destinataire direct
Message.RecipientType.CC : copie conforme
Message.RecipientType.BCC : copie cachée

Ainsi la méthode addRecipient() permet de préciser, le destinataire et le type d’envoi.

La classe NewsAddress encapsule une adresse news (forum de discussion) respectant le format RFC1036. Elle contient deux champs : host qui contient le nom du serveur et newsgroup qui le nom du forum.

2.5 Les classes Store et Folder

Pour se connecter à cette « messagerie » et ainsi pourvoir consulter vos messages, vous devez obtenir une instance de la classe Store avec la méthode getStore() de votre session, en lui donnant comme paramètre le protocole utilisé.

Ensuite vous n’avez plus qu’a vous connecter avec la méthode connect(), en lui précisant le nom du serveur, le nom d'utilisateur et le mot de passe.

La méthode close() permet de libérer la connexion avec le serveur.

La classe abstraite Folder représente un répertoire dans lequel les messages sont stockés.
Pour obtenir un instance de cette classe, il faut utiliser la méthode getFolder() d'un objet de type Store en lui précisant le nom du répertoire. Le protocole « POP3 » ne gère qu'un seul répertoire « INBOX ».

Si vous utilisez le protocole “ IMAP”, vous pouvez alors avoir d’autres répertoires.

Ensuite, on appelle la méthode open() en précisant le mode d'utilisation : READ_ONLY ou READ_WRITE.

READ_ONLY donne les droits de lecture au répertoire alors que le mode READ_WRITE permet la lecture et la modification.

Pour obtenir les messages contenus dans le répertoire, il faut appeler la méthode getMessages().
Cette méthode renvoie un tableau de Message qui peut être null si aucun message n'est renvoyé.

Une fois les opérations terminées, il faut fermer le répertoire en utilisant la méthode close(). folder.close();

2.6 La classe Authenticator

La classe Authenticator est une classe abstraite qui contient des méthodes afin d’authentifier un utilisateur.
Pour l’utiliser on devra créer une classe fille qui se chargera de collecter les informations.

Voici les méthodes ce cette classe :

L’objet Authentificator est enregistré avec la session quand celle-ci est crée.
L’Authentification ne sera pas toujours nécessaire c’est pourquoi dans les autres exemples, nous avons toujours passé en paramètre "null".

Pour obtenir les informations(login et mots de passe), vous pouvez très bien ouvrir une popup afin de se renseigner sur l’utilisateur ou bien lire les informations dans un fichier de configuration et ainsi retourner l’objet PasswordAuthentication

2.7 L'interface Part

L’interface Part est très importante. En effet, les classes Message et BodyPart implémentent cette interface.
Elle définie des attributs et un contenu.

Voyons les méthodes qu’elle contient :

2.8 Les propriétés d'environnement

Cette partie va permettre de lister les propriétés d’environnement utilisées par JavaMail.
Ces propriétés sont stockées dans un objet Properties.