1. class
  2. DirectoryTree
  3. \
  4. ImapEngine
  5. \
  6. Poll

Poll

class Poll (View source)

Properties

protected int|null $lastSeenUid

The last seen message UID.

Methods

__construct(Mailbox $mailbox, string $folder, Closure|int $frequency)

Constructor.

__destruct()

Destructor.

void
start(callable $callback, callable $query)

Poll for new messages at a given frequency.

void
check(callable $callback, callable $query)

Check for new messages since the last seen UID.

FolderInterface
folder()

Get the folder to poll.

void
reconnect()

Reconnect the client and restart the poll session.

void
connect()

Connect the client and select the folder to poll.

void
disconnect()

Disconnect the client.

int|false
getNextFrequency()

Get the next frequency in seconds.

Details

at line 19
__construct(Mailbox $mailbox, string $folder, Closure|int $frequency)

Constructor.

Parameters

Mailbox $mailbox
string $folder
Closure|int $frequency

at line 28
__destruct()

Destructor.

at line 36
void start(callable $callback, callable $query)

Poll for new messages at a given frequency.

Parameters

callable $callback
callable $query

Return Value

void

at line 54
protected void check(callable $callback, callable $query)

Check for new messages since the last seen UID.

Parameters

callable $callback
callable $query

Return Value

void

at line 87
protected FolderInterface folder()

Get the folder to poll.

Return Value

FolderInterface

at line 95
protected void reconnect()

Reconnect the client and restart the poll session.

Return Value

void

at line 105
protected void connect()

Connect the client and select the folder to poll.

Return Value

void

at line 115
protected void disconnect()

Disconnect the client.

Return Value

void

at line 127
protected int|false getNextFrequency()

Get the next frequency in seconds.

Return Value

int|false