Gmail OCR with Google Apps Script

The script will save Gmail attachments to Google Drive and because Drive supports OCR for images, you can then search for text inside these images.

/*

    Auto-Save your Gmail Image Attachments to Google Drive
    ======================================================

    Written by Amit Agarwal on 05/28/2013

    To get started, choose Run -> Authorize and grant the
    necessary permissions. Then choose Run -> StartProgram.

    The default Google Drive folder for saving the image
    attachments is "Gmail Images" and once the message has
    been processed, Gmail applies the label "Processed" to
    that message. You can change the defaults in line 26 & 26.

*/

// Authorize the Google Apps Script
function Authorize() {
  StartProgram();
}

// Initialize the Script
function StartProgram() {
  var DRIVE_FOLDER = 'Gmail Images';
  var GMAIL_LABEL = 'Processed';

  createGmailLabel(GMAIL_LABEL);
  createDriveFolder(DRIVE_FOLDER);
  createTrigger();
}

// The script will check your Gmail mailbox every minute
// with the help of a CLOCK based trigger.
function createTrigger() {
  var triggers = ScriptApp.getScriptTriggers();

  for (var i in triggers) {
    ScriptApp.deleteTrigger(triggers[i]);
  }

  ScriptApp.newTrigger('saveGmailAttachments').timeBased().everyMinutes(1).create();
}

// If the Gmail label is unavailable, create one.
function createGmailLabel(name) {
  if (!GmailApp.getUserLabelByName(name)) {
    GmailApp.createLabel(name);
  }

  ScriptProperties.setProperty('LABEL', name);
}

// If the Google Drive folder is not present, create one.
function createDriveFolder(name) {
  var folders = DriveApp.getFolders();
  var folder,
    found = false;

  while (folders.hasNext()) {
    folder = folders.next();
    if (folder.getName() === name) {
      found = true;
      break;
    }
  }

  if (!found) {
    DriveApp.createFolder(name);
  }

  ScriptProperties.setProperty('FOLDER_ID', folder.getId());
}

// This will auto-save the image attachments from Gmail to Google Drive
function saveGmailAttachments() {
  var label_name = ScriptProperties.getProperty('LABEL');
  var label = GmailApp.getUserLabelByName(label_name);

  var folderID = DriveApp.getFolderById(ScriptProperties.getProperty('FOLDER_ID'));

  // Scan for threads that have image attachments
  var threads = GmailApp.search(
    'in:all -in:spam -in:trash -in:' + label_name + ' has:attachment filename:jpg OR filename:png OR filename:gif',
    0,
    10
  );

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

      for (var y = 0; y < messages.length; y++) {
        var attachments = messages[y].getAttachments();

        for (var z = 0; z < attachments.length; z++) {
          var file = attachments[z];

          // Only save image attachments that have the MIME type as image.
          if (file.getContentType().match(/image/gi)) {
            folderID.createFile(file);
          }
        }
      }
      // Process messages are labelled to skip them in the next iteration.
      threads[x].addLabel(label);
    }
  } catch (e) {
    Logger.log(e.toString());
  }
}
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

0

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.