@@ -197,50 +197,50 @@ $aFolder = $oClient->getFolders();
197
197
#### Search for messages
198
198
Search for specific emails:
199
199
``` php
200
- /** @var \Webklex\IMAP \Folder $oFolder */
200
+ /** @var \Webklex\PHPIMAP \Folder $oFolder */
201
201
202
202
//Get all messages
203
- /** @var \Webklex\IMAP \Support\MessageCollection $aMessage */
203
+ /** @var \Webklex\PHPIMAP \Support\MessageCollection $aMessage */
204
204
$aMessage = $oFolder->query()->all()->get();
205
205
206
206
//Get all messages from
[email protected]
207
- /** @var \Webklex\IMAP \Support\MessageCollection $aMessage */
207
+ /** @var \Webklex\PHPIMAP \Support\MessageCollection $aMessage */
208
208
$aMessage = $oFolder->query()->from('
[email protected] ')->get();
209
209
210
210
//Get all messages since march 15 2018
211
- /** @var \Webklex\IMAP \Support\MessageCollection $aMessage */
211
+ /** @var \Webklex\PHPIMAP \Support\MessageCollection $aMessage */
212
212
$aMessage = $oFolder->query()->since('15.03.2018')->get();
213
213
214
214
//Get all messages within the last 5 days
215
- /** @var \Webklex\IMAP \Support\MessageCollection $aMessage */
215
+ /** @var \Webklex\PHPIMAP \Support\MessageCollection $aMessage */
216
216
$aMessage = $oFolder->query()->since(now()->subDays(5))->get();
217
217
//Or for older laravel versions..
218
218
$aMessage = $oFolder->query()->since(\Carbon::now()->subDays(5))->get();
219
219
220
220
//Get all messages containing "hello world"
221
- /** @var \Webklex\IMAP \Support\MessageCollection $aMessage */
221
+ /** @var \Webklex\PHPIMAP \Support\MessageCollection $aMessage */
222
222
$aMessage = $oFolder->query()->text('hello world')->get();
223
223
224
224
//Get all unseen messages containing "hello world"
225
- /** @var \Webklex\IMAP \Support\MessageCollection $aMessage */
225
+ /** @var \Webklex\PHPIMAP \Support\MessageCollection $aMessage */
226
226
$aMessage = $oFolder->query()->unseen()->text('hello world')->get();
227
227
228
228
//Extended custom search query for all messages containing "hello world"
229
229
//and have been received since march 15 2018
230
- /** @var \Webklex\IMAP \Support\MessageCollection $aMessage */
230
+ /** @var \Webklex\PHPIMAP \Support\MessageCollection $aMessage */
231
231
$aMessage = $oFolder->query()->text('hello world')->since('15.03.2018')->get();
232
232
$aMessage = $oFolder->query()->Text('hello world')->Since('15.03.2018')->get();
233
233
$aMessage = $oFolder->query()->whereText('hello world')->whereSince('15.03.2018')->get();
234
234
235
235
// Build a custom search query
236
- /** @var \Webklex\IMAP \Support\MessageCollection $aMessage */
236
+ /** @var \Webklex\PHPIMAP \Support\MessageCollection $aMessage */
237
237
$aMessage = $oFolder->query()
238
238
->where([['TEXT', 'Hello world'], ['SINCE', \Carbon::parse('15.03.2018')]])
239
239
->get();
240
240
241
241
//!EXPERIMENTAL!
242
242
//Get all messages NOT containing "hello world"
243
- /** @var \Webklex\IMAP \Support\MessageCollection $aMessage */
243
+ /** @var \Webklex\PHPIMAP \Support\MessageCollection $aMessage */
244
244
$aMessage = $oFolder->query()->notText('hello world')->get();
245
245
$aMessage = $oFolder->query()->not_text('hello world')->get();
246
246
$aMessage = $oFolder->query()->not()->text('hello world')->get();
@@ -249,11 +249,11 @@ $aMessage = $oFolder->query()->not()->text('hello world')->get();
249
249
Available search aliases for a better code reading:
250
250
``` php
251
251
// Folder::search() is just an alias for Folder::query()
252
- /** @var \Webklex\IMAP \Support\MessageCollection $aMessage */
252
+ /** @var \Webklex\PHPIMAP \Support\MessageCollection $aMessage */
253
253
$aMessage = $oFolder->search()->text('hello world')->since('15.03.2018')->get();
254
254
255
255
// Folder::messages() is just an alias for Folder::query()
256
- /** @var \Webklex\IMAP \Support\MessageCollection $aMessage */
256
+ /** @var \Webklex\PHPIMAP \Support\MessageCollection $aMessage */
257
257
$aMessage = $oFolder->messages()->text('hello world')->since('15.03.2018')->get();
258
258
259
259
```
@@ -296,20 +296,20 @@ Further information:
296
296
#### Result limiting
297
297
Limiting the request emails:
298
298
``` php
299
- /** @var \Webklex\IMAP \Folder $oFolder */
299
+ /** @var \Webklex\PHPIMAP \Folder $oFolder */
300
300
301
301
//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 */
303
303
$aMessage = $oFolder->query()->since('15.03.2018')->limit(10, 2)->get();
304
304
```
305
305
306
306
#### Counting messages
307
307
Count all available messages matching the current search criteria:
308
308
``` php
309
- /** @var \Webklex\IMAP \Folder $oFolder */
309
+ /** @var \Webklex\PHPIMAP \Folder $oFolder */
310
310
311
311
//Count all messages
312
- /** @var \Webklex\IMAP \Support\MessageCollection $aMessage */
312
+ /** @var \Webklex\PHPIMAP \Support\MessageCollection $aMessage */
313
313
$count = $oFolder->query()->all()->count();
314
314
315
315
//Count all messages since march 15 2018
@@ -319,21 +319,21 @@ $count = $oFolder->query()->since('15.03.2018')->count();
319
319
#### Pagination
320
320
Paginate a query:
321
321
``` php
322
- /** @var \Webklex\IMAP \Folder $oFolder */
322
+ /** @var \Webklex\PHPIMAP \Folder $oFolder */
323
323
324
324
/** @var \Illuminate\Pagination\LengthAwarePaginator $paginator */
325
325
$paginator = $oFolder->query()->since('15.03.2018')->paginate();
326
326
```
327
327
Paginate a message collection:
328
328
``` php
329
- /** @var \Webklex\IMAP \Support\MessageCollection $aMessage */
329
+ /** @var \Webklex\PHPIMAP \Support\MessageCollection $aMessage */
330
330
331
331
/** @var \Illuminate\Pagination\LengthAwarePaginator $paginator */
332
332
$paginator = $aMessage->paginate();
333
333
```
334
334
View example for a paginated list:
335
335
``` php
336
- /** @var \Webklex\IMAP \Folder $oFolder */
336
+ /** @var \Webklex\PHPIMAP \Folder $oFolder */
337
337
338
338
/** @var \Illuminate\Pagination\LengthAwarePaginator $paginator */
339
339
$paginator = $oFolder->search()
@@ -380,72 +380,72 @@ You can find a few blade examples under [/examples](https://github.com/Webklex/p
380
380
#### Fetch a specific message
381
381
Get a specific message by uid (Please note that the uid is not unique and can change):
382
382
``` php
383
- /** @var \Webklex\IMAP \Folder $oFolder */
383
+ /** @var \Webklex\PHPIMAP \Folder $oFolder */
384
384
385
- /** @var \Webklex\IMAP \Message $oMessage */
385
+ /** @var \Webklex\PHPIMAP \Message $oMessage */
386
386
$oMessage = $oFolder->getMessage($uid = 1);
387
387
```
388
388
389
389
#### Message flags
390
390
Flag or "unflag" a message:
391
391
``` php
392
- /** @var \Webklex\IMAP \Message $oMessage */
392
+ /** @var \Webklex\PHPIMAP \Message $oMessage */
393
393
$oMessage->setFlag(['Seen', 'Spam']);
394
394
$oMessage->unsetFlag('Spam');
395
395
```
396
396
397
397
Mark all messages as "read" while fetching:
398
398
``` 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 */
401
401
$aMessage = $oFolder->query()->text('Hello world')->markAsRead()->get();
402
402
```
403
403
404
404
Don't mark all messages as "read" while fetching:
405
405
``` 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 */
408
408
$aMessage = $oFolder->query()->text('Hello world')->leaveUnread()->get();
409
409
```
410
410
411
411
#### Attachments
412
412
Save message attachments:
413
413
``` php
414
- /** @var \Webklex\IMAP \Message $oMessage */
414
+ /** @var \Webklex\PHPIMAP \Message $oMessage */
415
415
416
- /** @var \Webklex\IMAP \Support\AttachmentCollection $aAttachment */
416
+ /** @var \Webklex\PHPIMAP \Support\AttachmentCollection $aAttachment */
417
417
$aAttachment = $oMessage->getAttachments();
418
418
419
419
$aAttachment->each(function ($oAttachment) {
420
- /** @var \Webklex\IMAP \Attachment $oAttachment */
420
+ /** @var \Webklex\PHPIMAP \Attachment $oAttachment */
421
421
$oAttachment->save();
422
422
});
423
423
```
424
424
425
425
#### Advanced fetching
426
426
Fetch messages without body fetching (decrease load):
427
427
``` php
428
- /** @var \Webklex\IMAP \Folder $oFolder */
428
+ /** @var \Webklex\PHPIMAP \Folder $oFolder */
429
429
430
- /** @var \Webklex\IMAP \Support\MessageCollection $aMessage */
430
+ /** @var \Webklex\PHPIMAP \Support\MessageCollection $aMessage */
431
431
$aMessage = $oFolder->query()->whereText('Hello world')->setFetchBody(false)->get();
432
432
433
- /** @var \Webklex\IMAP \Support\MessageCollection $aMessage */
433
+ /** @var \Webklex\PHPIMAP \Support\MessageCollection $aMessage */
434
434
$aMessage = $oFolder->query()->whereAll()->setFetchBody(false)->setFetchAttachment();
435
435
```
436
436
437
437
Fetch messages without body, flag and attachment fetching (decrease load):
438
438
``` php
439
- /** @var \Webklex\IMAP \Folder $oFolder */
439
+ /** @var \Webklex\PHPIMAP \Folder $oFolder */
440
440
441
- /** @var \Webklex\IMAP \Support\MessageCollection $aMessage */
441
+ /** @var \Webklex\PHPIMAP \Support\MessageCollection $aMessage */
442
442
$aMessage = $oFolder->query()->whereText('Hello world')
443
443
->setFetchFlags(false)
444
444
->setFetchBody(false)
445
445
->setFetchAttachment(false)
446
446
->get();
447
447
448
- /** @var \Webklex\IMAP \Support\MessageCollection $aMessage */
448
+ /** @var \Webklex\PHPIMAP \Support\MessageCollection $aMessage */
449
449
$aMessage = $oFolder->query()->whereAll()
450
450
->setFetchFlags(false)
451
451
->setFetchBody(false)
@@ -460,16 +460,16 @@ The masked instance has to be called manually and is designed to add custom func
460
460
461
461
You can call the default mask by calling the mask method without any arguments.
462
462
``` php
463
- /** @var \Webklex\IMAP \Message $oMessage */
463
+ /** @var \Webklex\PHPIMAP \Message $oMessage */
464
464
$mask = $oMessage->mask();
465
465
```
466
466
467
467
There are several methods available to set the default mask:
468
468
``` 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 */
471
471
472
- $message_mask = \Webklex\IMAP \Support\Masks\MessageMask::class;
472
+ $message_mask = \Webklex\PHPIMAP \Support\Masks\MessageMask::class;
473
473
474
474
$oClient->setDefaultMessageMask($message_mask);
475
475
$oMessage->setMask($message_mask);
@@ -481,9 +481,9 @@ You could also set the default masks inside your `config/imap.php` file under `m
481
481
482
482
You can also apply a mask on [ attachments] ( #attachmentclass ) :
483
483
``` 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;
487
487
488
488
$oClient->setDefaultAttachmentMask($attachment_mask);
489
489
$oAttachment->setMask($attachment_mask);
@@ -494,8 +494,8 @@ If you want to implement your own mask just extend [MessageMask::class](#message
494
494
or [ Mask::class] ( #maskclass ) and implement your desired logic:
495
495
496
496
``` 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 {
499
499
500
500
/**
501
501
* New custom method which can be called through a mask
0 commit comments