Skip to content

Commit 0593812

Browse files
WebklexWebklex
committed
Documentation extended
1 parent 781133d commit 0593812

File tree

1 file changed

+26
-25
lines changed

1 file changed

+26
-25
lines changed

‎README.md‎

Lines changed: 26 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -134,31 +134,32 @@ You can define your accounts inside the [config/imap.php](src/config/imap.php) f
134134

135135
## Documentation
136136
### [Client::class](src/IMAP/Client.php)
137-
| Method | Arguments | Return | Description |
138-
| --------------------- | ------------------------------------------------- | :------: | ---------------------------------------------------------------------------------------------------------------------------- |
139-
| setConfig | array $config | self | Set the Client configuration. Take a look at `config/imap.php` for more inspiration. |
140-
| getConnection | resource $connection | resource | Get the current imap resource |
141-
| setReadOnly | bool $readOnly | self | Set read only property and reconnect if it's necessary. |
142-
| setFetchOption | integer $option | self | Fail proof setter for $fetch_option |
143-
| isReadOnly | | bool | Determine if connection is in read only mode. |
144-
| isConnected | | bool | Determine if connection was established. |
145-
| checkConnection | | | Determine if connection was established and connect if not. |
146-
| connect | int $attempts | | Connect to server. |
147-
| disconnect | | | Disconnect from server. |
148-
| getFolders | bool $hierarchical, string or null $parent_folder | array | Get folders list. If hierarchical order is set to true, it will make a tree of folders, otherwise it will return flat array. |
149-
| openFolder | \Webklex\IMAP\Folder $folder | | Open a given folder. |
150-
| createFolder | string $name | | Create a new folder. |
151-
| getMessages | \Webklex\IMAP\Folder $folder, string $criteria | array | Get messages from folder. |
152-
| getUnseenMessages | \Webklex\IMAP\Folder $folder, string $criteria | array | Get Unseen messages from folder. |
153-
| getQuota | | array | Retrieve the quota level settings, and usage statics per mailbox |
154-
| getQuotaRoot | string $quota_root | array | Retrieve the quota settings per user |
155-
| countMessages | | int | Gets the number of messages in the current mailbox |
156-
| countRecentMessages | | int | Gets the number of recent messages in current mailbox |
157-
| getAlerts | | array | Returns all IMAP alert messages that have occurred |
158-
| getErrors | | array | Returns all of the IMAP errors that have occurred |
159-
| getLastError | | string | Gets the last IMAP error that occurred during this page request |
160-
| expunge | | bool | Delete all messages marked for deletion |
161-
| checkCurrentMailbox | | object | Check current mailbox |
137+
| Method | Arguments | Return | Description |
138+
| --------------------- | ----------------------------------------------------------------- | :------: | ---------------------------------------------------------------------------------------------------------------------------- |
139+
| setConfig | array $config | self | Set the Client configuration. Take a look at `config/imap.php` for more inspiration. |
140+
| getConnection | resource $connection | resource | Get the current imap resource |
141+
| setReadOnly | bool $readOnly | self | Set read only property and reconnect if it's necessary. |
142+
| setFetchOption | integer $option | self | Fail proof setter for $fetch_option |
143+
| isReadOnly | | bool | Determine if connection is in read only mode. |
144+
| isConnected | | bool | Determine if connection was established. |
145+
| checkConnection | | | Determine if connection was established and connect if not. |
146+
| connect | int $attempts | | Connect to server. |
147+
| disconnect | | | Disconnect from server. |
148+
| getFolder | string $folder_name, int $attributes = 32, int or null $delimiter | Folder | Get a Folder instance by name |
149+
| getFolders | bool $hierarchical, string or null $parent_folder | array | Get folders list. If hierarchical order is set to true, it will make a tree of folders, otherwise it will return flat array. |
150+
| openFolder | \Webklex\IMAP\Folder $folder | | Open a given folder. |
151+
| createFolder | string $name | | Create a new folder. |
152+
| getMessages | \Webklex\IMAP\Folder $folder, string $criteria | array | Get messages from folder. |
153+
| getUnseenMessages | \Webklex\IMAP\Folder $folder, string $criteria | array | Get Unseen messages from folder. |
154+
| getQuota | | array | Retrieve the quota level settings, and usage statics per mailbox |
155+
| getQuotaRoot | string $quota_root | array | Retrieve the quota settings per user |
156+
| countMessages | | int | Gets the number of messages in the current mailbox |
157+
| countRecentMessages | | int | Gets the number of recent messages in current mailbox |
158+
| getAlerts | | array | Returns all IMAP alert messages that have occurred |
159+
| getErrors | | array | Returns all of the IMAP errors that have occurred |
160+
| getLastError | | string | Gets the last IMAP error that occurred during this page request |
161+
| expunge | | bool | Delete all messages marked for deletion |
162+
| checkCurrentMailbox | | object | Check current mailbox |
162163

163164
### [Message::class](src/IMAP/Message.php)
164165
| Method | Arguments | Return | Description |

0 commit comments

Comments
 (0)