A

AddressClass in namespace DirectoryTree\ImapEngine
AttachmentClass in namespace DirectoryTree\ImapEngine
ConnectionInterface::authenticate() — Method in class ConnectionInterface

Send an "AUTHENTICATE" command.

ConnectionInterface::append() — Method in class ConnectionInterface

Send a "APPEND" command.

ImapConnection::authenticate() — Method in class ImapConnection

Send an "AUTHENTICATE" command.

ImapConnection::append() — Method in class ImapConnection

Send a "APPEND" command.

ImapConnection::assertTaggedResponse() — Method in class ImapConnection

Assert the next response is a successful tagged response.

ImapConnection::assertNextResponse() — Method in class ImapConnection

Assert the next response matches the given filter and assertion.

ImapParser::advance() — Method in class ImapParser

Advance to the next token from the tokenizer.

ImapQueryBuilder::all() — Method in class ImapQueryBuilder

Add a where "ALL" clause to the query.

ImapQueryBuilder::answered() — Method in class ImapQueryBuilder

Add a where "ANSWERED" clause to the query.

ImapQueryBuilder::addBasicCondition() — Method in class ImapQueryBuilder

Add a basic condition to the query.

ImapQueryBuilder::addNestedCondition() — Method in class ImapQueryBuilder

Add a nested condition group to the query.

ImapTokenizer::advance() — Method in class ImapTokenizer

Advances the internal pointer by $n characters.

Result::addResponse() — Method in class Result

Add a response to the result.

FakeStream::assertWritten() — Method in class FakeStream

Assert that the given data was written to the stream.

AtomClass in namespace DirectoryTree\ImapEngine\Connection\Tokens
HasParsedMessage::attachments() — Method in class HasParsedMessage

Get the message's attachments.

HasParsedMessage::attachmentCount() — Method in class HasParsedMessage

Get the count of attachments.

HasParsedMessage::addresses() — Method in class HasParsedMessage

Get addresses from the given header.

Idle::await() — Method in class Idle

Await new messages on the connection.

Mailbox::authenticate() — Method in class Mailbox

Authenticate the current session.

MessageInterface::attachments() — Method in class MessageInterface

Get the message's attachments.

MessageInterface::attachmentCount() — Method in class MessageInterface

Get the count of attachments.

MessageInterface::addresses() — Method in class MessageInterface

Get addresses from the given header.

MessageQuery::append() — Method in class MessageQuery

Append a new message to the folder.

MessageQueryInterface::append() — Method in class MessageQueryInterface

Append a new message to the folder.

FakeFolder::addMessage() — Method in class FakeFolder

Add a message to the folder.

FakeMessageQuery::append() — Method in class FakeMessageQuery

Append a new message to the folder.

B

ConnectionInterface::bodyText() — Method in class ConnectionInterface

Send a "FETCH BODY[TEXT]" command.

ConnectionInterface::bodyHeader() — Method in class ConnectionInterface

Send a "FETCH BODY[HEADER]" command.

ConnectionInterface::bodyStructure() — Method in class ConnectionInterface

Send a "FETCH BODYSTRUCTURE" command.

ConnectionInterface::bodyPart() — Method in class ConnectionInterface

Send a "FETCH BODY[i]" command.

ImapConnection::bodyText() — Method in class ImapConnection

Send a "FETCH BODY[TEXT]" command.

ImapConnection::bodyHeader() — Method in class ImapConnection

Send a "FETCH BODY[HEADER]" command.

ImapConnection::bodyStructure() — Method in class ImapConnection

Fetch the BODYSTRUCTURE for the given message(s).

ImapConnection::bodyPart() — Method in class ImapConnection

Fetch a specific part of the message BODY, such as BODY[1], BODY[1.2], etc.

ImapQueryBuilder::bcc() — Method in class ImapQueryBuilder

Add a where "BCC" clause to the query.

ImapQueryBuilder::body() — Method in class ImapQueryBuilder

Add a where "BODY" clause to the query.

ImapQueryBuilder::before() — Method in class ImapQueryBuilder

Add a where "BEFORE" clause to the query.

$ ImapTokenizer#bufferProperty in class ImapTokenizer

The buffer of characters read from the stream.

$ FakeStream#bufferProperty in class FakeStream

Lines queued for testing; each call to fgets() pops the next line.

HasParsedMessage::bcc() — Method in class HasParsedMessage

Get the BCC addresses.

Message::body() — Method in class Message

Get the message's raw body.

MessageInterface::bcc() — Method in class MessageInterface

Get the 'BCC' addresses.

C

Attachment::contentId() — Method in class Attachment

Get the attachment's content ID.

Attachment::contentType() — Method in class Attachment

Get the attachment's content type.

Attachment::contentDisposition() — Method in class Attachment

Get the attachment's content disposition.

Attachment::contents() — Method in class Attachment

Get the attachment's contents.

Attachment::contentStream() — Method in class Attachment

Get the attachment's content stream.

ResponseCollection::continuation() — Method in class ResponseCollection

Filter the collection to only continuation responses.

ComparesFoldersClass in namespace DirectoryTree\ImapEngine
ConnectionInterfaceClass in namespace DirectoryTree\ImapEngine\Connection
ConnectionInterface::connect() — Method in class ConnectionInterface

Open a new connection.

ConnectionInterface::connected() — Method in class ConnectionInterface

Determine if the current session is connected.

ConnectionInterface::capability() — Method in class ConnectionInterface

Send a "CAPABILITY" command.

ConnectionInterface::copy() — Method in class ConnectionInterface

Send a "UID COPY" command.

ConnectionInterface::create() — Method in class ConnectionInterface

Send a "CREATE" command.

$ ImapCommand#compiledProperty in class ImapCommand

The compiled command lines.

ImapCommand::command() — Method in class ImapCommand

Get the IMAP command.

ImapCommand::compile() — Method in class ImapCommand

Compile the command into lines for transmission.

ImapConnection::connect() — Method in class ImapConnection

Open a new connection.

ImapConnection::connected() — Method in class ImapConnection

Determine if the current session is connected.

ImapConnection::create() — Method in class ImapConnection

Send a "CREATE" command.

ImapConnection::copy() — Method in class ImapConnection

Send a "UID COPY" command.

ImapConnection::capability() — Method in class ImapConnection

Send a "CAPABILITY" command.

$ ImapParser#currentTokenProperty in class ImapParser

The current token being parsed.

ImapQueryBuilder::cc() — Method in class ImapQueryBuilder

Add a where "CC" clause to the query.

ImapQueryBuilder::compileWheres() — Method in class ImapQueryBuilder

Recursively compile the wheres array into an IMAP-compatible string.

ImapQueryBuilder::compileBasic() — Method in class ImapQueryBuilder

Compile a basic where condition into an IMAP-compatible string.

ImapTokenizer::currentChar() — Method in class ImapTokenizer

Returns the current character in the buffer.

ContinuationResponseClass in namespace DirectoryTree\ImapEngine\Connection\Responses
Data::contains() — Method in class Data

Determine if the data contains a specific value.

Result::command() — Method in class Result

Get the executed command.

$ FakeStream#connectionProperty in class FakeStream

The connection info.

FakeStream::close() — Method in class FakeStream

Close the underlying stream.

ImapStream::close() — Method in class ImapStream

Close the underlying stream.

StreamInterface::close() — Method in class StreamInterface

Close the underlying stream.

CrlfClass in namespace DirectoryTree\ImapEngine\Connection\Tokens
$ ImapCommandException#commandProperty in class ImapCommandException

The failed IMAP command.

ImapCommandException::command() — Method in class ImapCommandException

Get the failed IMAP command.

FolderRepository::create() — Method in class FolderRepository

Create a new folder.

FolderRepositoryInterface::create() — Method in class FolderRepositoryInterface

Create a new folder.

HasParsedMessage::cc() — Method in class HasParsedMessage

Get the CC addresses.

Idle::connect() — Method in class Idle

Connect the client and select the folder to idle.

$ Mailbox#configProperty in class Mailbox

The mailbox configuration.

$ Mailbox#capabilitiesProperty in class Mailbox

The cached mailbox capabilities.

$ Mailbox#connectionProperty in class Mailbox

The mailbox connection.

Mailbox::config() — Method in class Mailbox

Get mailbox configuration values.

Mailbox::connection() — Method in class Mailbox

Get the mailbox connection.

Mailbox::connected() — Method in class Mailbox

Determine if connection was established.

Mailbox::connect() — Method in class Mailbox

Connect to the server.

Mailbox::capabilities() — Method in class Mailbox

Get the mailbox's capabilities.

MailboxInterface::config() — Method in class MailboxInterface

Get mailbox configuration values.

MailboxInterface::connection() — Method in class MailboxInterface

