What can we improve?

« Back to Product

Documentation

(Edit)

IMAP_GetMailEx

Require: IP-Symcon >= 2.2

 array IMAP_GetMailEx (int $InstanceID, string $UID)

Parameters

InstanceID

ID of teh IMAP-Instance
UID

UID of the email to be loaded

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

This command loads an email with the UID UID from the IMAP instance with ID InstanceID and returns an array containing the data of the e-mail. Should the instance or an e-mail with the given UID not exist, an alert is generated.

Example

print_r(IMAP_GetMailEx(12345, "1234"));

/* returns e.g.:
Array
(
    [ContentType] => text/plain
    [Date] => 1295756412
    [Flags] => SEEN
    [Recipient] => ips@test.test
    [SenderAddress] => sender@test.test
    [SenderName] => Test Sender
    [Subject] => 3 2 1 Test
    [Text] => This is a test!
    [UID] => 1234
)
*/