The recommended way to install lumen-app-email is by using composer create-project:

composer create-project {packageName} {targetDirectory} {version}

The install tool of lumen-app-email requires Composer >= V2.0.

The following command will install an instance of lumen-app-email along with its dependencies into the directory htdocs relative to the current working directory:

$ composer create-project conjoon/lumen-app-email htdocs "1.*" 

Once composer has finished downloading and installing the project, the post-create-project-cmd will automatically invoke php artisan install, the installation script for lumen-app-email. Please refer to the subsequent documentation for further details about the configuration options available:

1. Available CLI commands
   1. Setting up CORS
   2. Configuring IMAP servers
2. Troubleshooting & Known Issues

A pre-configured container for running an instance of lumen-app-email is also available and can be found at conjoon/ddev-ms-email.

The default distribution of lumen-app-emails contains an .htaccess-file containing rewrite rules for properly routing API paths when using an Apache HTTP Server. If you want to use nginx, you can apply the following configuration to make sure requests are properly routed.

Assuming lumen-app-email is installed in ./htdocs - relative to the (virtual) server's root-dir:

location /htdocs {
    try_files $uri $uri/ /htdocs/app/public/index.php?$query_string;
}