Get the mailbox connection.

MailboxInterface::connected() — Method in class MailboxInterface

Determine if connection was established.

MailboxInterface::connect() — Method in class MailboxInterface

Connect to the server.

MailboxInterface::capabilities() — Method in class MailboxInterface

Get the mailbox's capabilities.

Message::copy() — Method in class Message

Copy the message to the given folder.

MessageInterface::cc() — Method in class MessageInterface

Get the 'CC' addresses.

MessageQuery::count() — Method in class MessageQuery

Count all available messages matching the current search criteria.

MessageQuery::chunk() — Method in class MessageQuery

Execute a callback over each chunk of messages.

MessageQuery::connection() — Method in class MessageQuery

Get the connection instance.

MessageQueryInterface::count() — Method in class MessageQueryInterface

Count all available messages matching the current search criteria.

MessageQueryInterface::chunk() — Method in class MessageQueryInterface

Execute a callback over each chunk of messages.

LengthAwarePaginator::currentPage() — Method in class LengthAwarePaginator

Get the current page number.

LengthAwarePaginator::calculateTo() — Method in class LengthAwarePaginator

Calculate the "to" index for the current page.

Poll::check() — Method in class Poll

Check for new messages since the last seen UID.

Poll::connect() — Method in class Poll

Connect the client and select the folder to poll.

Str::credentials() — Method in class Str

Make a credentials string for use in the AUTHENTICATE command.

FakeFolderRepository::create() — Method in class FakeFolderRepository

Create a new folder.

FakeMailbox::config() — Method in class FakeMailbox

Get mailbox configuration values.

FakeMailbox::connection() — Method in class FakeMailbox

Get the mailbox connection.

FakeMailbox::connected() — Method in class FakeMailbox

Determine if connection was established.

FakeMailbox::connect() — Method in class FakeMailbox

Connect to the server.

FakeMailbox::capabilities() — Method in class FakeMailbox

Get the mailbox's capabilities.

FakeMessageQuery::count() — Method in class FakeMessageQuery

Count all available messages matching the current search criteria.

FakeMessageQuery::chunk() — Method in class FakeMessageQuery

Execute a callback over each chunk of messages.

D

ConnectionInterface::disconnect() — Method in class ConnectionInterface

Close the current connection.

ConnectionInterface::done() — Method in class ConnectionInterface

Send a "DONE" command.

ConnectionInterface::delete() — Method in class ConnectionInterface

Send a "DELETE" command.

ImapConnection::disconnect() — Method in class ImapConnection

Close the current connection.

ImapConnection::delete() — Method in class ImapConnection

Send a "DELETE" command.

ImapConnection::done() — Method in class ImapConnection

Send a "DONE" command.

$ ImapQueryBuilder#dateFormatProperty in class ImapQueryBuilder

The date format to use for date based queries.

ImapQueryBuilder::draft() — Method in class ImapQueryBuilder

Add a where "DRAFT" clause to the query.

ImapQueryBuilder::deleted() — Method in class ImapQueryBuilder

Add a where "DELETED" clause to the query.

Logger::date() — Method in class Logger

Get the current date and time.

ContinuationResponse::data() — Method in class ContinuationResponse

Get the data tokens.

DataClass in namespace DirectoryTree\ImapEngine\Connection\Responses\Data
TaggedResponse::data() — Method in class TaggedResponse

Get the response data tokens.

UntaggedResponse::data() — Method in class UntaggedResponse

Get the data tokens.

DraftMessageClass in namespace DirectoryTree\ImapEngine
Folder::delimiter() — Method in class Folder

Get the folder delimiter.

Folder::delete() — Method in class Folder

Delete the current folder.

FolderInterface::delimiter() — Method in class FolderInterface

Get the folder delimiter.

FolderInterface::delete() — Method in class FolderInterface

Delete the current folder.

HasParsedMessage::date() — Method in class HasParsedMessage

Get the message date and time.

Idle::disconnect() — Method in class Idle

Disconnect the client.

Idle::done() — Method in class Idle

End the current IDLE session.

Mailbox::disconnect() — Method in class Mailbox

Disconnect from server.

MailboxInterface::disconnect() — Method in class MailboxInterface

Disconnect from server.

Message::delete() — Method in class Message

Delete the message.

MessageInterface::date() — Method in class MessageInterface

Get the message date and time.

MessageQuery::destroy() — Method in class MessageQuery

Destroy the given messages.

MessageQueryInterface::destroy() — Method in class MessageQueryInterface

Destroy the given messages.

Poll::disconnect() — Method in class Poll

Disconnect the client.

FakeFolder::delimiter() — Method in class FakeFolder

Get the folder delimiter.

FakeFolder::delete() — Method in class FakeFolder

Delete the current folder.

FakeMailbox::disconnect() — Method in class FakeMailbox

Disconnect from server.

FakeMessageQuery::destroy() — Method in class FakeMessageQuery

Destroy the given messages.

E

Address::email() — Method in class Address

Get the address's email.

Attachment::extension() — Method in class Attachment

Get the attachment's extension.

ConnectionInterface::expunge() — Method in class ConnectionInterface

Send a "EXPUNGE" command.

ConnectionInterface::examine() — Method in class ConnectionInterface

Send a "EXAMINE" command.

ImapConnection::examine() — Method in class ImapConnection

Send a "EXAMINE" command.

ImapConnection::examineOrSelect() — Method in class ImapConnection

Examine and select have the same response.

ImapConnection::expunge() — Method in class ImapConnection

Send a "EXPUNGE" command.

ImapTokenizer::ensureBuffer() — Method in class ImapTokenizer

Ensures that at least the given length in characters are available in the buffer.

EchoLoggerClass in namespace DirectoryTree\ImapEngine\Connection\Loggers
EmailAddressClass in namespace DirectoryTree\ImapEngine\Connection\Tokens
DraftMessage::email() — Method in class DraftMessage

Get the underlying Symfony Email instance.

ExceptionClass in namespace DirectoryTree\ImapEngine\Exceptions
Folder::examine() — Method in class Folder

Examine the current folder and get detailed status information.

Folder::expunge() — Method in class Folder

Expunge the mailbox and return the expunged message sequence numbers.

FolderInterface::examine() — Method in class FolderInterface

Examine the current folder and get detailed status information.

FolderInterface::expunge() — Method in class FolderInterface

Expunge the mailbox and return the expunged message sequence numbers.

MessageQuery::each() — Method in class MessageQuery

Execute a callback over each message via a chunked query.

MessageQueryInterface::each() — Method in class MessageQueryInterface

Execute a callback over each message via a chunked query.

Str::enums() — Method in class Str

Resolve the value of the given enums.

Str::enum() — Method in class Str

Resolve the value of the given enum.

Str::escape() — Method in class Str

Escape a string for use in a list.

FakeFolder::examine() — Method in class FakeFolder

Examine the current folder and get detailed status information.

FakeFolder::expunge() — Method in class FakeFolder

Expunge the mailbox and return the expunged message sequence numbers.

FakeMessageQuery::each() — Method in class FakeMessageQuery

Execute a callback over each message via a chunked query.

F

Attachment::filename() — Method in class Attachment

Get the attachment's filename.

FolderCollectionClass in namespace DirectoryTree\ImapEngine\Collections
MessageCollection::find() — Method in class MessageCollection

Find a message by its UID.

MessageCollection::findOrFail() — Method in class MessageCollection

Find a message by its UID or throw an exception.

ConnectionInterface::flags() — Method in class ConnectionInterface

Send a "FETCH FLAGS" command.

ConnectionInterface::fetch() — Method in class ConnectionInterface

Send a "FETCH" command.

ImapConnection::fake() — Method in class ImapConnection

Create a new connection with a fake stream.

ImapConnection::flags() — Method in class ImapConnection

Send a "FETCH FLAGS" command.

ImapConnection::fetch() — Method in class ImapConnection

Fetch one or more items for one or more messages.

ImapQueryBuilder::flagged() — Method in class ImapQueryBuilder

Add a where "FLAGGED" clause to the query.

ImapQueryBuilder::from() — Method in class ImapQueryBuilder

Add a where "FROM" clause to the query.

ImapTokenizer::flushBuffer() — Method in class ImapTokenizer

Flush the buffer and reset the position.

FileLoggerClass in namespace DirectoryTree\ImapEngine\Connection\Loggers
Data::first() — Method in class Data

Get the first token.

TaggedResponse::failed() — Method in class TaggedResponse

Determine if the response failed.

FakeStreamClass in namespace DirectoryTree\ImapEngine\Connection\Streams
FakeStream::feed() — Method in class FakeStream

Feed a line to the stream buffer with a newline character.

FakeStream::feedRaw() — Method in class FakeStream

