Function __global->_find_mail_bounces
Definitions
sources/mail2.php
- Find bounces in an IMAP/POP3 folder.
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: array
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $host | string | required parameter | N/A | N/A | The server hostname |
| $port | integer | required parameter | N/A | N/A | The port |
| $type | string | required parameter | N/A | N/A | The protocol |
| $folder | string | required parameter | N/A | N/A | The inbox identifier |
| $username | string | required parameter | N/A | N/A | The username |
| $password | string | required parameter | N/A | N/A | The password |
| $bounces_only | boolean | True | N/A | N/A | Only find bounces (otherwise will find anything) |
| $since | ?TIME | Null | N/A | N/A | Only find bounces since this date (null: no limit). This is approximate, we will actually look from a bit further back to compensate for possible timezone differences |
Return
- Bounces (a map between email address and details of the bounce)
- Type: array
- Set: N/A
- Range: N/A