Table of Contents


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