Gmail Search with Google Apps Script

You can use Regular Expressions to search Gmail with the help of Google App Script. The script scans the mailbox, compares the message body with the search pattern and prints any matching messages. Google Apps Script using standard JavaScript functions to perform regex search.

function Search() {
  var sheet = SpreadsheetApp.getActiveSheet();
  var row = 2;

  // Clear existing search results
  sheet.getRange(2, 1, sheet.getMaxRows() - 1, 4).clearContent();

  // Which Gmail Label should be searched?
  var label = sheet.getRange('F3').getValue();

  // Get the Regular Expression Search Pattern
  var pattern = sheet.getRange('F4').getValue();

  // Retrieve all threads of the specified label
  var threads ='in:' + label);

  for (var i = 0; i < threads.length; i++) {
    var messages = threads[i].getMessages();

    for (var m = 0; m < messages.length; m++) {
      var msg = messages[m].getBody();

      // Does the message content match the search pattern?
      if ( !== -1) {
        // Format and print the date of the matching message
        sheet.getRange(row, 1).setValue(Utilities.formatDate(messages[m].getDate(), 'GMT', 'yyyy-MM-dd'));

        // Print the sender's name and email address
        sheet.getRange(row, 2).setValue(messages[m].getFrom());

        // Print the message subject
        sheet.getRange(row, 3).setValue(messages[m].getSubject());

        // Print the unique URL of the Gmail message
        var id = '' + messages[m].getId();
        sheet.getRange(row, 4).setFormula('=hyperlink("' + id + '", "View")');

        // Move to the next row
Amit Agarwal

Amit Agarwal

Google Developer Expert, Google Cloud Champion

Amit Agarwal is a Google Developer Expert in Google Workspace and Google Apps Script. He holds an engineering degree in Computer Science (I.I.T.) and is the first professional blogger in India.

Amit has developed several popular Google add-ons including Mail Merge for Gmail and Document Studio. Read more on Lifehacker and YourStory


Awards & Titles

Digital Inspiration has won several awards since it's launch in 2004.

Google Developer Expert

Google Developer Expert

Google awarded us the Google Developer Expert award recogizing our work in Google Workspace.

ProductHunt Golden Kitty

ProductHunt Golden Kitty

Our Gmail tool won the Lifehack of the Year award at ProductHunt Golden Kitty Awards in 2017.

Microsoft MVP Alumni

Microsoft MVP Alumni

Microsoft awarded us the Most Valuable Professional (MVP) title for 5 years in a row.

Google Cloud Champion

Google Cloud Champion

Google awarded us the Champion Innovator title recognizing our technical skill and expertise.

Email Newsletter

Sign up for our email newsletter to stay up to date.

We will never send any spam emails. Promise.