Feed a raw line to the stream buffer.

FakeStream::fgets() — Method in class FakeStream

Read a single line from the stream.

FakeStream::fwrite() — Method in class FakeStream

Write data to the stream.

ImapStream::fgets() — Method in class ImapStream

Read a single line from the stream.

ImapStream::fwrite() — Method in class ImapStream

Write data to the stream.

StreamInterface::fgets() — Method in class StreamInterface

Read a single line from the stream.

StreamInterface::fwrite() — Method in class StreamInterface

Write data to the stream.

FileMessageClass in namespace DirectoryTree\ImapEngine
FileMessage::flag() — Method in class FileMessage

Add or remove a flag from the message.

FileMessage::flags() — Method in class FileMessage

Get the message flags.

FlaggableInterfaceClass in namespace DirectoryTree\ImapEngine
FlaggableInterface::flags() — Method in class FlaggableInterface

Get the message's flags.

FlaggableInterface::flag() — Method in class FlaggableInterface

Add or remove a flag from the message.

FolderClass in namespace DirectoryTree\ImapEngine
Folder::flags() — Method in class Folder

Get the folder flags.

FolderInterfaceClass in namespace DirectoryTree\ImapEngine
FolderInterface::flags() — Method in class FolderInterface

Get the folder flags.

FolderRepositoryClass in namespace DirectoryTree\ImapEngine
FolderRepository::find() — Method in class FolderRepository

Find a folder.

FolderRepository::findOrFail() — Method in class FolderRepository

Find a folder or throw an exception.

FolderRepository::firstOrCreate() — Method in class FolderRepository

Find or create a folder.

FolderRepositoryInterfaceClass in namespace DirectoryTree\ImapEngine
FolderRepositoryInterface::find() — Method in class FolderRepositoryInterface

Find a folder.

FolderRepositoryInterface::findOrFail() — Method in class FolderRepositoryInterface

Find a folder or throw an exception.

FolderRepositoryInterface::firstOrCreate() — Method in class FolderRepositoryInterface

Find or create a folder.

HasFlags::flags() — Method in class HasFlags
{@inheritDoc}
HasFlags::flag() — Method in class HasFlags
{@inheritDoc}
HasParsedMessage::from() — Method in class HasParsedMessage

Get the FROM address.

Idle::folder() — Method in class Idle

Get the folder to idle.

Mailbox::folders() — Method in class Mailbox

Begin querying for mailbox folders.

MailboxInterface::folders() — Method in class MailboxInterface

Begin querying for mailbox folders.

Message::folder() — Method in class Message

Get the message's folder.

Message::flags() — Method in class Message

Get the message's flags.

Message::flag() — Method in class Message

Add or remove a flag from the message.

MessageInterface::from() — Method in class MessageInterface

Get the 'From' address.

MessageQuery::first() — Method in class MessageQuery

Get the first message in the resulting collection.

MessageQuery::firstOrFail() — Method in class MessageQuery

Get the first message in the resulting collection or throw an exception.

MessageQuery::findOrFail() — Method in class MessageQuery

Find a message by the given identifier type or throw an exception.

MessageQuery::find() — Method in class MessageQuery

Find a message by the given identifier type.

MessageQuery::fetch() — Method in class MessageQuery

Fetch a given id collection.

MessageQueryInterface::first() — Method in class MessageQueryInterface

Get the first message in the resulting collection.

MessageQueryInterface::firstOrFail() — Method in class MessageQueryInterface

Get the first message in the resulting collection or throw an exception.

MessageQueryInterface::findOrFail() — Method in class MessageQueryInterface

Find a message by the given identifier type or throw an exception.

MessageQueryInterface::find() — Method in class MessageQueryInterface

Find a message by the given identifier type.

Poll::folder() — Method in class Poll

Get the folder to poll.

$ QueriesMessages#fetchBodyProperty in class QueriesMessages

Whether to fetch the message body.

$ QueriesMessages#fetchFlagsProperty in class QueriesMessages

Whether to fetch the message flags.

$ QueriesMessages#fetchHeadersProperty in class QueriesMessages

Whether to fetch the message headers.

$ QueriesMessages#fetchSizeProperty in class QueriesMessages

Whether to fetch the message size.

$ QueriesMessages#fetchOrderProperty in class QueriesMessages

The fetch order.

$ QueriesMessages#fetchAsUnreadProperty in class QueriesMessages

Whether to leave messages fetched as unread by default.

ForwardsCallsClass in namespace DirectoryTree\ImapEngine\Support
ForwardsCalls::forwardCallTo() — Method in class ForwardsCalls

Forward a method call to the given object.

Str::fromImapUtf7() — Method in class Str

Decode a modified UTF-7 string (IMAP specific) to UTF-8.

FakeFolderClass in namespace DirectoryTree\ImapEngine\Testing
FakeFolder::flags() — Method in class FakeFolder

Get the folder flags.

FakeFolderRepositoryClass in namespace DirectoryTree\ImapEngine\Testing
FakeFolderRepository::find() — Method in class FakeFolderRepository

Find a folder.

FakeFolderRepository::findOrFail() — Method in class FakeFolderRepository

Find a folder or throw an exception.

FakeFolderRepository::firstOrCreate() — Method in class FakeFolderRepository

Find or create a folder.

FakeMailboxClass in namespace DirectoryTree\ImapEngine\Testing
FakeMailbox::folders() — Method in class FakeMailbox

Begin querying for mailbox folders.

FakeMessageClass in namespace DirectoryTree\ImapEngine\Testing
FakeMessage::flag() — Method in class FakeMessage

Add or remove a flag from the message.

FakeMessage::flags() — Method in class FakeMessage

Get the message's flags.

FakeMessageQueryClass in namespace DirectoryTree\ImapEngine\Testing
FakeMessageQuery::first() — Method in class FakeMessageQuery

Get the first message in the resulting collection.

FakeMessageQuery::firstOrFail() — Method in class FakeMessageQuery

Get the first message in the resulting collection or throw an exception.

FakeMessageQuery::findOrFail() — Method in class FakeMessageQuery

Find a message by the given identifier type or throw an exception.

FakeMessageQuery::find() — Method in class FakeMessageQuery

Find a message by the given identifier type.

G

ImapConnection::getDefaultSocketOptions() — Method in class ImapConnection

Get the default socket options for the given transport.

MessageResponseParser::getUidFromCopy() — Method in class MessageResponseParser

Get the UID from a tagged move or copy response.

FolderRepository::get() — Method in class FolderRepository

Get the mailboxes folders.

FolderRepositoryInterface::get() — Method in class FolderRepositoryInterface

Get the mailboxes folders.

Idle::getNextTimeout() — Method in class Idle

Get the next timeout as a Carbon instance.

MessageQuery::get() — Method in class MessageQuery

Get the messages matching the current query.

MessageQueryInterface::getLimit() — Method in class MessageQueryInterface

Get the set fetch limit.

MessageQueryInterface::getPage() — Method in class MessageQueryInterface

Get the set page.

MessageQueryInterface::getFetchOrder() — Method in class MessageQueryInterface

Get the fetch order.

MessageQueryInterface::get() — Method in class MessageQueryInterface

Get the messages matching the current query.

Poll::getNextFrequency() — Method in class Poll

Get the next frequency in seconds.

QueriesMessages::getLimit() — Method in class QueriesMessages
{@inheritDoc}
QueriesMessages::getPage() — Method in class QueriesMessages
{@inheritDoc}
QueriesMessages::getFetchOrder() — Method in class QueriesMessages
{@inheritDoc}
FakeFolder::getMessages() — Method in class FakeFolder

Get the folder's messages.

FakeFolderRepository::get() — Method in class FakeFolderRepository

Get the mailboxes folders.

FakeMessageQuery::get() — Method in class FakeMessageQuery

Get the messages matching the current query.

H

ImapQueryBuilder::header() — Method in class ImapQueryBuilder

Add a where "HEADER" clause to the query.

HasTokensClass in namespace DirectoryTree\ImapEngine\Connection\Responses
FlaggableInterface::hasFlag() — Method in class FlaggableInterface

Determine if the message has the given flag.

HasFlagsClass in namespace DirectoryTree\ImapEngine
HasFlags::hasFlag() — Method in class HasFlags
{@inheritDoc}
HasParsedMessageClass in namespace DirectoryTree\ImapEngine
HasParsedMessage::hasAttachments() — Method in class HasParsedMessage

Determine if the message has attachments.

HasParsedMessage::html() — Method in class HasParsedMessage

Get the message's HTML content.

HasParsedMessage::headers() — Method in class HasParsedMessage

Get all headers from the message.

HasParsedMessage::header() — Method in class HasParsedMessage

Get a header from the message.

Message::head() — Method in class Message

