Function __global->find_mail_folders
Definitions
sources/mail2.php
- Find IMAP/POP3 folders.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: array
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $host | string | No | No | required parameter | N/A | N/A | The server hostname |
| $port | integer | No | No | required parameter | N/A | N/A | The port |
| $type | ?string | No | No | required parameter | imap imaps imaps_nocert pop3 pop3s pop3s_nocert | N/A | The protocol (null: autodetect) |
| $username | string | No | No | required parameter | N/A | N/A | The username |
| $password | string | No | No | required parameter | N/A | N/A | The password |
Returns
- Map of folders (codenames to display labels)
- Type: array
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Find IMAP/POP3 folders.
*
* @param string $host The server hostname
* @param integer $port The port
* @param ?string $type The protocol (null: autodetect)
* @set imap imaps imaps_nocert pop3 pop3s pop3s_nocert
* @param string $username The username
* @param string $password The password
* @return array Map of folders (codenames to display labels)
*/
function find_mail_folders(string $host, int $port, ?string $type, string $username, string $password) : array
* Find IMAP/POP3 folders.
*
* @param string $host The server hostname
* @param integer $port The port
* @param ?string $type The protocol (null: autodetect)
* @set imap imaps imaps_nocert pop3 pop3s pop3s_nocert
* @param string $username The username
* @param string $password The password
* @return array Map of folders (codenames to display labels)
*/
function find_mail_folders(string $host, int $port, ?string $type, string $username, string $password) : array
