Share this page
imap_check
| Example: imap_check | Internet Messaging Functions (IMAP) |
Requests a checkpoint.
int imap_check( char *transaction );
| transaction | A transaction name for this step in quotes. To avoid creating a transaction for this step, use a NULL string, "". |
The imap_check function requests a checkpoint in the current mailbox. A checkpoint refers to any implementation-dependent housekeeping applied internally to the mailbox.
This housekeeping is not normally executed as part of each command. For example, a possible checkpoint is resolving the server's in-memory state of the mailbox, with the state on its disk. If a server implementation has no housekeeping considerations, this command is equivalent to imap_noop. Note that performing a check may not be instantaneous.
This function is for use with global sessions. For multiple sessions, use the imap_check_ex function, which allows you to specify a session identifier.
Return Values
If this function succeeds, it returns LR_PASS. Otherwise, it returns LR_FAIL.
Parameterization
Standard parameterization is not available for this function.