Get the message's raw headers.

Message::hasHead() — Method in class Message

Determine if the message has headers.

Message::hasBody() — Method in class Message

Determine if the message has contents.

MessageInterface::hasAttachments() — Method in class MessageInterface

Determine if the message has attachments.

MessageInterface::html() — Method in class MessageInterface

Get the message's HTML content.

MessageInterface::headers() — Method in class MessageInterface

Get all headers from the message.

MessageInterface::header() — Method in class MessageInterface

Get a header from the message.

LengthAwarePaginator::hasPages() — Method in class LengthAwarePaginator

Determine if there are enough items to split into multiple pages.

LengthAwarePaginator::hasMorePages() — Method in class LengthAwarePaginator

Determine if there is a next page.

I

ComparesFolders::isSameFolder() — Method in class ComparesFolders

Determine if two folders are the same.

ConnectionInterface::idle() — Method in class ConnectionInterface

Send an "IDLE" command.

ConnectionInterface::id() — Method in class ConnectionInterface

Send a "FETCH" command.

ImapCommandClass in namespace DirectoryTree\ImapEngine\Connection
ImapConnectionClass in namespace DirectoryTree\ImapEngine\Connection
ImapConnection::id() — Method in class ImapConnection

Send a "FETCH" command.

ImapConnection::idle() — Method in class ImapConnection

Send an "IDLE" command.

ImapParserClass in namespace DirectoryTree\ImapEngine\Connection
ImapQueryBuilderClass in namespace DirectoryTree\ImapEngine\Connection
ImapQueryBuilder::isEmpty() — Method in class ImapQueryBuilder

Determine if the query has any where conditions.

ImapTokenizerClass in namespace DirectoryTree\ImapEngine\Connection
ImapTokenizer::isValidAtomCharacter() — Method in class ImapTokenizer

Determine if the given character is a valid atom character.

ImapTokenizer::isDelimiter() — Method in class ImapTokenizer

Determine if the given character is a delimiter for tokenizing responses.

ImapStreamClass in namespace DirectoryTree\ImapEngine\Connection\Streams
Token::is() — Method in class Token

Determine if the token is the given value.

Token::isNot() — Method in class Token

Determine if the token is not the given value.

ImapCapabilityExceptionClass in namespace DirectoryTree\ImapEngine\Exceptions
ImapCommandExceptionClass in namespace DirectoryTree\ImapEngine\Exceptions
ImapConnectionClosedExceptionClass in namespace DirectoryTree\ImapEngine\Exceptions
ImapConnectionExceptionClass in namespace DirectoryTree\ImapEngine\Exceptions
ImapConnectionFailedExceptionClass in namespace DirectoryTree\ImapEngine\Exceptions
ImapConnectionTimedOutExceptionClass in namespace DirectoryTree\ImapEngine\Exceptions
ImapParserExceptionClass in namespace DirectoryTree\ImapEngine\Exceptions
ImapResponseExceptionClass in namespace DirectoryTree\ImapEngine\Exceptions
ImapStreamExceptionClass in namespace DirectoryTree\ImapEngine\Exceptions
FileMessage::is() — Method in class FileMessage

Determine if this message is equal to another.

FileMessage::isEmpty() — Method in class FileMessage

Determine if the message is empty.

FlaggableInterface::isSeen() — Method in class FlaggableInterface

Determine if the message is marked as seen.

FlaggableInterface::isAnswered() — Method in class FlaggableInterface

Determine if the message is marked as answered.

FlaggableInterface::isFlagged() — Method in class FlaggableInterface

Determine if the message is flagged.

FlaggableInterface::isDeleted() — Method in class FlaggableInterface

Determine if the message is marked as deleted.

FlaggableInterface::isDraft() — Method in class FlaggableInterface

Determine if the message is marked as a draft.

FlaggableInterface::isRecent() — Method in class FlaggableInterface

Determine if the message is marked as recent.

Folder::is() — Method in class Folder

Determine if the current folder is the same as the given.

Folder::idle() — Method in class Folder

Begin idling on the current folder for the given timeout in seconds.

FolderInterface::is() — Method in class FolderInterface

Determine if the current folder is the same as the given.

FolderInterface::idle() — Method in class FolderInterface

Begin idling on the current folder for the given timeout in seconds.

HasFlags::isSeen() — Method in class HasFlags
{@inheritDoc}
HasFlags::isAnswered() — Method in class HasFlags
{@inheritDoc}
HasFlags::isFlagged() — Method in class HasFlags
{@inheritDoc}
HasFlags::isDeleted() — Method in class HasFlags
{@inheritDoc}
HasFlags::isDraft() — Method in class HasFlags
{@inheritDoc}
HasFlags::isRecent() — Method in class HasFlags
{@inheritDoc}
HasParsedMessage::inReplyTo() — Method in class HasParsedMessage

Get the IN-REPLY-TO message identifier(s).

HasParsedMessage::isForwardedMessage() — Method in class HasParsedMessage

Determine if the attachment should be treated as an embedded forwarded message.

HasParsedMessage::isEmpty() — Method in class HasParsedMessage

Determine if the message is empty.

IdleClass in namespace DirectoryTree\ImapEngine
Idle::idle() — Method in class Idle

Begin a new IDLE session as a generator.

Mailbox::inbox() — Method in class Mailbox

Get the mailbox's inbox folder.

MailboxInterface::inbox() — Method in class MailboxInterface

Get the mailbox's inbox folder.

Message::is() — Method in class Message

Determine if the message is the same as another message.

Message::isEmpty() — Method in class Message

Determine if the message is empty.

MessageInterface::inReplyTo() — Method in class MessageInterface

Get the 'In-Reply-To' message identifier(s).

MessageInterface::is() — Method in class MessageInterface

Determine if the message is the same as another message.

MessageQuery::id() — Method in class MessageQuery

Get the UID for the given identifier.

MessageQueryInterface::isFetchingBody() — Method in class MessageQueryInterface

Determine if the body of messages is being fetched.

MessageQueryInterface::isFetchingFlags() — Method in class MessageQueryInterface

Determine if the flags of messages is being fetched.

MessageQueryInterface::isFetchingHeaders() — Method in class MessageQueryInterface

Determine if the headers of messages is being fetched.

MessageQueryInterface::isFetchingSize() — Method in class MessageQueryInterface

Determine if the size of messages is being fetched.

LengthAwarePaginator::items() — Method in class LengthAwarePaginator

Get the items being paginated.

QueriesMessages::isFetchingBody() — Method in class QueriesMessages
{@inheritDoc}
QueriesMessages::isFetchingFlags() — Method in class QueriesMessages
{@inheritDoc}
QueriesMessages::isFetchingHeaders() — Method in class QueriesMessages
{@inheritDoc}
QueriesMessages::isFetchingSize() — Method in class QueriesMessages
{@inheritDoc}
Str::is() — Method in class Str

Determine if a given string matches a given pattern.

FakeFolder::is() — Method in class FakeFolder

Determine if the current folder is the same as the given.

FakeFolder::idle() — Method in class FakeFolder

Begin idling on the current folder for the given timeout in seconds.

FakeMailbox::inbox() — Method in class FakeMailbox

Get the mailbox's inbox folder.

FakeMessage::is() — Method in class FakeMessage

Determine if the message is the same as another message.

FakeMessage::isEmpty() — Method in class FakeMessage
{@inheritDoc}

J

Address::jsonSerialize() — Method in class Address

Get the JSON representation of the address.

Attachment::jsonSerialize() — Method in class Attachment

Get the JSON representation of the attachment.

Folder::jsonSerialize() — Method in class Folder

Get the JSON representation of the folder.

Message::jsonSerialize() — Method in class Message

Get the JSON representation of the message.

LengthAwarePaginator::jsonSerialize() — Method in class LengthAwarePaginator

Get the JSON representation of the paginator.

K

ImapQueryBuilder::keyword() — Method in class ImapQueryBuilder

Add a where "KEYWORD" clause to the query.

L

ConnectionInterface::login() — Method in class ConnectionInterface

Send a "LOGIN" command.

ConnectionInterface::logout() — Method in class ConnectionInterface

Send a "LOGOUT" command.

ConnectionInterface::list() — Method in class ConnectionInterface

Send a "LIST" command.

ImapConnection::login() — Method in class ImapConnection

Send a "LOGIN" command.

ImapConnection::logout() — Method in class ImapConnection

Send a "LOGOUT" command.

ImapConnection::list() — Method in class ImapConnection

Send a "LIST" command.

LoggerClass in namespace DirectoryTree\ImapEngine\Connection\Loggers
LoggerInterfaceClass in namespace DirectoryTree\ImapEngine\Connection\Loggers
Data::last() — Method in class Data

Get the last token.

