ts-mailcow-api 0.6.2 → 0.8.1

package/dist/types.d.ts

@@ -1,153 +1,547 @@
+/**
+ * Payloads should be JSONs.
+ */
 export declare type Payload = Record<string, any> | null;
-export declare type BaseDomainAttributes = {
+/**
+ * Base attributes of a domain.
+ */
+export interface BaseDomainAttributes {
+    /**
+     * The language code associated with this domain.
+     */
+    lang: 'sk' | 'cs' | 'de' | 'en' | 'es' | 'fr' | 'lv' | 'nl' | 'pl' | 'pt' | 'ru' | 'it' | 'ca';
+    /**
+     * Boolean if the domain is active.
+     */
     active: boolean;
+    /**
+     * Amount of aliases in the domain.
+     */
     aliases: number;
+    /**
+     * Boolean to relay domain or not.
+     */
     backupmx: number;
+    /**
+     * The predefined mailbox quota in add mailbox form
+     */
     defquota: number;
+    /**
+     * The description of the domain.
+     */
     description: string;
-    gal: boolean;
+    /**
+     * The limit count of mailboxes associated with this domain.
+     */
     mailboxes: number;
+    /**
+     * The maximum quota per mailbox.
+     */
     maxquota: number;
+    /**
+     * The maximum quota for this domain (sum of all mailboxes).
+     */
     quota: number;
+    /**
+     * If not, then you have to create "dummy" mailbox for each address to relay
+     */
     relay_all_recipients: boolean;
-};
+}
+/**
+ * Relay interval settings.
+ */
 declare type RelayFrame = 's' | 'm' | 'h' | 'd';
-export declare type DomainPostRequest = BaseDomainAttributes & {
+/**
+ * Domain creation payload.
+ */
+export interface DomainPostRequest extends BaseDomainAttributes {
+    /**
+     * The domain to create.
+     */
     domain: string;
+    /**
+     * The frame of the relay setting.
+     */
     rl_frame: RelayFrame;
+    /**
+     * The value of the relay setting.
+     */
     rl_value: number;
+    /**
+     * If true: sogo will restart after domain creation.
+     */
     restart_sogo: boolean;
-};
+}
+/**
+ * Domain delete request.
+ */
 export interface DomainDeleteRequest {
+    /**
+     * List of domains to delete.
+     */
     domains: string[];
 }
-export declare type DomainEditAttributes = BaseDomainAttributes & {
+/**
+ * All attributes of the domain you can edit.
+ */
+export interface DomainEditAttributes extends BaseDomainAttributes {
+    /**
+     *  Is domain global address list active or not, it enables shared contacts across domain in SOGo webmail
+     */
+    gal: boolean;
+    /**
+     * Id of the relayhost.
+     */
     relayhost: number;
-};
+}
+/**
+ * Domain edit request.
+ */
 export interface DomainEditRequest {
+    /**
+     * Possible attributes you can edit.
+     */
     attr: Partial<DomainEditAttributes>;
+    /**
+     * Domains you wish to edit.
+     */
     items: string | string[];
 }
