Gmail-api-simplified
Gmail-api-simplified 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.
Installation
Install the dependencies
$ npm install -S gmail-api-simplified
Example
Complete examples can be found in the examples/
folder
Receive email example
; { let inbox = 'credentials.json'; await inbox; // logs user in let messages = await inbox; console; // Note: give https://github.com/ismail-codinglab/gmail-inbox a star if it saved you time!} ;
Getting started
Get gmail API credentials
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.
Your credentials file (commmonly named client_secret_*.json), should look similar to image below
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.
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 :)
Available methods
Inbox.findMessages(searchQuery: SearchQuery)
/ Inbox.waitTillMessage(searchQuery: SearchQuery, ...)
Both findMessages
and waitTillMessage
support the same searchquery
; ; // this alias for number gives you a better autocomplete suggestion
Development
Want to contribute? Great!
Help us by creating a pull request