4D Doc Center : IMAP

Home

4D Internet Commands v14

IMAP_VerifyID


IMAP_VerifyID ( imap_ID ) -> Function result

Parameter	Type	Description
imap_ID	Longint	Reference to this IMAP login
		0 = Connection has already closed
Function result	Integer	Error code

Description

An IMAP server will automatically terminate a connection which does not show activity in a period of time determined by its administrator. Each command that interacts with the IMAP server forces a reset of the inactivity timer. The IMAP_VerifyID command resets the inactivity timer for the specified IMAP connection without performing any other action. This allows the user to keep a connection active if the possibility exists that the connection may timeout.

When executed, the IMAP_VerifyID command will verify the connection has not already been closed. If the connection is still opened, the command will tell the IMAP server to reset the timeout counter for the connection back to zero. If the connection has already closed, IMAP_VerifyID will return the appropriate error and free memory used by the IMAP connection, and return a zero value back to imap_ID.

imap_ID is a long integer reference to an open connection created with IMAP_Login.