├── README.md
└── gmailAutoArchive.gs


/README.md:
--------------------------------------------------------------------------------
 1 | # gmailArchiveScript
 2 | 
 3 | Google script to automatically archive or trash old emails based on defined search terms.
 4 | Supports multiple rules, with custom actions for each rule.
 5 | Uses Gmail search syntax to find matching threads.
 6 | 
 7 | To use:
 8 | 
 9 | 1. Go to https://script.google.com
10 | 2. Go to the Editor and create a .gs file, paste in the contents
11 | 3. Set up the rules and configuration to suit your requirements
12 | 4. Give it a test run to ensure it is working OK
13 | 5. Go to Triggers > Add Trigger. Suggest a daily trigger at any time which suits
14 | 6. The script will run automatically and keep your gmail box squeaky clean!
15 | 


--------------------------------------------------------------------------------
/gmailAutoArchive.gs:
--------------------------------------------------------------------------------
 1 | function gmailAutoarchive() {
 2 | 
 3 |   // gmailAutoArchive - A Google Script to find emails matching search criteria older than x days and trashes and/or archives them
 4 |   //
 5 |   // Example search terms:
 6 |   //
 7 |   // label:<label>                -- find emails with a specific label applied eg. "label:alderaan"
 8 |   // subject:<words in subject>   -- find emails with specific words in the subject header eg. "subject:hello there"
 9 |   // category:<category>          -- find emails in a specific inbox category eg. "category:social"
10 |   // from:<sender>                -- find emails from the specified sender eg. "from:general kenobi" "from:kenobi@jedi.org"
11 |   // is:<property>                -- find emails with specific properties eg. "is:read" "is:starred" "is:important"
12 |   //
13 |   // Multiple search terms can be seperated by spaces and will find emails which match all search terms.
14 |   //   eg. "from:kenobi subject:hello there" will match only those emails from kenobi which also have "hello there" in the subject.
15 |   // The OR operator or {} around a set of search terms will find emails which match ANY search terms. 
16 |   //   eg. "from:artoo OR from:threepio" is equivalent to "{from:artoo from:threepio}"
17 |   // The - operator before a search term excludes items which match the search term. 
18 |   //   eg. "-subject:order 66" will exclude items with "order 66" in the subject.
19 |   //
20 |   // More information: https://support.google.com/mail/answer/7190?hl=en
21 |   //
22 | 
23 |   const DEBUG = true;              // Debugging Output
24 |   const BATCH_SIZE = 100;          // Batch Size, do not recommend changing this value
25 | 
26 |   const defaultactions = {         // Default actions for matches, suggest setting one or other of these to true
27 |     archive : false,               // Archive will remove the items from your Inbox, they will still be available for searching
28 |     trash :   false                // Trash will move the items to your Trash folder, they will be automatically deleted after 30 days
29 |   };             
30 |   
31 |   const globalrule = '-is:starred' // Include in all search terms
32 |     
33 |   const rules = {                  // defined rules, examples as follows
34 | 
35 | //    "label:Beskar" : {           // Search terms
36 | //      daystokeep : 14,           // Days to keep
37 | //      archive : true,            // Override Default Actions
38 | //      trash : false              // Override Default Actions
39 | //    },
40 |   
41 | //    "from:Kenobi" : 14,          // Define Search terms and days to keep only, use default actions
42 |     
43 |   }
44 | 
45 |   for (let search in rules) {
46 |     
47 |     var actions = Array();
48 |     actions = defaultactions;
49 | 
50 |     var daystokeep = 0;
51 |     
52 |     if(DEBUG) Logger.log(`Search: [${search}]`);
53 | 
54 |     if (rules[search].hasOwnProperty('daystokeep'))  {
55 |       if(DEBUG) Logger.log('Override Default Actions');
56 |       daystokeep = rules[search].daystokeep;
57 |       actions.archive = rules[search].archive;
58 |       actions.trash = rules[search].trash;
59 |     } else {
60 |       daystokeep = rules[search]
61 |     }
62 | 
63 |     if(DEBUG) Logger.log(`Find: [${search} ${globalrule}] older than [${daystokeep}] Days - Archive [${actions.archive}] Trash [${actions.trash}]`);
64 | 
65 |     var allthreads = GmailApp.search(`${search} ${globalrule}`);
66 | 
67 |     if(DEBUG) Logger.log(`Total of ${allthreads.length.toString()} threads matching ${search} ${globalrule}`);
68 | 
69 |     var threads = GmailApp.search(`${search} ${globalrule} older_than:${daystokeep}d`);
70 | 
71 |     if(DEBUG) Logger.log(`Identified ${threads.length.toString()} threads matching ${search} ${globalrule} older than ${daystokeep} Days`);
72 |     
73 |     while (threads.length) {
74 |       var this_batch_size = Math.min(threads.length, BATCH_SIZE);
75 |       var this_batch = threads.splice(0, this_batch_size);
76 |       if(DEBUG) Logger.log(`Batched ${this_batch_size} threads for action`);
77 |       if(actions.archive) {
78 |         if(DEBUG) Logger.log(`Archiving ${this_batch_size} threads...`);
79 |         GmailApp.moveThreadsToArchive(this_batch);
80 |       } 
81 |       if(actions.trash) {
82 |         if(DEBUG) Logger.log(`Trashing ${this_batch_size} threads...`);
83 |         GmailApp.moveThreadsToTrash(this_batch);
84 |       }
85 |     }
86 |   }
87 | }
88 | 


--------------------------------------------------------------------------------