Skip to content

Commit b79d44c

Browse files
WebklexWebklex
committed
New methods added & version changes documented
1 parent 54698e7 commit b79d44c

File tree

2 files changed

+37
-23
lines changed

2 files changed

+37
-23
lines changed

‎CHANGELOG.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,19 @@ Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) princip
1010
### Affected Classes
1111
-NaN-
1212

13+
## [1.0.3.1] - 2017-09-05
14+
### Added
15+
-getConnection method added
16+
-Using a bit more fail save uid / msgNo by calling imap_msgno()
17+
18+
### Affected Classes
19+
\Webklex\IMAP\Client
20+
\Webklex\IMAP\Message
21+
22+
## [1.0.3.0] - 2017-09-01
23+
### Changes
24+
-Carbon dependency removed
25+
1326
## [1.0.2.12] - 2017-08-27
1427
### Added
1528
-Fixing text attachment issue - overwrite mail body (thx to radicalloop)

‎README.md‎

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -135,29 +135,30 @@ You can define your accounts inside the `config/imap.php` file:
135135

136136
## Documentation
137137
### [Client::class](src/IMAP/Client.php)
138-
| Method | Arguments | Return | Description |
139-
| --------------------- | ------------------------------------------------- | :-----: | ---------------------------------------------------------------------------------------------------------------------------- |
140-
| setConfig | array $config | self | Set the Client configuration. Take a look at `config/imap.php` for more inspiration. |
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-
| getQuota | | array | Retrieve the quota level settings, and usage statics per mailbox |
153-
| getQuotaRoot | string $quota_root | array | Retrieve the quota settings per user |
154-
| countMessages | | int | Gets the number of messages in the current mailbox |
155-
| countRecentMessages | | int | Gets the number of recent messages in current mailbox |
156-
| getAlerts | | array | Returns all IMAP alert messages that have occurred |
157-
| getErrors | | array | Returns all of the IMAP errors that have occurred |
158-
| getLastError | | string | Gets the last IMAP error that occurred during this page request |
159-
| expunge | | bool | Delete all messages marked for deletion |
160-
| checkCurrentMailbox | | object | Check current mailbox |
138+
| Method | Arguments | Return | Description |
139+
| --------------------- | ------------------------------------------------- | :------: | ---------------------------------------------------------------------------------------------------------------------------- |
140+
| setConfig | array $config | self | Set the Client configuration. Take a look at `config/imap.php` for more inspiration. |
141+
| getConnection | resource $connection | resource | Get the current imap resource |
142+
| setReadOnly | bool $readOnly | self | Set read only property and reconnect if it's necessary. |
143+
| setFetchOption | integer $option | self | Fail proof setter for $fetch_option |
144+
| isReadOnly | | bool | Determine if connection is in read only mode. |
145+
| isConnected | | bool | Determine if connection was established. |
146+
| checkConnection | | | Determine if connection was established and connect if not. |
147+
| connect | int $attempts | | Connect to server. |
148+
| disconnect | | | Disconnect from server. |
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+
| 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 |
161162

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

0 commit comments

Comments
 (0)