Configurer les paramètres POP et IMAP avec l'API Gmail

Ce document explique comment gérer les protocoles POP et IMAP à l'aide de l'API Gmail.

Les protocoles POP et IMAP permettent tous deux de lire vos messages Gmail dans d'autres clients de messagerie. POP est un protocole plus ancien conçu pour un seul ordinateur. Avec POP, votre client télécharge les messages, et vous choisissez la fréquence à laquelle télécharger les nouveaux. IMAP fonctionne sur plusieurs appareils et synchronise les messages en temps réel.

Vous pouvez utiliser la ressource settings de l'API Gmail pour configurer la façon dont Gmail gère les protocoles POP et IMAP :

POP

Vous pouvez gérer les paramètres POP d'un compte à l'aide de l'objet PopSettings.

Activer et désactiver l'accès

Contrôlez l'accès avec le champ accessWindow. Ce champ détermine si le protocole POP est activé et quels messages l'API récupère.

Valeur Effet
disabled Aucun message n'est accessible via POP
allMail Tous les messages non récupérés sont accessibles via POP.
fromNowOn Seuls les nouveaux messages sont accessibles via POP.

Disposition des messages

Configurez la disposition des messages récupérés par l'API avec le champ disposition.

Valeur Effet
archive Déplacer des messages hors de INBOX
leaveInInbox Ne rien faire : laisser les messages non lus dans INBOX
markRead Laisser des messages dans INBOX et les marquer comme lus
trash Déplacer des messages vers TRASH

IMAP

Vous pouvez gérer les paramètres IMAP d'un compte à l'aide de l'objet ImapSettings.

Activer et désactiver l'accès

Utilisez le champ booléen enabled pour contrôler les accès. Ce champ détermine si IMAP est activé pour le compte.

Disposition des messages

Utilisez le champ expungeBehavior pour configurer le traitement d'un message lorsqu'un client le marque comme supprimé et le supprime du dernier dossier IMAP visible.

Valeur Effet
archive Retirer les messages marqués comme supprimés de la INBOX
deleteForever Supprimer définitivement les messages marqués comme supprimés
trash Déplacer les messages marqués comme supprimés vers la TRASH

Si le champ booléen autoExpunge est défini sur true, Gmail supprime immédiatement un message lorsqu'un client le marque comme supprimé dans IMAP. Sinon, les messages restent jusqu'à ce que le client IMAP demande explicitement leur suppression.