https://github.com/timharek/migadu-deno
Deno module for Migadu.
https://github.com/timharek/migadu-deno
Last synced: 3 months ago
JSON representation
Deno module for Migadu.
- Host: GitHub
- URL: https://github.com/timharek/migadu-deno
- Owner: timharek
- License: gpl-3.0
- Created: 2023-07-05T13:29:09.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-23T23:02:31.000Z (over 1 year ago)
- Last Synced: 2025-02-18T06:46:57.049Z (3 months ago)
- Language: TypeScript
- Size: 94.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://builds.sr.ht/~timharek/migadu-deno/commits/.build.yml?)
[](https://github.com/timharek/migadu-deno)
# Migadu
A [Deno][deno] module that can access [Migadu's API][migadu].
There is also an CLI available. More documentaion is coming.
The following is not yet implemented:
- [Aliases](https://www.migadu.com/api/#aliases)
- [Rewrites](https://www.migadu.com/api/#rewrites) (not sure if I want to implement this)
## Usage
> [!WARNING]\
> Use at own risk. There are no confirmations when deleting mailboxes and identities
Remember to set environment variables:
- `MIGADU_DOMAIN`
- `MIGADU_USER`
- `MIGADU_USER_TOKEN`
### List all mailboxes
```typescript
import { Mailbox } from "https://deno.land/x/migadu/mod.ts";
const mailboxes = await Mailbox.list("example.org");
console.log(mailboxes);
```
## CLI
> [!NOTE]\
> You cannot update a mailbox or identity, yet. This is work in progress.
### Installation
```sh
deno install -A https://deno.land/x/migadu/src/cli/cli.ts \
-n migadu
```
### Usage
```sh
# List all mailboxes for domain
migadu mbox list --domain example.org
# Get mailbox from domain
migadu mbox get myName --domain example.org
# See help for all available commands
migadu --help
```
[deno]: https://deno.land
[migadu]: https://www.migadu.com/api/