Created syncjob-endpoints.ts

Author: JustSamuel

README.md

@@ -7,7 +7,7 @@ Create a new wrapper using the base url and API_KEY.
 import MailCowClient from "./index";
 
 // Create MailCowClient based on BASE_URL and API_KEY
-const mcc = new MailCowClient("https://demo.mailcow.email/api/v1", "390448-22B69F-FA37D9-19701B-6F033F");
+const mcc = new MailCowClient("https://demo.mailcow.email/", "390448-22B69F-FA37D9-19701B-6F033F");
 ```
 Then you can use the created wrapper for promised-based API calls according to the Mailcow API specification.
 ```ts
@@ -51,10 +51,10 @@ mcc.mailbox.get().then((e) => {
 - [x] Get aliases
 
 ### Sync Jobs
-- [ ] Create sync job
-- [ ] Delete sync job
-- [ ] Update sync job
-- [ ] Get sync jobs
+- [x] Create sync job
+- [x] Delete sync job
+- [x] Update sync job
+- [x] Get sync jobs
 
 ### Forwarding Hosts
 - [ ] Add Forward Host
@@ -144,4 +144,4 @@ mcc.mailbox.get().then((e) => {
 - [ ] Get mailbox ratelimits
 - [ ] Get domain ratelimits
 - [ ] Edit domain ratelimits
-- [ ] Edit mailbox ratelimits
+- [ ] Edit mailbox ratelimits

src/Endpoints/antispam-endpoints.ts

@@ -21,7 +21,7 @@ export interface AntiSpamEndpoints {
    * Endpoint for creating antispam policies.
    * @param payload - The creation payload.
    */
-    create(payload: SpamPolicyPostRequest): Promise<MailcowResponse>
+  create(payload: SpamPolicyPostRequest): Promise<MailcowResponse>
 
   /**
    * Endpoint for deleting antispam policies.

src/Endpoints/syncjob-endpoints.ts

@@ -0,0 +1,55 @@
+import MailcowClient from "../index";
+import { MailcowResponse, Syncjob, SyncjobDeleteRequest, SyncjobPostRequest, SyncjobUpdateRequest } from "../types";
+
+export interface SyncjobEndpoints {
+  /**
+   * Endpoint for creating sync jobs.
+   * @param payload - The creation payload.
+   */
+  create(payload: SyncjobPostRequest): Promise<MailcowResponse>
+
+  /**
+   * Endpoint for editing sync jobs.
+   * @param payload - The edit payload.
+   */
+  edit(payload: SyncjobUpdateRequest): Promise<MailcowResponse>
+
+  /**
+   * Endpoint for deleting sync jobs
+   * @param payload - The deletion payload.
+   */
+  delete(payload: SyncjobDeleteRequest): Promise<MailcowResponse>
+
+  /**
+   * Endpoint for getting all sync jobs.
+   */
+  getAll(): Promise<Syncjob[]>
+}
+
+export function syncjobEndpoints(bind: MailcowClient): SyncjobEndpoints {
+  return {
+    getAll(): Promise<Syncjob[]> {
+      return bind.requestFactory.get<Syncjob[]>(
+        '/api/v1/get/syncjobs/all/no_log'
+      )
+    },
+    create(payload: SyncjobPostRequest): Promise<MailcowResponse> {
+      return bind.requestFactory.post<MailcowResponse>(
+        '/api/v1/add/syncjob',
+        payload
+      )
+    },
+    edit(payload: SyncjobUpdateRequest): Promise<MailcowResponse> {
+      return bind.requestFactory.post<MailcowResponse>(
+        '/api/v1/edit/syncjob',
+        payload
+      )
+    },
+    delete(payload: SyncjobDeleteRequest): Promise<MailcowResponse> {
+      return bind.requestFactory.post<MailcowResponse>(
+        '/api/v1/delete/syncjob',
+        payload.items
+      )
+    }
+  }
+}

src/index.ts

@@ -8,6 +8,7 @@ import { antiSpamEndpoints, AntiSpamEndpoints } from './Endpoints/antispam-endpo
 import { mailboxEndpoints, MailboxEndpoints } from './Endpoints/mailbox-endpoint';
 import RequestFactory from './request-factory';
 import { aliasEndpoints, AliasEndpoints } from './Endpoints/alias-endpoints';
+import { syncjobEndpoints, SyncjobEndpoints } from "./Endpoints/syncjob-endpoints";
 
 /**
  * Class containing all the logic to interface with the Mailcow API in TypeScript.
@@ -81,6 +82,13 @@ class MailcowClient {
    * @external
    */
   public mailbox: MailboxEndpoints = mailboxEndpoints(this)
+
+  /**
+   * All endpoints related to sync jobs.
+   * See {@link SyncjobEndpoints}
+   * @external
+   */
+  public syncjobs: SyncjobEndpoints = syncjobEndpoints(this)
 }
 
 export default MailcowClient;

src/types.ts

@@ -58,7 +58,7 @@ type RelayFrame = 's' | 'm' | 'h' | 'd';
 /**
  * Domain creation payload.
  */
-export interface DomainPostRequest extends BaseDomainAttributes  {
+export interface DomainPostRequest extends BaseDomainAttributes {
   /**
    * The domain to create.
    */
@@ -92,7 +92,7 @@ export interface DomainDeleteRequest {
  */
 export interface DomainEditAttributes extends BaseDomainAttributes {
   /**
-   * 	Is domain global address list active or not, it enables shared contacts across domain in SOGo webmail
+   *  Is domain global address list active or not, it enables shared contacts across domain in SOGo webmail
    */
   gal: boolean
   /**
@@ -156,7 +156,7 @@ export interface Domain {
    */
   domain_name: string;
   /**
-   * 	Is domain global address list active or not, it enables shared contacts across domain in SOGo webmail
+   *  Is domain global address list active or not, it enables shared contacts across domain in SOGo webmail
    */
   gal: boolean;
   /**
@@ -366,7 +366,7 @@ export interface MailboxDeleteRequest {
 /**
  * Attributes of the mailbox you can edit.
  */
-export interface MailboxEditAttributes extends BaseMailboxAttributes  {
+export interface MailboxEditAttributes extends BaseMailboxAttributes {
   /**
    * List of allowed send from addresses.
    */
@@ -723,7 +723,7 @@ export interface AliasEditRequest {
   /**
    * List of IDs of the aliases to update.
    */
-  items: number[];
+  items: number | number[];
   /**
    * The attributes to set.
    */
@@ -783,6 +783,163 @@ export interface Alias extends AliasAttributes {
   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 type SyncjobPostRequest = SyncjobAttributes
+
+/**
+ * Sync job delete payload.
+ */
+export interface SyncjobDeleteRequest {
+  /**
+   * Array of IDs to delete.
+   */
+  items: number[]
+}
+
+export 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 {
+  active: boolean,
+  authmd51: boolean,
+  authmech1: "TLS" | "SSL" | "PLAIN",
+  automap: boolean,
+  created: string,
+  custom_params: string,
+  delete1: boolean,
+  delete2: boolean,
+  delete2duplicates: boolean,
+  domain2: string,
+  enc1: "TLS" | "SSL" | "PLAIN",
+  exclude: string,
+  host1: string,
+  id: number,
+  is_running: boolean,
+  last_run: string,
+  log: string,
+  maxage: number,
+  maxbytespersecond: number,
+  mins_interval: number,
+  modified: string,
+  port1: number,
+  regextrans2: string,
+  skipcrossduplicates: boolean,
+  subfolder2: string,
+  subscribeall: boolean
+  timeout1: number,
+  timeout2: number,
+  user1: string,
+  user2: string
+}
+
 /**
  * Error class used for exception handling.
  */