Merge pull request linagora#5 from ee-email/email-query-get-support

Initial support for email query and get actions

Author: alagane

.gitignore

@@ -1,2 +1,11 @@
 node_modules
-/lib
+/lib
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace

src/index.ts

@@ -1,5 +1,15 @@
 import { HttpRequest } from './http-request';
-import { IGetArguments, IMailbox, IMailboxProperties, ISession } from './types';
+import {
+  IEmailFilterCondition,
+  IEmailGetResponse,
+  IEmailProperties,
+  IEmailQueryResponse,
+  IGetArguments,
+  IMailboxGetResponse,
+  IMailboxProperties,
+  IQueryArguments,
+  ISession,
+} from './types';
 
 export class Client {
   private readonly DEFAULT_USING = [
@@ -69,38 +79,20 @@ export class Client {
     const accountIds = this.getAccountIds();
 
     if (accountIds.length === 0) {
-      throw new Error(
-        'No account available for this session'
-      );
+      throw new Error('No account available for this session');
     }
 
     return accountIds[0];
   }
 
   public mailbox_get(
     args: IGetArguments<IMailboxProperties>
-  ): Promise<{
-    accountId: string | null;
-    state: string;
-    list: IMailbox[];
-    notFound: string;
-  }> {
+  ): Promise<IMailboxGetResponse> {
     const apiUrl = this.overriddenApiUrl || this.getSession().apiUrl;
     return this.httpRequest
       .post<{
         sessionState: string;
-        methodResponses: [
-          [
-            'Mailbox/get',
-            {
-              accountId: string;
-              state: string;
-              list: IMailbox[];
-              notFound: string;
-            },
-            string
-          ]
-        ];
+        methodResponses: [['Mailbox/get', IMailboxGetResponse, string]];
       }>(
         apiUrl,
         {
@@ -112,6 +104,44 @@ export class Client {
       .then((response) => response.methodResponses[0][1]);
   }
 
+  public email_query(
+    args: IQueryArguments<IEmailFilterCondition>
+  ): Promise<IEmailQueryResponse> {
+    const apiUrl = this.overriddenApiUrl || this.getSession().apiUrl;
+    return this.httpRequest
+      .post<{
+        sessionState: string;
+        methodResponses: [['Email/query', IEmailQueryResponse, string]];
+      }>(
+        apiUrl,
+        {
+          using: this.getCapabilities(),
+          methodCalls: [['Email/query', this.replaceAccountId(args), '0']],
+        },
+        this.httpHeaders
+      )
+      .then((response) => response.methodResponses[0][1]);
+  }
+
+  public email_get(
+    args: IGetArguments<IEmailProperties>
+  ): Promise<IEmailGetResponse> {
+    const apiUrl = this.overriddenApiUrl || this.getSession().apiUrl;
+    return this.httpRequest
+      .post<{
+        sessionState: string;
+        methodResponses: [['Email/get', IEmailGetResponse, string]];
+      }>(
+        apiUrl,
+        {
+          using: this.getCapabilities(),
+          methodCalls: [['Email/get', this.replaceAccountId(args), '0']],
+        },
+        this.httpHeaders
+      )
+      .then((response) => response.methodResponses[0][1]);
+  }
+
   private replaceAccountId<U extends { accountId: string }>(input: U): U {
     return {
       ...input,

src/types.ts

@@ -1,5 +1,7 @@
 export interface ITypeMap {
   ['Mailbox/get']: IMailbox;
+  ['Email/query']: string[];
+  ['Email/get']: IEmailProperties;
 }
 
 /**
@@ -17,6 +19,11 @@ export interface IGetArguments<Properties> {
   properties?: Properties[];
 }
 
+export interface IQueryArguments<FilterCondition> {
+  accountId: string;
+  filter?: FilterCondition;
+}
+
 export interface IRequest {
   using: string[];
   methodCalls: IMethodCall[];
@@ -52,28 +59,44 @@ export interface ISession {
   state: string;
 }
 
-export type Emailer = string;
-
 export type EmailHeader = string;
 
 export type Attachment = File;
 
-export interface IEmail {
+export interface IEmailProperties {
   id: string;
   blobId: string;
   threadId: string;
   mailboxIds: { [key: string]: boolean };
-  keywords: { [key: string]: boolean };
-  from: Emailer[] | null;
-  to: Emailer[] | null;
+  keywords: IEmailKeywords;
+  from: IEmailAddress[] | null;
+  to: IEmailAddress[] | null;
   subject: string;
-  date: Date;
   size: number;
   preview: string;
   attachments: Attachment[] | null;
   createdModSeq: number;
   updatedModSeq: number;
-  deleted: Date | null;
+  receivedAt: IUtcDate;
+}
+
+export type IUtcDate = string;
+export type ITrue = true;
+
+export interface IEmailKeywords {
+  $draft?: ITrue;
+  $seen?: ITrue;
+  $flagged?: ITrue;
+  $answered?: ITrue;
+  $forwarded?: ITrue;
+  $phishing?: ITrue;
+  $junk?: ITrue;
+  $notjunk?: ITrue;
+}
+
+export interface IEmailAddress {
+  name: string;
+  email: string;
 }
 
 export interface IThreadEmail {
@@ -125,6 +148,13 @@ export interface IMailboxProperties {
   deleted?: Date;
 }
 
+export interface IMailboxGetResponse {
+  accountId: string | null;
+  state: string;
+  list: IMailbox[];
+  notFound: string[];
+}
+
 export interface IMaiboxEmailList {
   id: string; // mailboxId . (Max_Int64 - EmailDate) . uid
   messageId: string;
@@ -194,3 +224,24 @@ export interface IEmailBodyPart {
   hasAttachment: boolean;
   preview: string;
 }
+
+export interface IEmailFilterCondition {
+  inMailbox: string;
+}
+
+export interface IEmailQueryResponse {
+  accountId: string;
+  queryState: string;
+  canCalculateChanges: boolean;
+  position: number;
+  ids: string[];
+  total?: number;
+  limit?: number;
+}
+
+export interface IEmailGetResponse {
+  accountId: string | null;
+  state: string;
+  list: IEmailProperties[];
+  notFound: string[];
+}