https://github.com/conjoon/extjs-app-imapuser
conjoon application module for providing user authentication against an imap server.
https://github.com/conjoon/extjs-app-imapuser
conjoon coon-js coonjs extjs imap sencha user
Last synced: 12 months ago
JSON representation
conjoon application module for providing user authentication against an imap server.
- Host: GitHub
- URL: https://github.com/conjoon/extjs-app-imapuser
- Owner: conjoon
- License: mit
- Created: 2019-03-16T09:57:46.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2023-07-19T04:27:17.000Z (almost 3 years ago)
- Last Synced: 2025-05-21T18:16:47.605Z (about 1 year ago)
- Topics: conjoon, coon-js, coonjs, extjs, imap, sencha, user
- Language: JavaScript
- Homepage:
- Size: 1.67 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# @conjoon/extjs-app-imapuser  [](https://badge.fury.io/js/@conjoon%2Fextjs-app-imapuser)
conjoon application module for providing user authentication against an imap server.
## About
This package supports [rest-api-email](https:://github.com/conjoon/rest-api-description) for authenticating
a user against an IMAP server, where the sign-in crendentials for an IMAP-account are the login-information
submitted via this package's login form.
It is best suited for ISPs who wish to enable webmail services for their clients based on single account information.
## Installation
```bash
$ npm i @conjoon/extjs-app-imapuser
```
If you want to develop with this package, run the `build:dev`-script:
```bash
$ npm run build:dev
```
Testing environment will be available via. Please refer to the [README](./tests/README.md) found in the test-folder
for further information.
```bash
$ npm test
```
For using the package as an external dependency in an application:
In your `app.json`, add this package as a requirement, and make sure your ExtJS `workspace.json`
is properly configured to look up local repositories in the `node_modules`-directory.
Example (`workspace.json`) :
```json
{
"packages": {
"dir": "${workspace.dir}/node_modules/@l8js,${workspace.dir}/node_modules/@conjoon,${workspace.dir}/node_modules/@coon-js,${workspace.dir}/packages/local,${workspace.dir}/packages,${workspace.dir}/node_modules/@sencha/ext-${toolkit.name},${workspace.dir}/node_modules/@sencha/ext-${toolkit.name}-treegrid,${workspace.dir}/node_modules/@sencha/ext-${toolkit.name}-theme-base,${workspace.dir}/node_modules/@sencha/ext-${toolkit.name}-theme-ios,${workspace.dir}/node_modules/@sencha/ext-${toolkit.name}-theme-material,${workspace.dir}/node_modules/@sencha/ext-${toolkit.name}-theme-aria,${workspace.dir}/node_modules/@sencha/ext-${toolkit.name}-theme-neutral,${workspace.dir}/node_modules/@sencha/ext-${toolkit.name}-theme-classic,${workspace.dir}/node_modules/@sencha/ext-${toolkit.name}-theme-gray,${workspace.dir}/node_modules/@sencha/ext-${toolkit.name}-theme-crisp,${workspace.dir}/node_modules/@sencha/ext-${toolkit.name}-theme-crisp-touch,${workspace.dir}/node_modules/@sencha/ext-${toolkit.name}-theme-neptune,${workspace.dir}/node_modules/@sencha/ext-${toolkit.name}-theme-neptune-touch,${workspace.dir}/node_modules/@sencha/ext-${toolkit.name}-theme-triton,${workspace.dir}/node_modules/@sencha/ext-${toolkit.name}-theme-graphite,${workspace.dir}/node_modules/@sencha/ext-${toolkit.name}-theme-material,${workspace.dir}/node_modules/@sencha/ext-calendar,${workspace.dir}/node_modules/@sencha/ext-charts,${workspace.dir}/node_modules/@sencha/ext-d3,${workspace.dir}/node_modules/@sencha/ext-exporter,${workspace.dir}/node_modules/@sencha/ext-pivot,${workspace.dir}/node_modules/@sencha/ext-pivot-d3,${workspace.dir}/node_modules/@sencha/ext-ux,${workspace.dir}/node_modules/@sencha/ext-font-ios",
"extract": "${workspace.dir}/packages/remote"
}
}
```
Update the `app.json` of the application by specifying this package in the `uses`-property in
either the `development` and/or `prodution` section:
*Example:*
```json
{
"development": {
"uses": [
"extjs-dev-imapusersim",
"extjs-app-imapuser",
"extjs-app-webmail",
"extjs-dev-webmailsim"
]
},
"production": {
"uses": [
"extjs-app-imapuser",
"extjs-app-webmail"
]
}
}
```
## Configuration and Usage
For more information on how to configure and use the package, refer to the [documentation](./docs/README.md).
## Tests
Tests are written with [Siesta](https://bryntum.com/siesta). Documentation can be found [here](./tests/README.md).