Skip to content

Commit 2da6031

Browse files
committed
namespaces updated
1 parent 713527e commit 2da6031

File tree

1 file changed

+44
-44
lines changed

1 file changed

+44
-44
lines changed

README.md

Lines changed: 44 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -197,50 +197,50 @@ $aFolder = $oClient->getFolders();
197197
#### Search for messages
198198
Search for specific emails:
199199
``` php
200-
/** @var \Webklex\IMAP\Folder $oFolder */
200+
/** @var \Webklex\PHPIMAP\Folder $oFolder */
201201

202202
//Get all messages
203-
/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
203+
/** @var \Webklex\PHPIMAP\Support\MessageCollection $aMessage */
204204
$aMessage = $oFolder->query()->all()->get();
205205

206206
//Get all messages from [email protected]
207-
/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
207+
/** @var \Webklex\PHPIMAP\Support\MessageCollection $aMessage */
208208
$aMessage = $oFolder->query()->from('[email protected]')->get();
209209

210210
//Get all messages since march 15 2018
211-
/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
211+
/** @var \Webklex\PHPIMAP\Support\MessageCollection $aMessage */
212212
$aMessage = $oFolder->query()->since('15.03.2018')->get();
213213

214214
//Get all messages within the last 5 days
215-
/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
215+
/** @var \Webklex\PHPIMAP\Support\MessageCollection $aMessage */
216216
$aMessage = $oFolder->query()->since(now()->subDays(5))->get();
217217
//Or for older laravel versions..
218218
$aMessage = $oFolder->query()->since(\Carbon::now()->subDays(5))->get();
219219

220220
//Get all messages containing "hello world"
221-
/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
221+
/** @var \Webklex\PHPIMAP\Support\MessageCollection $aMessage */
222222
$aMessage = $oFolder->query()->text('hello world')->get();
223223

224224
//Get all unseen messages containing "hello world"
225-
/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
225+
/** @var \Webklex\PHPIMAP\Support\MessageCollection $aMessage */
226226
$aMessage = $oFolder->query()->unseen()->text('hello world')->get();
227227

228228
//Extended custom search query for all messages containing "hello world"
229229
//and have been received since march 15 2018
230-
/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
230+
/** @var \Webklex\PHPIMAP\Support\MessageCollection $aMessage */
231231
$aMessage = $oFolder->query()->text('hello world')->since('15.03.2018')->get();
232232
$aMessage = $oFolder->query()->Text('hello world')->Since('15.03.2018')->get();
233233
$aMessage = $oFolder->query()->whereText('hello world')->whereSince('15.03.2018')->get();
234234

235235
// Build a custom search query
236-
/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
236+
/** @var \Webklex\PHPIMAP\Support\MessageCollection $aMessage */
237237
$aMessage = $oFolder->query()
238238
->where([['TEXT', 'Hello world'], ['SINCE', \Carbon::parse('15.03.2018')]])
239239
->get();
240240

241241
//!EXPERIMENTAL!
242242
//Get all messages NOT containing "hello world"
243-
/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
243+
/** @var \Webklex\PHPIMAP\Support\MessageCollection $aMessage */
244244
$aMessage = $oFolder->query()->notText('hello world')->get();
245245
$aMessage = $oFolder->query()->not_text('hello world')->get();
246246
$aMessage = $oFolder->query()->not()->text('hello world')->get();
@@ -249,11 +249,11 @@ $aMessage = $oFolder->query()->not()->text('hello world')->get();
249249
Available search aliases for a better code reading:
250250
``` php
251251
// Folder::search() is just an alias for Folder::query()
252-
/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
252+
/** @var \Webklex\PHPIMAP\Support\MessageCollection $aMessage */
253253
$aMessage = $oFolder->search()->text('hello world')->since('15.03.2018')->get();
254254

255255
// Folder::messages() is just an alias for Folder::query()
256-
/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
256+
/** @var \Webklex\PHPIMAP\Support\MessageCollection $aMessage */
257257
$aMessage = $oFolder->messages()->text('hello world')->since('15.03.2018')->get();
258258

259259
```
@@ -296,20 +296,20 @@ Further information:
296296
#### Result limiting
297297
Limiting the request emails:
298298
``` php
299-
/** @var \Webklex\IMAP\Folder $oFolder */
299+
/** @var \Webklex\PHPIMAP\Folder $oFolder */
300300

