Gmail: delete old emails automatically

README.md

Gmail: delete old emails automatically

Automatically deletes old emails that match the specified label.

Get started

• Create a new Google Apps Script at https://script.google.com
• Overwrite the placeholder with the javascript below
• Update the following constants:
  • LABEL_TO_DELETE: the label that should be have old messages deleted
  • DELETE_AFTER_DAYS: the age of messsages after which they will be moved to trash
• Save the script, then run:
  • Initialize
  • Install

If you ever want to remove the script, run Uninstall to remove any left over triggers.

Changelog

2017-07-31

• Added support for multiple labels
• Added configurable TRIGGER_NAME
• Increased default page size
• Decreased default delay between receipt and delete

2016-01-21

• Removed use of deprecated Session.getTimeZone()
• Improved efficiency for long threads by checking thread.getLastMessageDate()

2021-03-30 (ch3ckmat3)

• Skip threads or messages which are "Starred" from deletion

Acknowledgements

H/T: Arun's post How to Auto Delete Old Emails In Any Gmail Label

delete-by-label.js

// The name of the Gmail Label that is to be checked for purging?
var LABELS_TO_DELETE = [
  "meetup",
  "indeed",
  "facebook",
  "linkedin"
];

var TRIGGER_NAME = "dailyDeleteGmail";

// Purge messages in the above label automatically after how many days?
var DELETE_AFTER_DAYS = "30";

var TIMEZONE = "AEST";

// Maximum number of threads to process per run
var PAGE_SIZE = 100;

// If number of threads exceeds page size, resume job after X mins (max execution time is 6 mins)
var RESUME_FREQUENCY = 10;

/*
IMPLEMENTATION
*/
function Intialize() {
  return;
}

function Install() {

  // First run 2 mins after install
  ScriptApp.newTrigger(TRIGGER_NAME)
    .timeBased()
    .at(new Date((new Date()).getTime() + 1000 * 60 * 2))
    .create();

  // Run daily there after
  ScriptApp.newTrigger(TRIGGER_NAME)
    .timeBased().everyDays(1).create();

}

function Uninstall() {

  var triggers = ScriptApp.getProjectTriggers();
  for (var i = 0; i < triggers.length; i++) {
    ScriptApp.deleteTrigger(triggers[i]);
  }

}

function dailyDeleteGmail() {

  var age = new Date();
  age.setDate(age.getDate() - DELETE_AFTER_DAYS);

  var purge = Utilities.formatDate(age, TIMEZONE, "yyyy-MM-dd");
  var search = "(label:" + LABELS_TO_DELETE.join(" OR label:") + ") before:" + purge;
  Logger.log("PURGE: " + purge);
  Logger.log("SEARCH: " + search);

  try {

    var threads = GmailApp.search(search, 0, PAGE_SIZE);

    // Resume again in 10 minutes
    if (threads.length == PAGE_SIZE) {
      Logger.log("Scheduling follow up job...");
      ScriptApp.newTrigger(TRIGGER_NAME)
        .timeBased()
        .at(new Date((new Date()).getTime() + 1000 * 60 * RESUME_FREQUENCY))
        .create();
    }

    // Move threads/messages which meet age criteria to trash
    Logger.log("Processing " + threads.length + " threads...");
    for (var i = 0; i < threads.length; i++) {
      var thread = threads[i];

      if (thread.getLastMessageDate() < age) {
        if (!thread.hasStarredMessages()) {
          thread.moveToTrash();
        }
      } else {
        var messages = GmailApp.getMessagesForThread(threads[i]);
        for (var j = 0; j < messages.length; j++) {
          var email = messages[j];
          if (email.getDate() < age) {
            if (!email.isStarred()) {
              email.moveToTrash();
            }
          }
        }
      }
    }

  } catch (e) { }

}