!https://img.shields.io/npm/dm/gmail-inbox

Gmail-inbox

Gmail-inbox is a simplified gmail API to receive emails in coding. It helps with end-to-end testing your signup process, test email functionality and automate processes that require receiving emails.

$3

Install the dependencies

``sh
$ npm install -S gmail-inbox
`

Example

Complete examples can be found in the examples/ folder

##### Receive email example
 
`javascript
import { Inbox } from 'gmail-inbox';

async function exeCuteMe(){
let inbox = new Inbox('credentials.json');
await inbox.authenticateAccount(); // logs user in

let messages = await inbox.getLatestMessages();

console.log("my inbox messages", JSON.stringify(messages,null,4));

// Note: give https://github.com/ismail-codinglab/gmail-inbox a star if it saved you time!
}

exeCuteMe();
`

Getting started

$3

To work with the gmail API you need to get the credentials from the google cloud console.

Step 1
Follow the google instructions to Create a client ID and client secret.

Step 2
Go to https://console.cloud.google.com/apis/credentials and download the OAuth2 credentials file, as shown in the image below.

!Google cloud platform

Your credentials file (commmonly named client_secret_\*.json), should look similar to image below

!credentials file example

Note: make sure you selected 'other' as project and that the redirect_uris contains something like "urn:ietf:wg:oauth:2.0:oob"

Step 3 Copy the example code in #example and execute the script

Step 4
The application will prompt to visit the authorization url. Navigate to the url, select your email and copy the code as shown in the image below.
!Copy image url

Note: The authorization token will only be valid for 6 months, after 6 months a renewal is required.

Step 5
Done! You're good to go, you should be able to see your inbox messages, enjoy coding! :)

API

Since the code is typed in TypeScript I will just include the self-documented interfaces :)

$3

`typescript
interface InboxMethods {
/**
* Logs the user in.
* If there is no authenticated user then a instruction will pop-up and an input is required
*/
authenticateAccount(): Promise;
/**
* Finds messages based on the searchQuery
* Can be typed or plain text as you can be used to in the gmail search-bar
*/
findMessages(searchQuery: SearchQuery| string);
/**
* Gets all the labels. Default ones and custom ones.
*/
getAllLabels(): Promise;
/**
* Gets the latest messages
*/
getLatestMessages(): Promise;
/**
* Waits until a message is received.
* Handy for testing if the 'welcome' or 'verify email' email is being send within a time limit e.g. 60seconds
*/
waitTillMessage(
searchQuery: SearchQuery | string,
shouldLogEvents: boolean,
timeTillNextCallInSeconds: number,
maxWaitTimeInSeconds: number
): Promise;
}
`

$3


Both findMessages and waitTillMessage support the same searchquery

`typescript
export type MessageIsType = 'read' | 'unread' | 'snoozed' | 'starred' | 'important';

export interface MessageDateType {
date: Date;
precision: "year" | "day" | "milliseconds";
}

export type UnixTimestamp = number; // this alias for number gives you a better autocomplete suggestion

export interface SearchQuery {
/**
* Search for one or multiple potential subjects
*/
subject?: string | string[];
message?: string;
mustContainText?: string | string[];
from?: string | string[];
to?: string | string[];
cc?: string;
bcc?: string;
/**
* In which label the message should be
*/
labels?: string[];
has?: 'attachment' | 'drive' | 'document' | 'spreadsheet' | 'youtube' | 'presentation';
/**
* Some possible extensions to search with, if not use "filename" property with your extension. e.g. filename: "png"
* Note: The filenames containing the extension will also be returned. E.g. 'filenameExtension:"pdf" will also return 'not-a-pdf.jpg'
*/
filenameExtension?: 'pdf' | 'ppt' | 'doc' | 'docx' | 'zip' | 'rar';
/**
* you can search like filename: "pdf" or filename:"salary.pdf"
*/
filename?: string;
/**
* What status the message is in
*/
is?: MessageIsType | MessageIsType[];

/**
* same as 'newer'
*/
after?: MessageDateType | UnixTimestamp,
/**
* same as 'older'
*/
before?: MessageDateType | UnixTimestamp,

/**
* same as 'before'
*/
older?: MessageDateType | UnixTimestamp,
/**
* same as 'after'
*/
newer?: MessageDateType | UnixTimestamp,

olderThan?: {
/**
* Must be higher than 0
*/
amount: number;
period: 'day' | 'month' | 'year';
};
newerThan?: {
/**
* Must be higher than 0
*/
amount: number;
period: 'day' | 'month' | 'year';
};

maxResults?: number;

category: 'primary' | 'social' | 'promotions' | 'updates' | 'forums' | 'reservations' | 'purchases';
}
``

Development

Want to contribute? Great!

Help us by creating a pull request