ListDataClass in namespace DirectoryTree\ImapEngine\Connection\Responses\Data
ListData::lookup() — Method in class ListData

Find the immediate successor token of the given field in the list.

ListCloseClass in namespace DirectoryTree\ImapEngine\Connection\Tokens
ListOpenClass in namespace DirectoryTree\ImapEngine\Connection\Tokens
LiteralClass in namespace DirectoryTree\ImapEngine\Connection\Tokens
Idle::listen() — Method in class Idle

Start listening for new messages using the idle() generator.

MessageQueryInterface::leaveUnread() — Method in class MessageQueryInterface

Don't mark messages as read when fetching.

MessageQueryInterface::limit() — Method in class MessageQueryInterface

Set the limit and page for the current query.

LengthAwarePaginatorClass in namespace DirectoryTree\ImapEngine\Pagination
LengthAwarePaginator::lastPage() — Method in class LengthAwarePaginator

Get the last page (total pages).

$ Poll#lastSeenUidProperty in class Poll

The last seen message UID.

$ QueriesMessages#limitProperty in class QueriesMessages

The fetch limit.

QueriesMessages::leaveUnread() — Method in class QueriesMessages
{@inheritDoc}
QueriesMessages::limit() — Method in class QueriesMessages
{@inheritDoc}
Str::list() — Method in class Str

Make a list with literals or nested lists.

Str::literal() — Method in class Str

Make one or more literals.

M

MessageCollectionClass in namespace DirectoryTree\ImapEngine\Collections
ConnectionInterface::move() — Method in class ConnectionInterface

Send a "UID MOVE" command.

ImapConnection::move() — Method in class ImapConnection

Send a "UID MOVE" command.

ImapQueryBuilder::makeExpressionNode() — Method in class ImapQueryBuilder

Build a single expression node from a basic or nested where.

ImapQueryBuilder::mergeExpressions() — Method in class ImapQueryBuilder

Merge the existing expression with the next expression, respecting the boolean operator.

MessageResponseParserClass in namespace DirectoryTree\ImapEngine\Connection\Responses
$ FakeStream#metaProperty in class FakeStream

The mock meta info.

FakeStream::meta() — Method in class FakeStream

Return meta info (like stream_get_meta_data).

ImapStream::meta() — Method in class ImapStream

Return meta info (like stream_get_meta_data).

StreamInterface::meta() — Method in class StreamInterface

Return meta info (like stream_get_meta_data).

$ DraftMessage#messageProperty in class DraftMessage

The underlying Symfony Email instance.

ImapCommandException::make() — Method in class ImapCommandException

Make a new instance from a failed command and response.

FlaggableInterface::markRead() — Method in class FlaggableInterface

Mark the message as read. Alias for markSeen.

FlaggableInterface::markUnread() — Method in class FlaggableInterface

Mark the message as unread. Alias for unmarkSeen.

FlaggableInterface::markSeen() — Method in class FlaggableInterface

Mark the message as seen.

FlaggableInterface::markAnswered() — Method in class FlaggableInterface

Mark the message as answered.

FlaggableInterface::markFlagged() — Method in class FlaggableInterface

Mark the message as flagged.

FlaggableInterface::markDeleted() — Method in class FlaggableInterface

Mark the message as deleted.

FlaggableInterface::markDraft() — Method in class FlaggableInterface

Mark the message as a draft.

FlaggableInterface::markRecent() — Method in class FlaggableInterface

Mark the message as recent.

Folder::mailbox() — Method in class Folder

Get the folder's mailbox.

Folder::messages() — Method in class Folder

Begin querying for messages.

Folder::move() — Method in class Folder

Move or rename the current folder.

FolderInterface::mailbox() — Method in class FolderInterface

Get the folder's mailbox.

FolderInterface::messages() — Method in class FolderInterface

Begin querying for messages.

FolderInterface::move() — Method in class FolderInterface

Move or rename the current folder.

HasFlags::markRead() — Method in class HasFlags
{@inheritDoc}
HasFlags::markUnread() — Method in class HasFlags
{@inheritDoc}
HasFlags::markSeen() — Method in class HasFlags
{@inheritDoc}
HasFlags::markAnswered() — Method in class HasFlags
{@inheritDoc}
HasFlags::markFlagged() — Method in class HasFlags
{@inheritDoc}
HasFlags::markDeleted() — Method in class HasFlags
{@inheritDoc}
HasFlags::markDraft() — Method in class HasFlags
{@inheritDoc}
HasFlags::markRecent() — Method in class HasFlags
{@inheritDoc}
HasParsedMessage::messageId() — Method in class HasParsedMessage

Get the message's message-id.

MailboxClass in namespace DirectoryTree\ImapEngine
Mailbox::make() — Method in class Mailbox

Make a new mailbox instance.

MailboxInterfaceClass in namespace DirectoryTree\ImapEngine
MboxClass in namespace DirectoryTree\ImapEngine
Mbox::messages() — Method in class Mbox

Get the messages from the mbox file.

MessageClass in namespace DirectoryTree\ImapEngine
Message::move() — Method in class Message

Move the message to the given folder.

MessageInterfaceClass in namespace DirectoryTree\ImapEngine
MessageInterface::messageId() — Method in class MessageInterface

Get the message's 'Message-ID'.

MessageParserClass in namespace DirectoryTree\ImapEngine
MessageQueryClass in namespace DirectoryTree\ImapEngine
MessageQueryInterfaceClass in namespace DirectoryTree\ImapEngine
MessageQueryInterface::markAsRead() — Method in class MessageQueryInterface

Mark all messages as read when fetching.

QueriesMessages::markAsRead() — Method in class QueriesMessages
{@inheritDoc}
FakeFolder::mailbox() — Method in class FakeFolder

Get the folder's mailbox.

FakeFolder::messages() — Method in class FakeFolder

Begin querying for messages.

FakeFolder::move() — Method in class FakeFolder

Move or rename the current folder.

N

Address::name() — Method in class Address

Get the address's name.

ConnectionInterface::noop() — Method in class ConnectionInterface

Send a "NOOP" command.

ImapConnection::noop() — Method in class ImapConnection

Send a "NOOP" command.

ImapConnection::newParser() — Method in class ImapConnection

Create a new parser instance.

ImapConnection::newTokenizer() — Method in class ImapConnection

Create a new tokenizer instance.

ImapConnection::nextResponse() — Method in class ImapConnection

Returns the next response matching the given filter.

ImapConnection::nextReply() — Method in class ImapConnection

Read the next reply from the stream.

ImapParser::next() — Method in class ImapParser

Get the next response from the tokenizer.

ImapQueryBuilder::new() — Method in class ImapQueryBuilder

Add a where "NEW" clause to the query.

ImapQueryBuilder::newQuery() — Method in class ImapQueryBuilder