301301
//Get all messages for page 2 since march 15 2018 where each apge contains 10 messages
302-
/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
302+
/** @var \Webklex\PHPIMAP\Support\MessageCollection $aMessage */
303303
$aMessage = $oFolder->query()->since('15.03.2018')->limit(10, 2)->get();
304304
```
305305

306306
#### Counting messages
307307
Count all available messages matching the current search criteria:
308308
``` php
309-
/** @var \Webklex\IMAP\Folder $oFolder */
309+
/** @var \Webklex\PHPIMAP\Folder $oFolder */
310310

311311
//Count all messages
312-
/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
312+
/** @var \Webklex\PHPIMAP\Support\MessageCollection $aMessage */
313313
$count = $oFolder->query()->all()->count();
314314

315315
//Count all messages since march 15 2018
@@ -319,21 +319,21 @@ $count = $oFolder->query()->since('15.03.2018')->count();
319319
#### Pagination
320320
Paginate a query:
321321
``` php
322-
/** @var \Webklex\IMAP\Folder $oFolder */
322+
/** @var \Webklex\PHPIMAP\Folder $oFolder */
323323

324324
/** @var \Illuminate\Pagination\LengthAwarePaginator $paginator */
325325
$paginator = $oFolder->query()->since('15.03.2018')->paginate();
326326
```
327327
Paginate a message collection:
328328
``` php
329-
/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
329+
/** @var \Webklex\PHPIMAP\Support\MessageCollection $aMessage */
330330

331331
/** @var \Illuminate\Pagination\LengthAwarePaginator $paginator */
332332
$paginator = $aMessage->paginate();
333333
```
334334
View example for a paginated list:
335335
``` php
336-
/** @var \Webklex\IMAP\Folder $oFolder */
336+
/** @var \Webklex\PHPIMAP\Folder $oFolder */
337337

338338
/** @var \Illuminate\Pagination\LengthAwarePaginator $paginator */
339339
$paginator = $oFolder->search()
@@ -380,72 +380,72 @@ You can find a few blade examples under [/examples](https://github.com/Webklex/p
380380
#### Fetch a specific message
381381
Get a specific message by uid (Please note that the uid is not unique and can change):
382382
``` php
383-
/** @var \Webklex\IMAP\Folder $oFolder */
383+
/** @var \Webklex\PHPIMAP\Folder $oFolder */
384384

385-
/** @var \Webklex\IMAP\Message $oMessage */
385+
/** @var \Webklex\PHPIMAP\Message $oMessage */
386386
$oMessage = $oFolder->getMessage($uid = 1);
387387
```
388388

389389
#### Message flags
390390
Flag or "unflag" a message:
391391
``` php
392-
/** @var \Webklex\IMAP\Message $oMessage */
392+
/** @var \Webklex\PHPIMAP\Message $oMessage */
393393
$oMessage->setFlag(['Seen', 'Spam']);
394394
$oMessage->unsetFlag('Spam');
395395
```
396396

397397
Mark all messages as "read" while fetching:
398398
``` php
399-
/** @var \Webklex\IMAP\Folder $oFolder */
400-
/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
399+
/** @var \Webklex\PHPIMAP\Folder $oFolder */
400+
/** @var \Webklex\PHPIMAP\Support\MessageCollection $aMessage */
401401
$aMessage = $oFolder->query()->text('Hello world')->markAsRead()->get();
402402
```
403403

404404
Don't mark all messages as "read" while fetching:
405405
``` php
406-
/** @var \Webklex\IMAP\Folder $oFolder */
407-
/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
406+
/** @var \Webklex\PHPIMAP\Folder $oFolder */
407+
/** @var \Webklex\PHPIMAP\Support\MessageCollection $aMessage */
408408
$aMessage = $oFolder->query()->text('Hello world')->leaveUnread()->get();
409409
```
410410

411411
#### Attachments
412412
Save message attachments:
413413
``` php
414-
/** @var \Webklex\IMAP\Message $oMessage */
414+
/** @var \Webklex\PHPIMAP\Message $oMessage */
415415

416-
/** @var \Webklex\IMAP\Support\AttachmentCollection $aAttachment */
416+
/** @var \Webklex\PHPIMAP\Support\AttachmentCollection $aAttachment */
417417
$aAttachment = $oMessage->getAttachments();
418418

