JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 6738
  • Score
    100M100P100Q138432F
  • License MIT

Parses Gmail API's GET method to iGmail object. Typescript

Package Exports

  • gmail-api-parse-message-ts

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (gmail-api-parse-message-ts) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

npm

gmail-api-parse-message typescript

  • Parses Gmail API [message.get] and returns a IGmail object

To install:

npm install --save gmail-api-parse-message-ts --latest

or add to package.json  
"dependencies": {
     "gmail-api-parse-message-ts": "~2.2.9"
}

Example usage

import { ParseGmailApi } from 'gmail-api-parse-message-ts';
import { IGmail } from 'gmail-api-parse-message-ts/dist/iface/iGmail';

export class ParseEmailService {
    /**  fetch single email from Gmail API  */
    async getGmail(id: string): Promise<gapi.client.gmail.Message> {
      const email: gapi.client.gmail.Message = await gapi.client.gmail.users.messages.get({
        userId: 'me',
        id: id,  // format: 'metadata'
        format: 'full'
      });
      return email;
    }
 
    /** Parses Email */
    async parseEmail() {      
          const parse = new ParseGmailApi();
          const gmailResponse = await getEmail('[id of your gmail message]');
          const iGmail = parse.parseMessage(gmailResponse);  // returns IGmail object
          console.log(iGmail);  // see iGmail below
    }
 }

running parseEmail() which returns an iGmail object

interface IGmail {
    id: string;
    threadId: string;
    labelIds: string[];
    snippet: string;
    historyId: string;
    internalDate: number;
    textHtml: string;
    textPlain: string;
    attachments: IAttachment[];
    inline?: IAttachment[];
    headers: Map<string, string>;
}

interface IAttachment {
    filename: string;
    mimeType: string;
    size: number;
    attachmentId: string;
    headers?: any;
    /** data must be URLsafe base64 encoded */
    data?: string;
    dataEncoding?: string;
}

API

/**
 * Takes a response from the Gmail API's GET message method and extracts all the relevant data.
 * @param  {object} gmail api response - The response from the Gmail API parsed to a JavaScript object.
 * @return {iGmail object}  
 */
 parseMessage(response);

Forked

Licence

MIT