Expose firstMessageTimestamp, implement menu item to copy “mailbox permalink” Foundry376#1473

Author: bengotow

app/internal_packages/thread-list/lib/thread-list-context-menu.ts

@@ -45,6 +45,8 @@ export default class ThreadListContextMenu {
           this.markAsReadItem(),
           this.markAsSpamItem(),
           this.starItem(),
+          { type: 'separator' },
+          this.createMailboxLinkItem(),
         ]);
       })
       .then(menuItems => {
@@ -243,6 +245,22 @@ export default class ThreadListContextMenu {
     };
   }
 
+  createMailboxLinkItem() {
+    if (this.threadIds.length !== 1) {
+      return null;
+    }
+
+    return {
+      label: localized('Copy mailbox permalink'),
+      click: async () => {
+        const id = this.threadIds[0];
+        const thread = await DatabaseStore.findBy<Thread>(Thread, { id }).limit(1);
+        if (!thread) return;
+        require('electron').clipboard.writeText(thread.getMailboxPermalink());
+      },
+    };
+  }
+
   displayMenu() {
     const { remote } = require('electron');
     this.menuItemTemplate().then(template => {

app/internal_packages/thread-sharing/lib/main.tsx

@@ -27,33 +27,51 @@ const DATE_EPSILON = 60; // Seconds
 
 const _readFile = Promise.promisify(fs.readFile);
 
+interface MailspringLinkParams {
+  subject: string;
+  lastDate?: number;
+  date?: number;
+}
 const _parseOpenThreadUrl = mailspringUrlString => {
   const parsedUrl = url.parse(mailspringUrlString);
-  const params: any = querystring.parse(parsedUrl.query);
-  params.lastDate = parseInt(params.lastDate, 10);
-  return params;
+  const params = querystring.parse(parsedUrl.query) as any;
+  return {
+    subject: params.subject,
+    date: params.date ? parseInt(params.date, 10) : undefined,
+    lastDate: params.lastDate ? parseInt(params.lastDate, 10) : undefined,
+  } as MailspringLinkParams;
 };
 
-const _findCorrespondingThread = ({ subject, lastDate }, dateEpsilon = DATE_EPSILON) => {
+const _findCorrespondingThread = (
+  { subject, lastDate, date }: MailspringLinkParams,
+  dateEpsilon = DATE_EPSILON
+) => {
+  const dateClause = date
+    ? new Matcher.And([
+        Thread.attributes.firstMessageTimestamp.lessThan(date + dateEpsilon),
+        Thread.attributes.firstMessageTimestamp.greaterThan(date - dateEpsilon),
+      ])
+    : new Matcher.Or([
+        new Matcher.And([
+          Thread.attributes.lastMessageSentTimestamp.lessThan(lastDate + dateEpsilon),
+          Thread.attributes.lastMessageSentTimestamp.greaterThan(lastDate - dateEpsilon),
+        ]),
+        new Matcher.And([
+          Thread.attributes.lastMessageReceivedTimestamp.lessThan(lastDate + dateEpsilon),
+          Thread.attributes.lastMessageReceivedTimestamp.greaterThan(lastDate - dateEpsilon),
+        ]),
+      ]);
+
   return DatabaseStore.findBy<Thread>(Thread).where([
     Thread.attributes.subject.equal(subject),
-    new Matcher.Or([
-      new Matcher.And([
-        Thread.attributes.lastMessageSentTimestamp.lessThan(lastDate + dateEpsilon),
-        Thread.attributes.lastMessageSentTimestamp.greaterThan(lastDate - dateEpsilon),
-      ]),
-      new Matcher.And([
-        Thread.attributes.lastMessageReceivedTimestamp.lessThan(lastDate + dateEpsilon),
-        Thread.attributes.lastMessageReceivedTimestamp.greaterThan(lastDate - dateEpsilon),
-      ]),
-    ]),
+    dateClause,
   ]);
 };
 
 const _onOpenThreadFromWeb = (event, mailspringUrl) => {
-  const { subject, lastDate } = _parseOpenThreadUrl(mailspringUrl);
+  const params = _parseOpenThreadUrl(mailspringUrl);
 
-  _findCorrespondingThread({ subject, lastDate })
+  _findCorrespondingThread(params)
     .then(thread => {
       if (!thread) {
         throw new Error('Thread not found');
@@ -62,7 +80,9 @@ const _onOpenThreadFromWeb = (event, mailspringUrl) => {
     })
     .catch(error => {
       AppEnv.reportError(error);
-      AppEnv.showErrorDialog(localized(`The thread %@ does not exist in your mailbox!`, subject));
+      AppEnv.showErrorDialog(
+        localized(`The thread %@ does not exist in your mailbox!`, params.subject)
+      );
     });
 };
 

app/internal_packages/thread-sharing/lib/thread-sharing-button.tsx

@@ -24,14 +24,25 @@ export default class ThreadSharingButton extends React.Component<{ items: any[];
     });
   };
 
+  _onCopyMailboxLink = () => {
+    // Note: This is the mailbox link, not the thread sharing link, but they are managed together
+    // since this plugin also implements the receiving side (_onOpenThreadFromWeb).
+    require('electron').clipboard.writeText(this.props.thread.getMailboxPermalink());
+  };
+
   render() {
     if (this.props.items && this.props.items.length > 1) {
       return <span />;
     }
     const item = this.props.items[0];
 
     return (
-      <BindGlobalCommands commands={{ 'core:share-item-link': () => this._onClick() }}>
+      <BindGlobalCommands
+        commands={{
+          'core:share-item-link': () => this._onClick(),
+          'core:copy-mailbox-link': () => this._onCopyMailboxLink(),
+        }}
+      >
         <button
           className={`btn btn-toolbar thread-sharing-button ${isShared(item) && 'active'}`}
           title={localized('Share')}

app/keymaps/base.json

@@ -22,6 +22,7 @@
 
   "core:snooze-item": "z",
   "core:print-thread": "mod+p",
+  "core:copy-mailbox-link": "ctrl+l",
   "core:focus-item": "enter",
   "core:remove-from-view": ["backspace", "del"],
   "core:pop-sheet": "escape",

app/menus/darwin.js

@@ -158,7 +158,9 @@ module.exports = {
         },
         { label: localized('Star'), command: 'core:star-item' },
         { label: localized('Snooze') + '...', command: 'core:snooze-item' },
-        { label: localized('Share Link') + '...', command: 'core:share-item-link' },
+        { type: 'separator' },
+        { label: localized('Share this thread') + '...', command: 'core:share-item-link' },
+        { label: localized('Copy mailbox permalink'), command: 'core:copy-mailbox-link' },
         { type: 'separator' },
         { label: localized('Remove from view'), command: 'core:remove-from-view' },
         { label: localized('Remove and show next'), command: 'core:remove-and-next' },

app/menus/linux.js

@@ -129,7 +129,9 @@ module.exports = {
         },
         { label: localized('Star'), command: 'core:star-item' },
         { label: localized('Snooze') + '...', command: 'core:snooze-item' },
-        { label: localized('Share Link') + '...', command: 'core:share-item-link' },
+        { type: 'separator' },
+        { label: localized('Share this thread') + '...', command: 'core:share-item-link' },
+        { label: localized('Copy mailbox permalink'), command: 'core:copy-mailbox-link' },
         { type: 'separator' },
         { label: localized('Remove from view'), command: 'core:remove-from-view' },
         { label: localized('Remove and show next'), command: 'core:remove-and-next' },

app/menus/win32.js

@@ -107,7 +107,9 @@ module.exports = {
         },
         { label: localized('Star'), command: 'core:star-item' },
         { label: localized('Snooze') + '...', command: 'core:snooze-item' },
-        { label: localized('Share Link') + '...', command: 'core:share-item-link' },
+        { type: 'separator' },
+        { label: localized('Share this thread') + '...', command: 'core:share-item-link' },
+        { label: localized('Copy mailbox permalink'), command: 'core:copy-mailbox-link' },
         { type: 'separator' },
         { label: localized('Remove from view'), command: 'core:remove-from-view' },
         { label: localized('Remove and show next'), command: 'core:remove-and-next' },

app/src/flux/models/thread.ts

@@ -104,6 +104,12 @@ export class Thread extends ModelWithMetadata {
       modelKey: 'attachmentCount',
     }),
 
+    firstMessageTimestamp: Attributes.DateTime({
+      queryable: true,
+      jsonKey: 'fmt',
+      modelKey: 'firstMessageTimestamp',
+    }),
+
     lastMessageReceivedTimestamp: Attributes.DateTime({
       queryable: true,
       jsonKey: 'lmrt',
@@ -139,6 +145,7 @@ export class Thread extends ModelWithMetadata {
   public labels: Label[];
   public participants: Contact[];
   public attachmentCount: number;
+  public firstMessageTimestamp: Date;
   public lastMessageReceivedTimestamp: Date;
   public lastMessageSentTimestamp: Date;
   public inAllMail: boolean;
@@ -206,4 +213,9 @@ export class Thread extends ModelWithMetadata {
     }
     return out;
   }
+
+  getMailboxPermalink() {
+    const subject = encodeURIComponent(this.subject);
+    return `mailspring://thread?subject=${subject}&date=${this.firstMessageTimestamp.getTime()}`;
+  }
 }