419419
$aAttachment->each(function ($oAttachment) {
420-
/** @var \Webklex\IMAP\Attachment $oAttachment */
420+
/** @var \Webklex\PHPIMAP\Attachment $oAttachment */
421421
$oAttachment->save();
422422
});
423423
```
424424

425425
#### Advanced fetching
426426
Fetch messages without body fetching (decrease load):
427427
``` php
428-
/** @var \Webklex\IMAP\Folder $oFolder */
428+
/** @var \Webklex\PHPIMAP\Folder $oFolder */
429429

430-
/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
430+
/** @var \Webklex\PHPIMAP\Support\MessageCollection $aMessage */
431431
$aMessage = $oFolder->query()->whereText('Hello world')->setFetchBody(false)->get();
432432

433-
/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
433+
/** @var \Webklex\PHPIMAP\Support\MessageCollection $aMessage */
434434
$aMessage = $oFolder->query()->whereAll()->setFetchBody(false)->setFetchAttachment();
435435
```
436436

437437
Fetch messages without body, flag and attachment fetching (decrease load):
438438
``` php
439-
/** @var \Webklex\IMAP\Folder $oFolder */
439+
/** @var \Webklex\PHPIMAP\Folder $oFolder */
440440

441-
/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
441+
/** @var \Webklex\PHPIMAP\Support\MessageCollection $aMessage */
442442
$aMessage = $oFolder->query()->whereText('Hello world')
443443
->setFetchFlags(false)
444444
->setFetchBody(false)
445445
->setFetchAttachment(false)
446446
->get();
447447

448-
/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
448+
/** @var \Webklex\PHPIMAP\Support\MessageCollection $aMessage */
449449
$aMessage = $oFolder->query()->whereAll()
450450
->setFetchFlags(false)
451451
->setFetchBody(false)
@@ -460,16 +460,16 @@ The masked instance has to be called manually and is designed to add custom func
460460

461461
You can call the default mask by calling the mask method without any arguments.
462462
``` php
463-
/** @var \Webklex\IMAP\Message $oMessage */
463+
/** @var \Webklex\PHPIMAP\Message $oMessage */
464464
$mask = $oMessage->mask();
465465
```
466466

467467
There are several methods available to set the default mask:
468468
``` php
469-
/** @var \Webklex\IMAP\Client $oClient */
470-
/** @var \Webklex\IMAP\Message $oMessage */
469+
/** @var \Webklex\PHPIMAP\Client $oClient */
470+
/** @var \Webklex\PHPIMAP\Message $oMessage */
471471

472-
$message_mask = \Webklex\IMAP\Support\Masks\MessageMask::class;
472+
$message_mask = \Webklex\PHPIMAP\Support\Masks\MessageMask::class;
473473

474474
$oClient->setDefaultMessageMask($message_mask);
475475
$oMessage->setMask($message_mask);
@@ -481,9 +481,9 @@ You could also set the default masks inside your `config/imap.php` file under `m
481481

482482
You can also apply a mask on [attachments](#attachmentclass):
483483
``` php
484-
/** @var \Webklex\IMAP\Client $oClient */
485-
/** @var \Webklex\IMAP\Attachment $oAttachment */
486-
$attachment_mask = \Webklex\IMAP\Support\Masks\AttachmentMask::class;
484+
/** @var \Webklex\PHPIMAP\Client $oClient */
485+
/** @var \Webklex\PHPIMAP\Attachment $oAttachment */
486+
$attachment_mask = \Webklex\PHPIMAP\Support\Masks\AttachmentMask::class;
487487

488488
$oClient->setDefaultAttachmentMask($attachment_mask);
489489
$oAttachment->setMask($attachment_mask);
@@ -494,8 +494,8 @@ If you want to implement your own mask just extend [MessageMask::class](#message
494494
or [Mask::class](#maskclass) and implement your desired logic:
495495

496496
``` php
497-
/** @var \Webklex\IMAP\Message $oMessage */
498-
class CustomMessageMask extends \Webklex\IMAP\Support\Masks\MessageMask {
497+
/** @var \Webklex\PHPIMAP\Message $oMessage */
498+
class CustomMessageMask extends \Webklex\PHPIMAP\Support\Masks\MessageMask {
499499

500500
/**
501501
* New custom method which can be called through a mask

0 commit comments

Comments
 (0)