Create a new query instance (like Eloquent's newQuery).

ImapTokenizer::nextToken() — Method in class ImapTokenizer

Returns the next token from the stream.

NumberClass in namespace DirectoryTree\ImapEngine\Connection\Tokens
Folder::name() — Method in class Folder

Get the folder name.

FolderInterface::name() — Method in class FolderInterface

Get the folder name.

MessageQuery::newMessage() — Method in class MessageQuery

Make a new message from given raw components.

MessageQueryInterface::newest() — Method in class MessageQueryInterface

Set the fetch order to show newest messages first (descending).

LengthAwarePaginator::nextPageUrl() — Method in class LengthAwarePaginator

Get the URL for the next page, or null if none.

QueriesMessages::newest() — Method in class QueriesMessages
{@inheritDoc}
FakeFolder::name() — Method in class FakeFolder

Get the folder name.

O

ImapQueryBuilder::old() — Method in class ImapQueryBuilder

Add a where "OLD" clause to the query.

ImapQueryBuilder::on() — Method in class ImapQueryBuilder

Add a where "ON" clause to the query.

ImapQueryBuilder::orWhere() — Method in class ImapQueryBuilder

Add an "or where" condition.

FakeStream::open() — Method in class FakeStream

Open the underlying stream.

FakeStream::opened() — Method in class FakeStream

Determine if the stream is open.

ImapStream::open() — Method in class ImapStream

Open the underlying stream.

ImapStream::opened() — Method in class ImapStream

Determine if the stream is open.

StreamInterface::open() — Method in class StreamInterface

Open the underlying stream.

StreamInterface::opened() — Method in class StreamInterface

Determine if the stream is open.

MessageQueryInterface::oldest() — Method in class MessageQueryInterface

Set the fetch order to show oldest messages first (ascending).

QueriesMessages::oldest() — Method in class QueriesMessages
{@inheritDoc}

P

PaginatedCollectionClass in namespace DirectoryTree\ImapEngine\Collections
PaginatedCollection::paginate() — Method in class PaginatedCollection

Paginate the current collection.

PaginatedCollection::paginator() — Method in class PaginatedCollection

Create a new length-aware paginator instance.

$ ImapConnection#parserProperty in class ImapConnection

The parser instance.

ImapParser::parseUntaggedResponse() — Method in class ImapParser

Parse an untagged response.

ImapParser::parseContinuationResponse() — Method in class ImapParser

Parse a continuation response.

ImapParser::parseTaggedResponse() — Method in class ImapParser

Parse a tagged response.

ImapParser::parseBracketGroup() — Method in class ImapParser

Parses a bracket group of elements delimited by '[' and ']'.

ImapParser::parseList() — Method in class ImapParser

Parses a list of elements delimited by '(' and ')'.

ImapParser::parseElement() — Method in class ImapParser

Parses a single element, which might be a list or a simple token.

ImapQueryBuilder::prepareWhereValue() — Method in class ImapQueryBuilder

Prepare the where value, escaping it as needed.

ImapQueryBuilder::parseDate() — Method in class ImapQueryBuilder

Attempt to parse a date string into a Carbon instance.

$ ImapTokenizer#positionProperty in class ImapTokenizer

The current position in the buffer.

Folder::path() — Method in class Folder

Get the folder path.

Folder::poll() — Method in class Folder

Begin polling for new messages at the given frequency in seconds.

FolderInterface::path() — Method in class FolderInterface

Get the folder path.

FolderInterface::poll() — Method in class FolderInterface

Begin polling for new messages at the given frequency in seconds.

$ HasParsedMessage#parsedProperty in class HasParsedMessage

The parsed message.

HasParsedMessage::parse() — Method in class HasParsedMessage

Parse the message into a MailMimeMessage instance.

MessageInterface::parse() — Method in class MessageInterface

Parse the message into a MailMimeMessage instance.

$ MessageParser#parserProperty in class MessageParser

The mail mime parser instance.

MessageParser::parse() — Method in class MessageParser

Parse the given message contents.

MessageParser::parser() — Method in class MessageParser

Get the mail mime parser instance.

MessageQuery::paginate() — Method in class MessageQuery

Paginate the current query.

MessageQuery::process() — Method in class MessageQuery

Process the collection of messages.

MessageQuery::populate() — Method in class MessageQuery

Populate a given id collection and receive a fully fetched message collection.

MessageQueryInterface::paginate() — Method in class MessageQueryInterface

Paginate the current query.

LengthAwarePaginator::perPage() — Method in class LengthAwarePaginator

Get the number of items per page.

LengthAwarePaginator::previousPageUrl() — Method in class LengthAwarePaginator

Get the URL for the previous page, or null if none.

PollClass in namespace DirectoryTree\ImapEngine
$ QueriesMessages#pageProperty in class QueriesMessages

The current page.

$ QueriesMessages#passthruProperty in class QueriesMessages

The methods that should be returned from query builder.

Str::prefix() — Method in class Str

Prefix a string with the given prefix if it does not already start with it.

FakeFolder::path() — Method in class FakeFolder

Get the folder path.

FakeFolder::poll() — Method in class FakeFolder

Begin polling for new messages at the given frequency in seconds.

FakeMessageQuery::paginate() — Method in class FakeMessageQuery

Paginate the current query.

Q

ConnectionInterface::quota() — Method in class ConnectionInterface

Send a "GETQUOTA" command.

ConnectionInterface::quotaRoot() — Method in class ConnectionInterface

Send a "GETQUOTAROOT" command.

ImapConnection::quota() — Method in class ImapConnection

Send a "GETQUOTA" command.

ImapConnection::quotaRoot() — Method in class ImapConnection

Send a "GETQUOTAROOT" command.

QuotedStringClass in namespace DirectoryTree\ImapEngine\Connection\Tokens
Folder::quota() — Method in class Folder

Get the folder's quotas.

FolderInterface::quota() — Method in class FolderInterface

Get the folder's quotas.

QueriesMessagesClass in namespace DirectoryTree\ImapEngine
$ QueriesMessages#queryProperty in class QueriesMessages

The query builder instance.

FakeFolder::quota() — Method in class FakeFolder

Get the folder's quotas.

R

ResponseCollectionClass in namespace DirectoryTree\ImapEngine\Collections
ConnectionInterface::rename() — Method in class ConnectionInterface

Send a "RENAME" command.

ImapCommand::redacted() — Method in class ImapCommand

Get a redacted version of the command for safe exposure.

$ ImapConnection#resultProperty in class ImapConnection

The result instance.

ImapConnection::rename() — Method in class ImapConnection

Send a "RENAME" command.

ImapQueryBuilder::recent() — Method in class ImapQueryBuilder

Add a where "RECENT" clause to the query.

ImapTokenizer::readQuotedString() — Method in class ImapTokenizer

Reads a quoted string token.

ImapTokenizer::readLiteral() — Method in class ImapTokenizer

Reads a literal token.

ImapTokenizer::readNumberOrAtom() — Method in class ImapTokenizer

Reads a number or atom token.

ImapTokenizer::readNumber() — Method in class ImapTokenizer

Reads a number token.

ImapTokenizer::readAtom() — Method in class ImapTokenizer

Reads an atom token.

ImapTokenizer::readEmailAddress() — Method in class ImapTokenizer

Reads an email address token enclosed in angle brackets.

Logger::received() — Method in class Logger

Log when a message is received.

LoggerInterface::received() — Method in class LoggerInterface

Log when a message is received.

RayLoggerClass in namespace DirectoryTree\ImapEngine\Connection\Loggers
RawQueryValueClass in namespace DirectoryTree\ImapEngine\Connection
ResponseCodeDataClass in namespace DirectoryTree\ImapEngine\Connection\Responses\Data
ResponseClass in namespace DirectoryTree\ImapEngine\Connection\Responses
ResultClass in namespace DirectoryTree\ImapEngine\Connection
Result::responses() — Method in class Result

Get the recently received responses.

FakeStream::read() — Method in class FakeStream

Read data from the stream.

ImapStream::read() — Method in class ImapStream

Read data from the stream.

StreamInterface::read() — Method in class StreamInterface

Read data from the stream.

ResponseCodeCloseClass in namespace DirectoryTree\ImapEngine\Connection\Tokens
ResponseCodeOpenClass in namespace DirectoryTree\ImapEngine\Connection\Tokens
$ ImapCommandException#responseProperty in class ImapCommandException

The IMAP response.

ImapCommandException::response() — Method in class ImapCommandException

Get the IMAP response.

RuntimeExceptionClass in namespace DirectoryTree\ImapEngine\Exceptions
HasParsedMessage::replyTo() — Method in class HasParsedMessage

Get the REPLY-TO address.

Idle::restart() — Method in class Idle

Issue a done command and restart the idle session.

Idle::reconnect() — Method in class Idle

Reconnect the client and restart the idle session.

Mailbox::reconnect() — Method in class Mailbox

Force a reconnection to the server.

MailboxInterface::reconnect() — Method in class MailboxInterface

Force a reconnection to the server.

Message::restore() — Method in class Message

Restore the message.

MessageInterface::replyTo() — Method in class MessageInterface

Get the 'Reply-To' address.

Poll::reconnect() — Method in class Poll

Reconnect the client and restart the poll session.

FakeMailbox::reconnect() — Method in class FakeMailbox

Force a reconnection to the server.

S

Attachment::save() — Method in class Attachment

Save the attachment to a file.

ConnectionInterface::startTls() — Method in class ConnectionInterface

Send a "STARTTLS" command.

ConnectionInterface::search() — Method in class ConnectionInterface

Send a "SEARCH" command.

ConnectionInterface::size() — Method in class ConnectionInterface

Send a "RFC822.SIZE" command.

ConnectionInterface::send() — Method in class ConnectionInterface

Send an IMAP command.

ConnectionInterface::select() — Method in class ConnectionInterface

Send a "SELECT" command.

ConnectionInterface::status() — Method in class ConnectionInterface

Send a "STATUS" command.

ConnectionInterface::store() — Method in class ConnectionInterface

Send a "STORE" command.

ConnectionInterface::subscribe() — Method in class ConnectionInterface

Send a "SUBSCRIBE" command.

$ ImapConnection#sequenceProperty in class ImapConnection

Sequence number used to generate unique command tags.

ImapConnection::startTls() — Method in class ImapConnection

Send a "STARTTLS" command.

ImapConnection::select() — Method in class ImapConnection

Send a "SELECT" command.

ImapConnection::status() — Method in class ImapConnection

Send a "STATUS" command.

ImapConnection::subscribe() — Method in class ImapConnection

Send a "SUBSCRIBE" command.

ImapConnection::store() — Method in class ImapConnection

Send a "STORE" command.

ImapConnection::size() — Method in class ImapConnection

Send a "RFC822.SIZE" command.

ImapConnection::search() — Method in class ImapConnection

Send a "SEARCH" command.

ImapConnection::send() — Method in class ImapConnection

Send an IMAP command.

ImapConnection::setResult() — Method in class ImapConnection

Set the current result instance.

ImapConnection::setParser() — Method in class ImapConnection

Set the current parser instance.

ImapQueryBuilder::seen() — Method in class ImapQueryBuilder

Add a where "SEEN" clause to the query.

ImapQueryBuilder::since() — Method in class ImapQueryBuilder

Add a where "SINCE" clause to the query.

ImapQueryBuilder::subject() — Method in class ImapQueryBuilder

Add a where "SUBJECT" clause to the query.

ImapTokenizer::skipWhitespace() — Method in class ImapTokenizer

Skips whitespace characters (spaces and tabs only, preserving CRLF).

Logger::sent() — Method in class Logger

Log when a message is sent.

LoggerInterface::sent() — Method in class LoggerInterface

Log when a message is sent.

TaggedResponse::status() — Method in class TaggedResponse

Get the response status token.

TaggedResponse::successful() — Method in class TaggedResponse

Determine if the response was successful.

FakeStream::setMeta() — Method in class FakeStream

Set the timed out status.

FakeStream::setTimeout() — Method in class FakeStream

Set the timeout on the stream.

FakeStream::setSocketSetCrypto() — Method in class FakeStream

Set encryption state on an already connected socked.

$ ImapStream#streamProperty in class ImapStream

The underlying PHP stream resource.

ImapStream::setTimeout() — Method in class ImapStream

Set the timeout on the stream.

ImapStream::setSocketSetCrypto() — Method in class ImapStream

Set encryption state on an already connected socked.

StreamInterfaceClass in namespace DirectoryTree\ImapEngine\Connection\Streams
StreamInterface::setTimeout() — Method in class StreamInterface

Set the timeout on the stream.

StreamInterface::setSocketSetCrypto() — Method in class StreamInterface

Set encryption state on an already connected socked.

FileMessage::size() — Method in class FileMessage

Get the message's size in bytes (RFC822.SIZE).

Folder::select() — Method in class Folder

Select the current folder.

Folder::status() — Method in class Folder

Get the folder's status.

FolderInterface::select() — Method in class FolderInterface

Select the current folder.

FolderInterface::status() — Method in class FolderInterface

Get the folder's status.

HasParsedMessage::subject() — Method in class HasParsedMessage

Get the message's subject.

HasParsedMessage::sender() — Method in class HasParsedMessage

Get the SENDER address.

$ Mailbox#selectedProperty in class Mailbox

The currently selected folder.

Mailbox::select() — Method in class Mailbox

Select the given folder.

Mailbox::selected() — Method in class Mailbox

Determine if the given folder is selected.

MailboxInterface::select() — Method in class MailboxInterface

Select the given folder.

MailboxInterface::selected() — Method in class MailboxInterface

Determine if the given folder is selected.

Message::size() — Method in class Message

Get the message's size in bytes (RFC822.SIZE).

MessageInterface::size() — Method in class MessageInterface

Get the message's size in bytes (RFC822.SIZE).

MessageInterface::subject() — Method in class MessageInterface

Get the message's subject.

MessageInterface::sender() — Method in class MessageInterface

Get the 'Sender' address.

MessageQuery::search() — Method in class MessageQuery

Execute an IMAP search request.

MessageQueryInterface::setLimit() — Method in class MessageQueryInterface

Set the fetch limit.

MessageQueryInterface::setPage() — Method in class MessageQueryInterface

Set the page.

MessageQueryInterface::setFetchOrder() — Method in class MessageQueryInterface

Set the fetch order.

MessageQueryInterface::setFetchOrderAsc() — Method in class MessageQueryInterface

Set the fetch order to 'ascending'.

MessageQueryInterface::setFetchOrderDesc() — Method in class MessageQueryInterface

Set the fetch order to 'descending'.

Poll::start() — Method in class Poll

Poll for new messages at a given frequency.

QueriesMessages::setLimit() — Method in class QueriesMessages
{@inheritDoc}
QueriesMessages::setPage() — Method in class QueriesMessages
{@inheritDoc}
QueriesMessages::setFetchFlags() — Method in class QueriesMessages

Set whether to fetch the flags.

QueriesMessages::setFetchBody() — Method in class QueriesMessages

Set the fetch body flag.

QueriesMessages::setFetchHeaders() — Method in class QueriesMessages

Set whether to fetch the headers.

QueriesMessages::setFetchSize() — Method in class QueriesMessages

Set whether to fetch the size.

QueriesMessages::setFetchOrder() — Method in class QueriesMessages
{@inheritDoc}
QueriesMessages::setFetchOrderAsc() — Method in class QueriesMessages
{@inheritDoc}
QueriesMessages::setFetchOrderDesc() — Method in class QueriesMessages
{@inheritDoc}
StrClass in namespace DirectoryTree\ImapEngine\Support
Str::set() — Method in class Str

Make a range set for use in a search command.

FakeFolder::select() — Method in class FakeFolder

Select the current folder.

FakeFolder::status() — Method in class FakeFolder

Get the folder's status.

FakeFolder::setPath() — Method in class FakeFolder

Set the folder's path.

FakeFolder::setFlags() — Method in class FakeFolder

Set the folder's flags.

FakeFolder::setMailbox() — Method in class FakeFolder

Set the folder's mailbox.

FakeFolder::setMessages() — Method in class FakeFolder

Set the folder's messages.

FakeFolder::setDelimiter() — Method in class FakeFolder

Set the folder's delimiter.

$ FakeMailbox#selectedProperty in class FakeMailbox

The currently selected folder.

FakeMailbox::select() — Method in class FakeMailbox

Select the given folder.

FakeMailbox::selected() — Method in class FakeMailbox

Determine if the given folder is selected.

FakeMessage::size() — Method in class FakeMessage

Get the message's size in bytes (RFC822.SIZE).

T

Address::toArray() — Method in class Address

Get the array representation of the address.

Attachment::toArray() — Method in class Attachment

Get the array representation of the attachment.

$ PaginatedCollection#totalProperty in class PaginatedCollection

The total number of items.

PaginatedCollection::total() — Method in class PaginatedCollection

Get or set the total amount.

ResponseCollection::tagged() — Method in class ResponseCollection

Filter the collection to only tagged responses.

ImapCommand::tag() — Method in class ImapCommand

Get the IMAP tag.

ImapCommand::tokens() — Method in class ImapCommand

Get the IMAP tokens.

ImapQueryBuilder::to() — Method in class ImapQueryBuilder

Add a where "TO" clause to the query.

ImapQueryBuilder::text() — Method in class ImapQueryBuilder

Add a where "TEXT" clause to the query.

ImapQueryBuilder::toImap() — Method in class ImapQueryBuilder

Transform the instance into an IMAP-compatible query string.

Data::tokens() — Method in class Data

Get the tokens.

HasTokens::tokens() — Method in class HasTokens

Get the response tokens.

HasTokens::tokenAt() — Method in class HasTokens

Get the response token at the given index.

HasTokens::tokensAfter() — Method in class HasTokens

Get the response tokens after the given index.

Response::tokens() — Method in class Response

Get the response tokens.

Response::toArray() — Method in class Response

Get the instance as an array.

TaggedResponseClass in namespace DirectoryTree\ImapEngine\Connection\Responses
TaggedResponse::tag() — Method in class TaggedResponse

Get the response tag.

UntaggedResponse::type() — Method in class UntaggedResponse

Get the response type token.

TokenClass in namespace DirectoryTree\ImapEngine\Connection\Tokens
Folder::toArray() — Method in class Folder

Get the array representation of the folder.

HasParsedMessage::to() — Method in class HasParsedMessage

Get the TO addresses.

HasParsedMessage::text() — Method in class HasParsedMessage

Get the message's text content.

Message::toArray() — Method in class Message

Get the array representation of the message.

MessageInterface::to() — Method in class MessageInterface

Get the 'To' addresses.

MessageInterface::text() — Method in class MessageInterface

Get the message's text content.

LengthAwarePaginator::total() — Method in class LengthAwarePaginator

Get the total number of items.

LengthAwarePaginator::toArray() — Method in class LengthAwarePaginator

Get the array representation of the paginator.

ForwardsCalls::throwBadMethodCallException() — Method in class ForwardsCalls

Throw a bad method call exception for the given method.

Str::toImapUtf7() — Method in class Str

Encode a UTF-8 string to modified UTF-7 (IMAP specific).

U

ResponseCollection::untagged() — Method in class ResponseCollection

Filter the collection to only untagged responses.

ConnectionInterface::uid() — Method in class ConnectionInterface

Send a "FETCH UID" command.

ConnectionInterface::unsubscribe() — Method in class ConnectionInterface

Send a "UNSUBSCRIBE" command.

ImapConnection::unsubscribe() — Method in class ImapConnection

Send a "UNSUBSCRIBE" command.

ImapConnection::uid() — Method in class ImapConnection

Send a "FETCH UID" command.

ImapQueryBuilder::unseen() — Method in class ImapQueryBuilder

Add a where "UNSEEN" clause to the query.

ImapQueryBuilder::undeleted() — Method in class ImapQueryBuilder

Add a where "UNDELETED" clause to the query.

ImapQueryBuilder::unflagged() — Method in class ImapQueryBuilder

Add a where "UNFLAGGED" clause to the query.

ImapQueryBuilder::unanswered() — Method in class ImapQueryBuilder

Add a where "UNANSWERED" clause to the query.

ImapQueryBuilder::uid() — Method in class ImapQueryBuilder

Add a where "UID" clause to the query.

UntaggedResponseClass in namespace DirectoryTree\ImapEngine\Connection\Responses
FileMessage::uid() — Method in class FileMessage

Get the message's identifier.

FlaggableInterface::unmarkSeen() — Method in class FlaggableInterface

Unmark the seen flag.

FlaggableInterface::unmarkAnswered() — Method in class FlaggableInterface

Unmark the answered flag.

FlaggableInterface::unmarkFlagged() — Method in class FlaggableInterface

Unmark the flagged flag.

FlaggableInterface::unmarkDeleted() — Method in class FlaggableInterface

Unmark the deleted flag.

FlaggableInterface::unmarkDraft() — Method in class FlaggableInterface

Unmark the draft flag.

FlaggableInterface::unmarkRecent() — Method in class FlaggableInterface

Unmark the recent flag.

HasFlags::unmarkSeen() — Method in class HasFlags
{@inheritDoc}
HasFlags::unmarkAnswered() — Method in class HasFlags
{@inheritDoc}
HasFlags::unmarkFlagged() — Method in class HasFlags
{@inheritDoc}
HasFlags::unmarkDeleted() — Method in class HasFlags
{@inheritDoc}
HasFlags::unmarkDraft() — Method in class HasFlags
{@inheritDoc}
HasFlags::unmarkRecent() — Method in class HasFlags
{@inheritDoc}
Message::uid() — Method in class Message

Get the message's identifier.

MessageInterface::uid() — Method in class MessageInterface

Get the message's identifier.

LengthAwarePaginator::url() — Method in class LengthAwarePaginator

Generate the URL for a given page.

FakeMessage::uid() — Method in class FakeMessage

Get the message's identifier.

V

Data::values() — Method in class Data

Get all the token's values.

W

ImapConnection::write() — Method in class ImapConnection

Write data to the connected stream.

$ ImapQueryBuilder#wheresProperty in class ImapQueryBuilder

The where conditions for the query.

ImapQueryBuilder::where() — Method in class ImapQueryBuilder

Add a "where" condition.

ImapQueryBuilder::whereNot() — Method in class ImapQueryBuilder

Add a "where not" condition.

EchoLogger::write() — Method in class EchoLogger

Write a message to the log.

FileLogger::write() — Method in class FileLogger

Write a message to the log.

Logger::write() — Method in class Logger

Write a message to the log.

RayLogger::write() — Method in class RayLogger

Write a message to the log.

$ FakeStream#writtenProperty in class FakeStream

Data that has been "written" to this fake stream (for assertion).

MessageQueryInterface::withFlags() — Method in class MessageQueryInterface

Fetch the flags of messages.

MessageQueryInterface::withBody() — Method in class MessageQueryInterface

Fetch the body of messages.

MessageQueryInterface::withHeaders() — Method in class MessageQueryInterface

Fetch the headers of messages.

MessageQueryInterface::withSize() — Method in class MessageQueryInterface

Fetch the size of messages.

MessageQueryInterface::withoutBody() — Method in class MessageQueryInterface

Don't fetch the body of messages.

MessageQueryInterface::withoutHeaders() — Method in class MessageQueryInterface

Don't fetch the headers of messages.

MessageQueryInterface::withoutFlags() — Method in class MessageQueryInterface

Don't fetch the flags of messages.

MessageQueryInterface::withoutSize() — Method in class MessageQueryInterface

Don't fetch the size of messages.

QueriesMessages::withFlags() — Method in class QueriesMessages
{@inheritDoc}
QueriesMessages::withBody() — Method in class QueriesMessages
{@inheritDoc}
QueriesMessages::withHeaders() — Method in class QueriesMessages
{@inheritDoc}
QueriesMessages::withSize() — Method in class QueriesMessages
{@inheritDoc}
QueriesMessages::withoutBody() — Method in class QueriesMessages
{@inheritDoc}
QueriesMessages::withoutHeaders() — Method in class QueriesMessages
{@inheritDoc}
QueriesMessages::withoutFlags() — Method in class QueriesMessages
{@inheritDoc}
QueriesMessages::withoutSize() — Method in class QueriesMessages
{@inheritDoc}

_

Address::__construct() — Method in class Address
Constructor.
Attachment::__construct() — Method in class Attachment
Constructor.
ImapCommand::__construct() — Method in class ImapCommand
Constructor.
ImapCommand::__toString() — Method in class ImapCommand

Get the command as a string.

ImapConnection::__construct() — Method in class ImapConnection
Constructor.
ImapConnection::__destruct() — Method in class ImapConnection

Tear down the connection.

ImapParser::__construct() — Method in class ImapParser
Constructor.
ImapTokenizer::__construct() — Method in class ImapTokenizer
Constructor.
FileLogger::__construct() — Method in class FileLogger
Constructor.
RawQueryValue::__construct() — Method in class RawQueryValue
Constructor.
Data::__construct() — Method in class Data
Constructor.
ListData::__toString() — Method in class ListData

Get the list as a string.

ResponseCodeData::__toString() — Method in class ResponseCodeData

Get the group as a string.

Response::__construct() — Method in class Response
Constructor.
Response::__toString() — Method in class Response

Get a JSON representation of the response tokens.

Result::__construct() — Method in class Result
Constructor.
EmailAddress::__toString() — Method in class EmailAddress

Get the token's value.

Literal::__toString() — Method in class Literal

Get the token's value.

QuotedString::__toString() — Method in class QuotedString

Get the token's value.

Token::__construct() — Method in class Token
Constructor.
Token::__toString() — Method in class Token

Get the token's value.

DraftMessage::__construct() — Method in class DraftMessage
Constructor.
DraftMessage::__toString() — Method in class DraftMessage

Get the email as a string.

FileMessage::__construct() — Method in class FileMessage
Constructor.
FileMessage::__toString() — Method in class FileMessage

Get the string representation of the message.

Folder::__construct() — Method in class Folder
Constructor.
FolderRepository::__construct() — Method in class FolderRepository
Constructor.
HasParsedMessage::__toString() — Method in class HasParsedMessage

Get the string representation of the message.

Idle::__construct() — Method in class Idle
Constructor.
Idle::__destruct() — Method in class Idle
Destructor.
Mailbox::__construct() — Method in class Mailbox
Constructor.
Mailbox::__clone() — Method in class Mailbox

Prepare the cloned instance.

Mbox::__construct() — Method in class Mbox
Constructor.
Message::__construct() — Method in class Message
Constructor.
Message::__sleep() — Method in class Message

Get the names of properties that should be serialized.

Message::__toString() — Method in class Message

Get the string representation of the message.

MessageInterface::__toString() — Method in class MessageInterface

Get the string representation of the message.

MessageQuery::__construct() — Method in class MessageQuery
Constructor.
LengthAwarePaginator::__construct() — Method in class LengthAwarePaginator
Constructor.
LengthAwarePaginator::__call() — Method in class LengthAwarePaginator

Handle dynamic method calls on the paginator.

Poll::__construct() — Method in class Poll
Constructor.
Poll::__destruct() — Method in class Poll
Destructor.
QueriesMessages::__call() — Method in class QueriesMessages

Handle dynamic method calls into the query builder.

FakeFolder::__construct() — Method in class FakeFolder
Constructor.
FakeFolderRepository::__construct() — Method in class FakeFolderRepository
Constructor.
FakeMailbox::__construct() — Method in class FakeMailbox
Constructor.
FakeMessage::__construct() — Method in class FakeMessage
Constructor.
FakeMessage::__toString() — Method in class FakeMessage

Get the string representation of the message.

FakeMessageQuery::__construct() — Method in class FakeMessageQuery
Constructor.