@marxlnfcs/wildduck-api
TypeScript icon, indicating that this package has built-in type declarations

1.2.3 • Public • Published

Wildduck API Client

A NodeJS client to communicate with the Wildduck API.

npm Snyk Vulnerabilities for npm package Website

Warning This library is still in progress and might have some bugs or features that are not working properly. If you find some bugs or missing/not working features, please feel free to create an issue.

You can find all endpoints here: Wildduck API Documentation

Installation

npm i @marxlnfcs/wildduck-api

Usage

import {createWildduckClient} from "./wildduck";

(async () => {

  // create a new client instance
  const client = createWildduckClient({
    baseUrl: 'http://api.wildduck.mail',
    accessToken: 'super-secret-access-key'
  });

  // intercept request for retrieving all users
  client.on(client.users.getUsers).subscribe((event) => {
    console.log(event.request); // AxiosRequestConfig
    console.log(event.response); // AxiosResponse
    console.log(event.error); // AxiosError
  });

  // list all users
  console.log(await client.users.getUsers());
  
});

Wildduck API Client

This simple client implements all Wildduck-API endpoints.

Features

  • Addresses
  • ApplicationPasswords
  • Archive
  • Archive
  • Audit
  • Authentication
  • AutoReplies
  • Certificates
  • DKIM
  • DomainAccess
  • DomainAliases
  • Filters
  • Mailboxes
  • Messages
  • Settings
  • Storage
  • Submission
  • TwoFactorAuth
  • Users
  • Webhooks
  • Exports

Configuration

createWildduckClient({
  baseUrl: string,
  accessToken: string,
  timeout?: number;
  proxy?: ClientProxySettings | string;
  rejectUnauthorized: boolean;
})

ClientOptions

Property Type Default Description
baseUrl string - URL to the wildduck api
accessToken string - Access token to authenticate with the wildduck api
timeout number null Defines the timeout of api requests in milliseconds
proxy ClientProxyOptions, string null Whether to use a proxy or not
rejectUnauthorized boolean true If false, the client rejects all unsecure https connections

ClientProxyOptions

Property Type Default Description
protocol http, https null Protocol the proxy uses
url string null Proxy URL
host string null Hostname of the proxy
port number null Port of the proxy
auth.username string null Username to authenticate with
auth.password string null Password to authenticate with

Readme

Keywords

Package Sidebar

Install

npm i @marxlnfcs/wildduck-api

Weekly Downloads

0

Version

1.2.3

License

MIT

Unpacked Size

271 kB

Total Files

118

Last publish

Collaborators

  • marxlnfcs