« Back to Product

Documentation

POP3_GetMailEx

Require: IP-Symcon >= 2.2

 array POP3_GetMailEx (int $InstanceID, string $UID) 

Parameters

InstanceID

ID of POP3-Instance

UID

UID of the email to be loaded

Returns

If the command was executed successfully, it returns the result in an array with data from the e-mail, otherwise a Boolean with FALSE.

Description

This command loads an email with the UID UID from POP3 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(POP3_GetMailEx(12345, "1234"));

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