« Back to Product

Documentation

IMAP_GetCachedMails

Require: IP-Symcon >= 2.2

 array IMAP_GetCachedMails (int $InstanceID) 

Parameters

InstanceID

ID of the IMAP-Instance

Returns

If the command was executed successfully, it returns as its result an array of data to the cached emails, otherwise a Boolean with the value FALSE.

Description

The command returns an array containing information about the cached emails of an IMAP instance with ID InstanceID. Should the instance not exist, an alert is generated.

Example

print_r(IMAP_GetCachedMails(12345));

/* returns e.g.:
Array
(
    [0] => Array
    (
        [Date] => 1295756412
        [Flags] => SEEN
        [Recipient] => recipient@test.test
        [SenderAddress] => sender@test.test
        [SenderName] => Test Sender
        [Subject] => 3 2 1 Test
        [UID] => 1234
    )
)
*/
Any questions?