IMAPNotifier

The IMAPNotifier class allows you to manage IMAP IDLE notifications for a selected mailbox.

Historique

Release	Modifications
21 R3	Classe ajoutée

The IMAPNotifier class is available from the 4D class store.

An IMAPNotifier object is associated with an IMAP transporter and provides access to mailbox notification management.

All IMAPNotifier class functions are thread-safe.

Article de blog lié

Instant Email Notifications with IMAP Transporter

Exemple

// Define listener callbacks
var $parameter : Object
var $transporter : 4D.IMAPTransporter

$parameter:=New object
$parameter.authenticationMode:=IMAP authentication OAUTH2
$parameter.host:="Outlook.office365.com"
$parameter.port:=993
$parameter.accessTokenOAuth2:=$myToken
$parameter.user:="myaddress@email.com"
$parameter.listener:=cs.IMAPListener.new()

$transporter:=IMAP New transporter($parameter)
$transporter.selectBox("INBOX")

$transporter.notifier.start()     

IMAPNotifier object

An IMAPNotifier object provides the following properties and functions:

.isStarted : Boolean indicates whether the notifier is started (true) or stopped (false)
.start() : Object starts the subscription to server notifications and activates IMAP listener callbacks
.stop() : Object stops the notification subscription

4D.IMAPNotifier.new()

4D.IMAPNotifier.new() : 4D.IMAPNotifier

Paramètres	Type		Description
Résultat	4D.IMAPNotifier	<-	New IMAPNotifier object

Description

The 4D.IMAPNotifier.new() function creates a new IMAPNotifier object.

.isStarted

.isStarted : Boolean

Description

The .isStarted property indicates whether the notifier is started (true) or stopped (false). Cette propriété est en lecture seule.

.start()

.start() : Object

Paramètres	Type		Description
Résultat	Object	<-	Operation status

Description

The .start() function starts the subscription to server notifications and activates IMAP listener callbacks.

A mailbox must be selected using selectBox() before calling .start().

Callback functions are executed in the worker where .start() is called.

Notes

• When the notifier is started, other transporter functions (such as getMail() or send()) are not available. You must call .stop() before using these functions, then call .start() again to resume notifications.

• IMAP IDLE notifications indicate that a change has occurred but do not provide updated mailbox data. To refresh the mailbox state, you must stop the notifier, retrieve the updated data (for example using getMail()), and then restart it.

Objet retourné

Propriété		Type	Description
success		Boolean	Vrai si l'opération est réussie, sinon Faux
statusText		Text	Message du statut retourné par le serveur IMAP, ou dernière erreur retournée dans la pile d'erreurs 4D
errors		Collection	4D error stack (not returned if a server response is received)
	[].errcode	Number	Code d'erreur 4D
	[].message	Text	Description de l'erreur
	[].componentSignature	Text	Signature of the component that returned the error

.stop()

.stop() : Object

Paramètres	Type		Description
Résultat	Object	<-	Operation status

Description

The .stop() function stops the notification subscription. Calling .stop() is required before using other transporter functions (such as getMail() or send()).

Objet retourné

Propriété		Type	Description
success		Boolean	Vrai si l'opération est réussie, sinon Faux
statusText		Text	Message du statut retourné par le serveur IMAP, ou dernière erreur retournée dans la pile d'erreurs 4D
errors		Collection	4D error stack (not returned if a server response is received)
	[].errcode	Number	Code d'erreur 4D
	[].message	Text	Description de l'erreur
	[].componentSignature	Text	Signature of the component that returned the error