-export interface DomainResponse {
+/**
+ * Interface of the Domain as returned by Mailcow.
+ */
+export interface Domain {
+    /**
+     * 0 = False, 1 = True.
+     */
     active: number;
+    /**
+     * Amount of aliases in this domain.
+     */
     aliases_in_domain: number;
+    /**
+     * Amount of aliases remaining in the alias quota.
+     */
     aliases_left: number;
-    backupmx: boolean;
-    bytes_total: number;
-    def_new_mailbox_quota: number;
-    def_quota_for_mbox: number;
+    /**
+     * If backupmx is activated.
+     */
+    backupmx?: boolean;
+    /**
+     * Total amount of bytes used by this domain.
+     */
+    bytes_total?: number;
+    /**
+     * New mailbox quota.
+     */
+    def_new_mailbox_quota?: number;
+    /**
+     * Quota for a mailbox.
+     */
+    def_quota_for_mbox?: number;
+    /**
+     * Description of the domain.
+     */
     description: string;
+    /**
+     * Name of the domain.
+     */
     domain_name: string;
+    /**
+     *  Is domain global address list active or not, it enables shared contacts across domain in SOGo webmail
+     */
     gal: boolean;
-    max_new_mailbox_quota: string;
-    max_num_aliases_for_domain: number;
+    /**
+     * Max quota for new mailboxes.
+     */
+    max_new_mailbox_quota?: string;
+    /**
+     * Max quota aliases on this domain.
+     */
+    max_num_aliases_for_domain?: number;
+    /**
+     * Max number of mailboxes in this domain.
+     */
     max_num_mboxes_for_domain: number;
+    /**
+     * Max quota for this domain.
+     */
     max_quota_for_domain: number;
+    /**
+     * Max quota for a mailbox.
+     */
     max_quota_for_mbox: number;
+    /**
+     * Amount of mailboxes in this domain.
+     */
     mboxes_in_domain: number;
+    /**
+     * Amount of mailboxes left in the quota.
+     */
     mboxes_left: number;
+    /**
+     * Amount of total messages in this domain.
+     */
     msgs_total: number;
+    /**
+     * Quota used in this domain.
+     */
     quota_used_in_domain: number;
-    relay_all_recipients: boolean;
-    relayhost: boolean;
+    /**
+     * If all mails are relayed.
+     */
+    relay_all_recipients?: boolean;
+    /**
+     * Id of the relay host
+     */
+    relayhost?: number;
+    /**
+     * If the domain is relayed.
+     */
     rl: boolean | {
         value: string;
         frame: string;
     };
+    /**
+     * If XMPP is enable.d
+     */
     xmpp: boolean;
+    /**
+     * The XMPP prefix.
+     */
     xmpp_prefix: string;
-    gal_int: boolean;
-    active_int: boolean;
+    /**
+     * Integer representation of the boolean.
+     */
+    gal_int: number;
+    /**
+     * Integer representation of the boolean.
+     */
+    active_int: number;
+    /**
+     * Integer representation of the boolean.
+     */
     relay_all_recipients_int: boolean;
+    /**
+     * If the domain should only relay unknown adresses.
+     */
     relay_unknown_only: boolean;
+    /**
+     * Integer representation of the boolean.
+     */
     relay_unknown_only_int: boolean;
+    /**
+     * List of domain admins
+     */
     domain_admins: string[];
 }
+/**
+ * Antispam policy creation request.
+ */
 export interface SpamPolicyPostRequest {
+    /**
+     * Domain for which the policies applies.
+     */
     domain: string;
+    /**
+     * The 'from' parameter off the antispam policy
+     */
     object_from: string;
+    /**
+     * Use 'wl' for whitelist and 'bl' for blacklist.
+     */
     object_list: 'wl' | 'bl';
 }
+/**
+ * Antispam deletion request.
+ */
 export interface SpamPolicyDeleteRequest {
+    /**
+     * IDs of the policies to delete.
+     */
     prefid: number[];
 }
+/**
+ * Antispam policy get request.
+ */
 export interface SpamPolicyGetRequest {
+    /**
+     * Use 'wl' to get whitelist policies and use 'bl' to get blacklist policies.
+     */
     type: 'wl' | 'bl';
+    /**
+     * The exact address or use wildcard to match whole domain.
+     */
     domain: string;
 }
-export interface SpamPolicyResponse {
+/**
+ * Interface of the Antispam Policy as returned by Mailcow.
+ */
+export interface SpamPolicy {
+    /**
+     * The domain of the policy.
+     */
     object: string;
+    /**
+     * The address of the policy.
+     */
     value: string;
+    /**
+     * The ID of the policy.
+     */
     prefid: number;
 }
-export declare type BaseMailboxAttributes = {
+/**
+ * Base attributes of a mailbox.
+ */
+export interface BaseMailboxAttributes {
+    /**
+     * Boolean if the mailbox is active.
+     */
     active: boolean;
+    /**
+     * Boolean if the user is forced to update their password on login.
+     */
     force_pw_update: boolean;
+    /**
+     * The ull name of the mailbox user.
+     */
     name: string;
+    /**
+     * The mailbox password.
+     */
     password: string;
+    /**
+     * The mailbox password for confirmation.
+     */
     password2: string;
+    /**
+     * The mailbox quota.
+     */
     quota: number;
-};
+}
+/**
+ * Mailbox creation request.
+ */
 export interface MailboxPostRequest extends BaseMailboxAttributes {
+    /**
+     * The domain of the mailbox.
+     */
     domain: string;
+    /**
+     * The local part of the mailbox.
+     */
     local_part: string;
+    /**
+     * Boolean if inbound email encryption is forced.
+     */
     tls_enforce_in: boolean;
+    /**
+     * Boolean if outbound email encryption is forced.
+     */
     tls_enforce_out: boolean;
 }
+/**
+ * Mailbox deletion request.
+ */
 export interface MailboxDeleteRequest {
-    domains: string[];
+    /**
+     * List of mailboxes to delete.
+     */
+    mailboxes: string[];
 }
-export declare type MailboxEditAttributes = BaseMailboxAttributes & {
+/**
+ * Attributes of the mailbox you can edit.
+ */
+export interface MailboxEditAttributes extends BaseMailboxAttributes {
+    /**
+     * List of allowed send from addresses.
+     */
     sender_acl: string[];
+    /**
+     * Boolean iff mailbox has SOGo acces.
+     */
     sogo_access: boolean;
-};
+}
+/**
+ * Mailbox update request.
+ */
 export interface MailboxEditRequest {
+    /**
+     * List of attributes you wish to update.
+     */
     attr: Partial<MailboxEditAttributes>;
+    /**
+     * List of mailboxes to edit.
+     */
     items: string[];
 }
+/**
+ * Possible options for the Quarantine time frames.
+ */
 declare type QuarantineSchedule = 'hourly' | 'daily' | 'weekly' | 'never';
+/**
+ * Options of what should happen if email is quarantined.
+ */
 declare type QuarantineCategory = 'reject' | 'add_header' | 'all';
-export interface MailboxResponse {
+/**
+ * Interface of the Mailbox as returned by Mailcow.
+ */
+export interface Mailbox {
+    /**
+     * The full mailbox name, equal to local_part@domain
+     */
     username: string;
+    /**
+     * Boolean if the mailbox is active.
+     */
     active: boolean;
-    active_int: boolean;
+    /**
+     * Int representation of the boolean.
+     */
+    active_int: number;
+    /**
+     * Domain of the mailbox.
+     */
     domain: string;
-    domain_xmpp: boolean;
+    /**
+     * Boolean if XMPP is enabled for this domain.
+     */
+    domain_xmpp?: boolean;
+    /**
+     * Name of the user belonging to the mailbox.
+     */
     name: string;
-    domain_xmpp_prefix: string;
+    /**
+     * The prefix used for the XMPP login.
+     */
+    domain_xmpp_prefix?: string;
+    /**
+     * The local part of the mailbox.
+     */
     local_part: string;
+    /**
+     * The quota of the mailbox.
+     */
     quota: number;
-    messages: boolean;
+    /**
+     * Amount of messages in the mailbox.
+     */
+    messages: number;
+    /**
+     * Attributes belonging to this mailbox
+     */
     attributes: {
+        /**
+         * Boolean if the user is forced to update their password on login.
+         */
         force_pw_update: boolean;
+        /**
+         * Boolean if inbound email encryption is forced.
+         */
         tls_enforce_in: boolean;
+        /**
+         * Boolean if outbound email encryption is forced.
+         */
         tls_enforce_out: boolean;
+        /**
+         * Boolean if mailbox has SOGo acces.
+         */
         sogo_access: boolean;
+        /**
+         * Boolean if mailbox has IMAP acces.
+         */
         imap_access: boolean;
+        /**
+         * Boolean if mailbox has POP3 acces.
+         */
         pop3_access: boolean;
+        /**
+         * Boolean if mailbox has SMTP acces.
+         */
         smtp_access: boolean;
+        /**
+         * Boolean if mailbox has XMPP acces.
+         */
         xmpp_access: boolean;
+        /**
+         * Boolean if mailbox is XMPP admin.
+         */
         xmpp_admin: boolean;
+        /**
+         * The format of the mailbox.
+         */
         mailbox_format: string;
+        /**
+         * The schedule on which the mailbox gets quarantine notifications.
+         */
         quarantine_notification: QuarantineSchedule;
+        /**
+         * What happens with the quarantined emails.
+         */
         quarantine_category: QuarantineCategory;
     };
-    quota_used: boolean;
-    percent_in_use: boolean;
-    last_imap_login: boolean;
-    last_smtp_login: boolean;
-    last_pop3_login: boolean;
-    percent_class: string;
+    /**
+     * Amount of quota used.
+     */
+    quota_used: number;
+    /**
+     * Percentage of mailbox quota used.
+     */
+    percent_in_use: number;
+    /**
+     * Last IMAP login time in epoch timestamp..
+     */
+    last_imap_login: number;
+    /**
+     * Last SMTP login time in epoch timestamp..
+     */
+    last_smtp_login: number;
+    /**
+     * Last POP3 login time in epoch timestamp..
+     */
+    last_pop3_login: number;
+    /**
+     * Class representation of quota usage.
+     */
+    percent_class: 'success' | 'warning' | 'danger';
+    /**
+     * Maximum possible quota.
+     */
     max_new_quota: number;
-    spam_aliases: boolean;
+    /**
+     * Amount of spam aliases belonging to this mailbox.
+     */
+    spam_aliases: number;
+    /**
+     * Boolean if pushover is active.
+     */
     pushover_active: boolean;
+    /**
+     * Relay settings.
+     */
     rl: {
+        /**
+         * Value of the frame settings.
+         */
         value: number;
+        /**
+         * Relay interval.
+         */
         frame: RelayFrame;
     };
+    /**
+     * Scope of the relay.
+     */
     rl_scope: string;
+    /**
+     * Boolean if the mailbox is relayed.
+     */
     is_relayed: boolean;
 }
+/**
+ * Pushover settings interface.
+ */
 export interface PushoverEditAttributes {
     active: boolean;
     evaluate_x_prio: boolean;
@@ -159,32 +553,83 @@ export interface PushoverEditAttributes {
     title: string;
     token: string;
 }
+/**
+ * Pushover edit payload.
+ */
 export interface PushoverEditRequest {
+    /**
+     * The attributes to edit.
+     */
     attr: Partial<PushoverEditAttributes>;
-    items: string;
+    /**
+     * List of mailboxes to edit.
+     */
+    items: string | string[];
 }
+/**
+ * Quarantaine notification edit payload.
+ */
 export interface QuarantaineEditRequest {
+    /**
+     * The attributes to edit.
+     */
     attr: {
+        /**
+         * How often quarantine notifications should be sent.
+         */
         quarantine_notification: QuarantineSchedule;
     };
+    /**
+     * The mailboxes to edit.
+     */
     items: {
-        anyOf: string[];
+        anyOf: string | string[];
     };
 }
+/**
+ * Spam score edit payload.
+ */
 export interface SpamScoreEditRequest {
-    items: string[];
+    /**
+     * Mailboxes to edit.
+     */
+    items: string | string[];
+    /**
+     * The attributes to edit.
+     */
     attr: {
+        /**
+         * The spamscore to set, should be of the form 'lowerbound, upperbound'.
+         */
         spam_score: string;
     };
 }
+/**
+ * List of possible userACL.
+ */
 declare type userAcl = 'spam_alias' | 'tls_policy' | 'spam_score' | 'spam_policy' | 'delimiter_action' | 'syncjobs' | 'eas_reset' | 'quarantine' | 'sogo_profile_reset' | 'quarantine_attachments' | 'quarantine_notification' | 'app_passwds' | 'pushover';
+/**
+ * ACL Edit payload.
+ */
 export interface ACLEditRequest {
-    items: string[];
+    /**
+     * Mailboxes to edit.
+     */
+    items: string | string[];
+    /**
+     * Attributes to set.
+     */
     attr: {
+        /**
+         * List of ACLs to set.
+         */
         user_acl: userAcl[];
     };
 }
-export declare type AliasAttributes = {
+/**
+ * Base attributes of an Alias.
+ */
+export interface AliasAttributes {
     /**
      * The alias address, for catchall use "@domain.tld".
      */
@@ -213,32 +658,636 @@ export declare type AliasAttributes = {
      * If alias is active or not.
      */
     active: boolean;
-};
-export declare type AliasEditAttributes = Partial<AliasAttributes> & {
+}
+/**
+ * All attributes of an Alias you can edit.
+ */
+export interface AliasEditAttributes extends Partial<AliasAttributes> {
+    /**
+     * The private comment of the alias.
+     */
     private_comment?: string;
+    /**
+     * The public comment of the alias.
+     */
     public_comment?: string;
-};
+}
+/**
+ * Alias post payload.
+ */
 export declare type AliasPostRequest = AliasAttributes;
-export interface AliasUpdateRequest {
-    items: number[];
+/**
+ * Alias update payload.
+ */
+export interface AliasEditRequest {
+    /**
+     * List of IDs of the aliases to update.
+     */
+    items: number | number[];
+    /**
+     * The attributes to set.
+     */
     attr: AliasEditAttributes;
 }
+/**
+ * Alias delete payload.
+ */
 export interface AliasDeleteRequest {
+    /**
+     * List of IDs of the aliases to delete.
+     */
     items: number[];
 }
+/**
+ * Interface of the Alias as returned by Mailcow.
+ */
 export interface Alias extends AliasAttributes {
     in_primary_domain: string;
+    /**
+     * The ID of the alias.
+     */
     id: number;
+    /**
+     * The domain of the alias.
+     */
     domain: string;
+    /**
+     * The public comment of the alias.
+     */
     public_comment: string;
+    /**
+     * The private comment of the alias.
+     */
     private_comment: string;
+    /**
+     * Boolean if the Alias is a catch-all.
+     */
     is_catch_all: boolean;
+    /**
+     * Int representation of the boolean.
+     */
     active_int: number;
+    /**
+     * Int representation of the boolean.
+     */
     sogo_visible_int: number;
+    /**
+     * Creation date of the alias.
+     */
     created: string;
+    /**
+     * Last modified date of the alias.
+     */
     modified: string | null;
 }
+/**
+ * All the attributes of a sync job.
+ */
+export interface SyncjobAttributes {
+    /**
+     * Your local mailcow mailbox.
+     */
+    username: string;
+    /**
+     * The smtp server where mails should be synced from.
+     */
+    host1: string;
+    /**
+     * The smtp port of the target mail server.
+     */
+    port1: number;
+    /**
+     * The password of the mailbox.
+     */
+    password1: string;
+    /**
+     * The target email account.
+     */
+    user1: string;
+    /**
+     * The encryption method used to connect to the mailserver.
+     */
+    enc1: 'TLS' | 'SSL' | 'PLAIN';
+    /**
+     * The interval in which messages should be synced.
+     */
+    mins_interval: number;
+    /**
+     * Sync into subfolder on destination (empty = do not use subfolder).
+     */
+    subfolder2: string;
+    /**
+     * Only sync messages up to this age in days.
+     */
+    maxage: number;
+    /**
+     * Max speed transfer limit for the sync.
+     */
+    maxbytespersecond: number;
+    /**
+     * Timeout for connection to remote host.
+     */
+    timeout1: number;
+    /**
+     * Timeout for connection to local host.
+     */
+    timeout2: number;
+    /**
+     * Exclude objects (regex).
+     */
+    exclude: string;
+    /**
+     * Custom parameters.
+     */
+    custom_params: string;
+    /**
+     * Delete duplicates on destination (--delete2duplicates).
+     */
+    delete2duplicates: boolean;
+    /**
+     * Delete from source when completed (--delete1).
+     */
+    delete1: boolean;
+    /**
+     * Delete messages on destination that are not on source (--delete2).
+     */
+    delete2: boolean;
+    /**
+     * Try to automap folders ("sent items", "sent" => "sent" etc.) (--automap).
+     */
+    automap: boolean;
+    /**
+     * Skip duplicate messages across folders (first come, first serve) (--skipcrossduplicates).
+     */
+    skipcrossduplicates: boolean;
+    /**
+     * Subscribe all folders (--subscribeall).
+     */
+    subscribeall: boolean;
+    /**
+     * Enables or disables the sync job.
+     */
+    active: boolean;
+}
+/**
+ * Sync job creation payload.
+ */
+export declare type SyncjobPostRequest = SyncjobAttributes;
+/**
+ * Sync job delete payload.
+ */
+export interface SyncjobDeleteRequest {
+    /**
+     * Array of IDs to delete.
+     */
+    items: number[];
+}
+export declare type SyncjobEditAttributes = Partial<SyncjobAttributes>;
+/**
+ * Sync job update payload.
+ */
+export interface SyncjobUpdateRequest {
+    /**
+     * The attributes to set.
+     */
+    attr: SyncjobEditAttributes;
+    /**
+     * List of IDs to update.
+     */
+    items: number | number[];
+}
+/**
+ * Sync job as returned by the Mailcow API.
+ */
+export interface Syncjob {
+    /**
+     * Enables or disables the sync job.
+     */
+    active: boolean;
+    /**
+     * MD5 hash of the authentication.
+     */
+    authmd51: boolean;
+    /**
+     * Authentication mechanism.
+     */
+    authmech1: 'TLS' | 'SSL' | 'PLAIN';
+    /**
+     * Try to automap folders ("sent items", "sent" => "sent" etc.) (--automap).
+     */
+    automap: boolean;
+    /**
+     * Creation date in epoch.
+     */
+    created: string;
+    /**
+     * Custom parameters.
+     */
+    custom_params: string;
+    /**
+     * Delete from source when completed (--delete1).
+     */
+    delete1: boolean;
+    /**
+     * Delete messages on destination that are not on source (--delete2).
+     */
+    delete2: boolean;
+    /**
+     * Delete duplicates on destination (--delete2duplicates).
+     */
+    delete2duplicates: boolean;
+    /**
+     * Target domain.
+     */
+    domain2: string;
+    /**
+     * The encryption method used to connect to the mailserver.
+     */
+    enc1: 'TLS' | 'SSL' | 'PLAIN';
+    /**
+     * Exclude objects (regex).
+     */
+    exclude: string;
+    /**
+     * The smtp server where mails should be synced from.
+     */
+    host1: string;
+    /**
+     * ID of the sync job.
+     */
+    id: number;
+    /**
+     * If the sync job is currently running.
+     */
+    is_running: boolean;
+    /**
+     * Date of the last run.
+     */
+    last_run: string;
+    /**
+     * Logfile
+     */
+    log: string;
+    /**
+     * Only sync messages up to this age in days.
+     */
+    maxage: number;
+    /**
+     * Max speed transfer limit for the sync.
+     */
+    maxbytespersecond: number;
+    /**
+     * The interval in which messages should be synced.
+     */
+    mins_interval: number;
+    /**
+     * Last modified date of the sync job..
+     */
+    modified: string | null;
+    /**
+     * Port of the source server.
+     */
+    port1: number;
+    /**
+     * Regex.
+     */
+    regextrans2: string;
+    /**
+     * If cross duplicates should be skipped.
+     */
+    skipcrossduplicates: boolean;
+    /**
+     * Subfolder on target server.
+     */
+    subfolder2: string;
+    /**
+     * If the sync job is subscribed to all mailboxes.
+     */
+    subscribeall: boolean;
+    /**
+     * Timeout for connection to remote host.
+     */
+    timeout1: number;
+    /**
+     * Timeout for connection to local host.
+     */
+    timeout2: number;
+    /**
+     * User on the remote host.
+     */
+    user1: string;
+    /**
+     * User on the local host.
+     */
+    user2: string;
+}
+/**
+ * Forwarding host creation payload.
+ */
+export interface ForwardingCreateRequest {
+    /**
+     * True to enable spam filter, false to disable spam filter.
+     */
+    filter_spam: boolean;
+    /**
+     * Contains the hostname you want to add.
+     */
+    hostname: string;
+}
+/**
+ * Forwarding host deletion payload.
+ */
+export interface ForwardingDeleteRequest {
+    /**
+     * IPs of the forwarding hosts to delete.
+     */
+    items: string[];
+}
+/**
+ * Forwarding host as returned by the Mailcow API.
+ */
+export interface ForwardingHost {
+    /**
+     * IP of the forwarding host.
+     */
+    host: string;
+    /**
+     * If the host keeps or discards spam.
+     */
+    keep_spam: 'yes' | 'no';
+    /**
+     * Hostname.
+     */
+    source: string;
+}
+/**
+ * Base Log interface
+ */
+export interface Log {
+    /**
+     * Timestamp in Epoch format.
+     */
+    time: number;
+}
+export interface ACMELog extends Log {
+    /**
+     * Log message.
+     */
+    message: string;
+}
+/**
+ * API Log item.
+ */
+export interface APILog extends Log {
+    /**
+     * Payload used in the API call.
+     */
+    data: string;
+    /**
+     * Request method.
+     */
+    method: 'GET' | 'POST';
+    /**
+     * IP that did the call.
+     */
+    remote: string;
+    /**
+     * API Route used.
+     */
+    uri: string;
+}
+/**
+ * Autodiscover log item.
+ */
+export interface ADLog extends Log {
+    /**
+     * Service used.
+     */
+    service: string;
+    /**
+     * User agent.
+     */
+    ua: string;
+    /**
+     * The user.
+     */
+    user: string;
+}
+/**
+ * Dovecot log item.
+ */
+export interface DCLog extends Log {
+    /**
+     * The dovecot log message.
+     */
+    message: string;
+    /**
+     * The dovecot priority level.
+     */
+    priority: string;
+    /**
+     * Program used.
+     */
+    program: string;
+}
+/**
+ * Netfilter log item.
+ */
+export interface NFLog extends Log {
+    /**
+     * The netfilter message.
+     */
+    message: string;
+    /**
+     * The netfilter priority level.
+     */
+    priority: string;
+}
+/**
+ * Postfix log item.
+ */
+export interface PFLog extends Log {
+    /**
+     * The Postfix log message.
+     */
+    message: string;
+    /**
+     * The Postfix priority level.
+     */
+    priority: string;
+    /**
+     * Program used.
+     */
+    program: string;
+}
+/**
+ * Ratelimited log item.
+ */
+export interface RLLog extends Log {
+    /**
+     * From email adress.
+     */
+    from: string;
+    /**
+     * Header of the from field.
+     */
+    header_from: string;
+    /**
+     * Header of the subject field.
+     */
+    header_subject: string;
+    /**
+     * IP of the sender.
+     */
+    ip: string;
+    /**
+     * ID of the message.
+     */
+    message_id: string;
+    /**
+     * QID of the message.
+     */
+    qid: string;
+    /**
+     * Recipient of the message.
+     */
+    rcpt: string;
+    /**
+     * Ratelimit hash.
+     */
+    rl_hash: string;
+    /**
+     * Ratelimit info
+     */
+    rl_info: string;
+    /**
+     * Ratelimit name
+     */
+    rl_name: string;
+    /**
+     * Sender of the message.
+     */
+    user: string;
+}
+/**
+ * Rspamd log item.
+ */
+export interface RSLog extends Log {
+    /**
+     * What happend to the message.
+     */
+    action: string;
+    /**
+     * Size of the message.
+     */
+    size: string;
+    /**
+     * Array of recipients SMTPs.
+     */
+    rcpt_smtp: string[];
+    /**
+     * Array of recipients MIME.
+     */
+    rcpt_mime: string[];
+    /**
+     * Object containing all the Rspamd scoring info.
+     */
+    symbols: object;
+    /**
+     * Score needed to pass.
+     */
+    required_score: string;
+    /**
+     * Message ID
+     */
+    'message-id': string;
+    /**
+     * IP of the sender
+     */
+    ip: string;
+    /**
+     * Name of the user
+     */
+    user: string;
+    /**
+     * Time used.
+     */
+    time_real: string;
+    /**
+     * SMTP of the receiver.
+     */
+    sender_smtp: string;
+    /**
+     * If the message was skipped.
+     */
+    is_skipped: boolean;
+    /**
+     * Score of the message
+     */
+    score: number;
+    /**
+     * MIME of the sender.
+     */
+    sender_mime: string;
+    /**
+     * EPOCH time stamp.
+     */
+    unix_time: number;
+    /**
+     * Subject of the e-mail.
+     */
+    subject: string;
+}
+/**
+ * SOGo log item.
+ */
+export interface SGLog extends Log {
+    /**
+     * The log message.
+     */
+    message: string;
+    /**
+     * The priority level.
+     */
+    priority: string;
+    program: 'sogod';
+}
+/**
+ * Watchdog log item.
+ */
+export interface WDLog extends Log {
+    /**
+     * Difference with previous health.
+     */
+    hpdiff: number;
+    /**
+     * Current health
+     */
+    hpnow: number;
+    /**
+     * Total health.
+     */
+    hptotal: number;
+    /**
+     * Level of the service
+     */
+    lvl: number;
+    /**
+     * Service being watched
+     */
+    service: string;
+    /**
+     * Time of report in Epoch.
+     */
+    time: number;
+}
+/**
+ * Error class used for exception handling.
+ */
 export declare class MailcowException extends Error {
+    /**
+     * The error message provided by Mailcow.
+     */
     message: string;
 }
 /**
@@ -251,7 +1300,13 @@ export interface BaseResponse {
     msg: string[] | string;
     type: 'succes' | 'danger' | 'error';
 }
-export declare type MailcowResponse<T = BaseResponse> = T[];
+/**
+ * Mailcow API calls returns an array of Base Responses.
+ */
+export declare type MailcowResponse = BaseResponse[];
+/**
+ * Interface for when the API called returned an Error.
+ */
 export interface MailcowErrorResponse extends MailcowResponse {
     msg: string;
 }