# IMAP

> Symcon documentation · English · generated on 2026-09-26  
> Index: https://www.symcon.de/en/llms.txt

Source: https://www.symcon.de/en/service/documentation/module-reference/notifications/imap/

_Requires Symcon >= 2.2_

The IMAP module can be configured using the configuration page within the [Object Tree](../components/management-console.md) of the [Management Console](../components/management-console.md). The parameters for host and port can be taken from the manual of the mail provider. The username and password are the login data for the e-mail account.

> **Warning:** Since October 2022 a connection to Microsoft 365 (outlook.office365.com) isn't supported. This is because of the only use of OAuth2 authentification supported by Microsoft.

To display the e-mails in the visualization, the interval must be set. It determines the cyclic request of the inbox. Only the subject line is requested. The complete e-mail will only be loaded when requested by the visualization.

On the variable "Last Message" can be determined if and when new mails arrive. If no e-mails are in the mailbox, the variable has the value 0. The "Unread Messages" variable returns the number of unread messages.

![IMAP Konfiguration](https://www.symcon.de/media/pages/service/dokumentation/modulreferenz/benachrichtigungen/imap/fecdcaf6fb-1790424938/imap-config-en.png)

| Property                 | Description                                                                                                 |
| ------------------------ | ----------------------------------------------------------------------------------------------------------- |
| Host                     | Server name or IP of email provider                                                                         |
| Port                     | Port, that is handled by the server                                                                         |
| Use SSL                  | Defines if SSL should be used                                                                               |
| Verify Peer              | Verify that hosts SSL certificate is correct (Only visible if Use SSL is active)                            |
| Verify Host              | Verify that host URL from the SSL certificate matches the property Host (Only visible if Use SSL is active) |
| Use Basic Authentication | Defines if a username password is required                                                                  |
| Username                 | Username                                                                                                    |
| Password                 | Password                                                                                                    |
| Interval                 | Number of seconds in which the inbox is requested                                                           |

> **Note:** An overview for host, port, and authentication for many providers can be found here: [Table](https://www.arclab.com/en/kb/email/list-of-smtp-and-imap-servers-mailserver-list.html)

## IMAP_DeleteMail

Source: https://www.symcon.de/en/service/documentation/module-reference/notifications/imap/imap-deletemail/

`bool IMAP_DeleteMail(int $InstanceID, string $UID)`

_Requires Symcon >= 5.0_

deletes a mail with a specific e-mail(UID)

**Parameters**

- `$InstanceID` (int): ID of the IMAP-Instance
- `$UID` (string): UID of the email to be deleted

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

UID of the email to be deleted

**Example**

```php
// Deletes the mail with the e-mail(UID) 1234
IMAP_DeleteMail (12345, "1234"));
```

## IMAP_GetCachedMails

Source: https://www.symcon.de/en/service/documentation/module-reference/notifications/imap/imap-getcachedmails/

`array IMAP_GetCachedMails(int $InstanceID)`

_Requires Symcon >= 2.2_

**Parameters**

- `$InstanceID` (int): ID of the IMAP-Instance

**Returns** (array): 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__.

ID of the IMAP-Instance

**Example**

```php
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
    )
)
*/
```

## IMAP_GetMailEx

Source: https://www.symcon.de/en/service/documentation/module-reference/notifications/imap/imap-getmailex/

`array IMAP_GetMailEx(int $InstanceID, string $UID)`

_Requires Symcon >= 2.2_

**Parameters**

- `$InstanceID` (int): ID of teh IMAP-Instance
- `$UID` (string): UID of the email to be loaded

**Returns** (array): 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__.

UID of the email to be loaded

**Example**

```php
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
)
*/
```