Imap

Imap

Type: classe globale

• Imap
  • new Imap(config)
  • .run()
  • .on(event, callback)
  • .deleteMails(mailboxPath, toDelete) ⇒ boolean
  • .seeMails(mailboxPath, toSee) ⇒ boolean
  • .unseeMails(mailboxPath, toUnsee) ⇒ boolean
  • .getUnseenMails(mailboxPath) ⇒ Array.<Mail>
  • .getSeenMails(mailboxPath) ⇒ Array.<Mail>
  • .getAllMails(mailboxPath) ⇒ Array.<Mail>
  • .getMailboxes() ⇒ Map.<string, Mailbox>

new Imap(config)

Attendre la méthode run() avant quelconque action sur cet objet.

Param	Type	Description
config	ImapConfig	Configuration de Imap

imap.run()

Lance le service IMAP Tu ne dois faire aucune action sur l'objet Imap avant d'avoir effectué cette méthode.

Type: méthode d'instance de Imap

imap.on(event, callback)

Utilise le callback quand un évènement est émis.

Type: méthode d'instance de Imap

Param	Type	Description
event	'newMail' / 'loadedMail' / 'deletedMail'	Évènement à écouter
callback	(mail) => void	Fonction callback à éxecuter quand l'évènement est émis

imap.deleteMails(mailboxPath, toDelete) ⇒ boolean

Supprimer des mails depuis leur uid ou l'objet Mail.

Type: méthode d'instance de Imap
Retourne: boolean - true si les mails ont été supprimés

Param	Type	Description
mailboxPath	string	Nom de la boîte mail où supprimer les mails
toDelete	UidsList	Mails ou uids à supprimer

imap.seeMails(mailboxPath, toSee) ⇒ boolean

Marque les mails comme vus depuis leur uid ou l'objet Mail.

Type: méthode d'instance de Imap
Retourne: boolean - true si les mails on été marqués comme vu

Param	Type	Description
mailboxPath	string	Nom de la boîte mail où supprimer les mails
toSee	UidsList	Mails ou uids à marquer comme vu

imap.unseeMails(mailboxPath, toUnsee) ⇒ boolean

Marque les mails comme non vus depuis leur uid ou l'objet Mail.

Type: méthode d'instance de Imap
Retourne: boolean - true si les mails sont marqués comme non vu

Param	Type	Description
mailboxPath	string	Nom de la boîte mail où supprimer les mails
toUnsee	UidsList	Mails ou uids à marquer comme non vu

imap.getUnseenMails(mailboxPath) ⇒ Array.<Mail>

Récupère la liste des mails non vu d'une boîte mail.

Type: méthode d'instance de Imap
Retourne: Array.<Mail> - Liste de mails

Param	Type	Description
mailboxPath	string	Nom de la boîte mail

imap.getSeenMails(mailboxPath) ⇒ Array.<Mail>

Récupère la liste des mails vus d'une boîte mail.

Type: méthode d'instance de Imap
Retourne: Array.<Mail> - Liste de mails

Param	Type	Description
mailboxPath	string	Nom de la boîte mail

imap.getAllMails(mailboxPath) ⇒ Array.<Mail>

Récupère tous les mails d'une boîte mail.

Type: méthode d'instance de Imap
Retourne: Array.<Mail> - Liste de mails

Param	Type	Description
mailboxPath	string	Nom de la boîte mail

imap.getMailboxes() ⇒ Map.<string, Mailbox>

Récupère la liste des boîtes mail.

Type: méthode d'instance de Imap
Retourne: Array.<Mail> - Map de Mailbox