Table of Contents
- Documentation
- Installation
- Install php dependencies
- Option 1: Install with composer
- Option 2: Install from GitHub
- Legacy support
- Configuration
- Base Configuration
- Default date format
- Default account
- Available accounts
- Advanced fetching configuration
- Event configuration
- Mask configuration
- Account Configuration
- Host
- Port
- Protocol
- Encryption method
- Certificate validation
- Username
- Password
- Authentication method
- Proxy
- Proxy Configuration
- Socket
- Request full uri
- Username
- Password
- Advanced Configuration
- Folder / Mailbox delimiter
- Fetching method
- Communication sequence type
- Fetch message bodies
- Fetch message flags
- Message key identifier
- Message fetch order
- Message disposition types
- Common folders
- Message & Attachment decoding
- Legacy imap open options
- Event Configuration
- Message events
- Folder events
- Flag events
- Mask Configuration
- Message mask
- Attachment mask
- Base Configuration
- Examples
- Getting started
- oAuth using Google
- Connect using an application password
- Message pagination
- Proxy
- Api
- ClientManager
- New instance from config file
- New instance from array
- New preconfigured account
- Make a new client
- Get a specific config value
- Client
- Connect to the server
- Get the connection status
- Check the current connection
- Force reconnect
- Close connection
- List all available folders
- Find a folder by path
- Find a folder by name
- Find a folder by name or path
- Create new folder
- Get folder detail
- Folder
- New search query
- Check if the folder has sub folder
- Move a folder
- Delete a folder
- Idle connection
- Get folder detail
- Folder overview
- Query
- Get a specific message
- Get all messages
- Flag all fetched messages as read
- Don't flag all fetched messages as read
- Don't fetch the message body
- Limit the result
- Count the result
- Get a paginated result
- Set the sort order
- Get all messages from a specific sender
- Get all messages since a specific date
- Get all messages containing a specific text
- Alternative method names
- Search by excluding
- Chained search criteria
- Custom search criteria
- All available search criteria
- Message
- Check if a text body exists
- Check if an html body exists
- Get text body
- Get html body
- Get bodies
- Fetch body
- Get the containing folder
- Message thread
- Copy message
- Move message
- Delete message
- Restore message
- Get flags
- Add a new flag
- Remove a flag
- Check if the message has attachments
- Get all attachments
- Get raw body
- Get header
- Get all attributes
- Access attributes
- Attachment
- Save attachment
- Get mime type
- Get extension
- Get all attributes
- Access attributes
- Header
- Access attributes
- Find attribute
- Mask
- Calling a masked instance
- Create your own mask
- Event
- Available events
- Custom event
- Attribute
- Get String
- Get Array
- Check if value is contained
- Attach value
- Get first
- Get last
- Structure of an Attribute
- Address
- Get String
- Get Array
- Structure of an Address
- ClientManager
- Frameworks
- Laravel
- Installation
- Install php dependencies
- Install with composer
- Legacy support
- Older Laravel versions < 5.5
- Publish the configuration file
- Configuration
- Facade
- Events
- Commands
- Event driven
- Custom Command
- Service setup
- Installation
- Laravel
- Support
- Features & pull requests
- A little notice
- Security