-
-
Save gene1wood/0f455239490e5342fa49 to your computer and use it in GitHub Desktop.
/* | |
This script, when used with Google Apps Scripts, will delete 400 emails and | |
can be triggered to run every few minutes without user interaction enabling you | |
to bulk delete email in Gmail without getting the #793 error from Gmail. | |
Google returns a maximum of 500 email threads in a single API call. | |
This script fetches 400 threads in case 500 threads is causing timeouts | |
Configure the search query in the code below to match the type of emails | |
you want to delete | |
See - https://developers.google.com/apps-script/reference/gmail/gmail-app#search(String) | |
and https://support.google.com/mail/answer/7190 | |
Browse to https://script.google.com/ | |
Start a script and paste in the code below. | |
After you paste it in, save it. | |
Now you need to set the authorized scopes for the script ( https://developers.google.com/apps-script/concepts/scopes ) | |
On the left side of the screen, hover over the gear symbol and then click on Project Settings. | |
Enable 'Show "appsscript.json" manifest file in editor' | |
On the left side of the screen, click on the < > to return to the code editor | |
You should see a new file appear, appscript.json. Click on it. | |
Edit the file to add an oauthScopes entry for mail.google.com. It should look something like this. | |
{ | |
"oauthScopes": [ | |
"https://mail.google.com/", | |
"https://www.googleapis.com/auth/gmail.readonly", | |
"https://www.googleapis.com/auth/gmail.modify" | |
], | |
"timeZone": "America/New_York", | |
"dependencies": { | |
"enabledAdvancedServices": [ | |
{ | |
"userSymbol": "Gmail", | |
"version": "v1", | |
"serviceId": "gmail" | |
} | |
] | |
}, | |
"exceptionLogging": "STACKDRIVER", | |
"runtimeVersion": "V8" | |
} | |
In the drop down at the top select the function you want | |
to run. For example, you could run the batchDeleteEmail function. | |
This gist contains a few different functions to give examples of how to do other actions | |
besides deleting emails. For example if you wanted to mark all mail with the "work" label as read | |
you could run the markReadLabelWork function | |
Next click the little clock looking button. | |
This is for your triggers. You can set up how frequently you want the script | |
to run (I did mine for every minute but others are seeing execution take longer than | |
a minute in which case you may want to run every 5 or 15 minutes). | |
This writeup from @timur-tabi goes into more detail : https://docs.google.com/document/d/1PLfAnNus-B87gHS1pkbmzFTkWckAPNcqmvO7hFo_gBc/edit | |
Source : # https://productforums.google.com/d/msg/gmail/YeQVDuPIQzA/kpZPDDj8TXkJ | |
This gist includes additions by @kulemantu found in their fork : https://gist.github.com/kulemantu/84682cfebe72eb925cfe/revisions | |
*/ | |
function batchDeleteEmail() { | |
processEmail('label:inbox from:user@example.com', 'moveThreadsToTrash'); | |
} | |
function markReadLabelWork() { | |
processEmail('label:work', 'markThreadsRead'); | |
} | |
function markReadFromInfoExample() { | |
processEmail('from:user@example.com', 'markThreadsRead'); | |
} | |
function processEmail(search, batchAction) { | |
var batchSize = 100; // Process up to 100 threads at once | |
var searchSize = 400; // Limit search result to a max of 400 threads. Use this if you encounter the "Exceeded maximum execution time" error | |
var threads = GmailApp.search(search, 0, searchSize); | |
for (j = 0; j < threads.length; j += batchSize) { | |
GmailApp[batchAction](threads.slice(j, j + batchSize)); | |
} | |
} |
This is great. thanks much!
hello, im trying to figure this out
i wanna delete emails from my social inbox but im having trouble figuring out how to set up this code
@DestinyChan281 Follow the instructions in the comments of the code above and share what step you're getting stuck at and what problem you're encountering.
nevermin, I think I figured it out
though i did get this error message alot
"Exception: Service invoked too many times for one day: gmail.
batchDeleteEmail @ Code.gs:19"
Service invoked too many times for one day
Sounds like Google is ratelimiting calls to the moveThreadsToTrash
endpoint (or the search endpoint)
oh okay.
I guess I’ll just keep coming back to the script each day to reset the rate limit
really a nice feature, thank you so much.
I want to delete mails from Social Label and done the steps mentioned in the comments exactly but It's not deleting my mails but the code is running successfully. I can see the triggers are happening at every 1 minute interval.
Kindly help me if anyone have any idea on it.
Thank you
This is a great script! Thank you so much!!
Playing around a bit, I'm seeing timeouts occurring pretty regularly by the third or fourth batch. I'm also seeing each batch take a full minute to run so I pulled back the trigger interval to be once every 5 minutes rather than every 1 minute. I imagine it could cause odd behavior to have the same script running in parallel multiple times.
For anyone who's just cut & pasting and wants to see logging info, here's my full script with debug output:
function batchDeleteEmail() {
var batchSize = 100 // Process up to 100 threads at once
var threads = GmailApp.search('category:promotions older_than:3m');
console.log('batch size is: ' + threads.length);
for (j = 0; j < threads.length; j+=batchSize) {
console.log('removing batch: ' + j);
GmailApp.moveThreadsToTrash(threads.slice(j, j+batchSize));
}
}
You can see the before after on how long each script run was taking when they were running in parallel:
Since it's now finishing much more quickly, rather than increasingly the trigger interval back to 1m, the ideal scenario would be to increase the query size coming back from GmailApp.search. Unfortunately, Google caps that at 500 results per query.
Try this version. It limits to 400 threads:
function batchDeleteEmail()
{
// moveThreadsToTrash() only allows up to 100 threads at once
var batchSize = 100
// returns no more than 500 results, but that takes longer than
// six minutes, so return less. We don't want timeouts.
var threads = GmailApp.search('label:inbox from:user@example.com', 0, 400);
for (j = 0; j < threads.length; j += batchSize) {
GmailApp.moveThreadsToTrash(threads.slice(j, j + batchSize));
}
}
I suggest running this script not more often than once per hour.
Try this version. It limits to 400 threads:
function batchDeleteEmail() { // moveThreadsToTrash() only allows up to 100 threads at once var batchSize = 100 // returns no more than 500 results, but that takes longer than // six minutes, so return less. We don't want timeouts. var threads = GmailApp.search('label:inbox from:user@example.com', 0, 400); for (j = 0; j < threads.length; j += batchSize) { GmailApp.moveThreadsToTrash(threads.slice(j, j + batchSize)); } }
I suggest running this script not more often than once per hour.
That worked perfect. Now I just setup a trigger to run hourly. Does it start at the beginning of the hour? There is nothing under Last run
yet
Try this version. It limits to 400 threads:
function batchDeleteEmail() { // moveThreadsToTrash() only allows up to 100 threads at once var batchSize = 100 // returns no more than 500 results, but that takes longer than // six minutes, so return less. We don't want timeouts. var threads = GmailApp.search('label:inbox from:user@example.com', 0, 400); for (j = 0; j < threads.length; j += batchSize) { GmailApp.moveThreadsToTrash(threads.slice(j, j + batchSize)); } }
I suggest running this script not more often than once per hour.
That worked perfect. Now I just setup a trigger to run hourly. Does it start at the beginning of the hour? There is nothing under
Last run
yet
I changed it to run every 15 mins and I do see it running. I will change it back to run it every hour. Thanks!
@timur-tabi Thank you, I've added your suggestion to the gist above and linked to your Google Doc.
So the script has been working fine for most times (trigger is setup for one per hr) with searchSize = 400. However I still get the Exceeded maximum execution time
once in a while and sometimes says Exception: Gmail operation not allowed
. Out of 24 a day (one/hr) I get 3 failed with gmail operation not allowed and 3 timedout with execeeded max execution time. 75% success rate (yikes). Google GMAIL api is pretty unstable seems like.
Thank you. This script is very helpful to me. I release a new version to everyone. By the way, I added Mandarin in the comments. Hope it helps others.
function batchDeleteEmail() {
var batchSize = 100 // Process up to 100 threads at once
// 如果需要時間可以加上 [older_than:00m、00d、00h],[category:] 可換成 [label:]
// If you need to add time conditions, you can use d(day) and h(hours) instead.
// [category:] can be replace [label:].
var threads = GmailApp.search('category:forums');
console.log('batch size is: ' + threads.length);
for (j = 0; j < threads.length; j+=batchSize) {
console.log('removing batch: ' + j);
GmailApp.moveThreadsToTrash(threads.slice(j, j+batchSize));
}
}
Thank you so much! For anyone else wanting to delete patches, this is my
function batchDeleteEmail() {
var batchSize = 100 // Process up to 100 threads at once
var searchSize = 400 // Limit search result to a max of 400 threads. Use this if you encounter the "Exceeded maximum execution time" error
var threads = GmailApp.search('subject: PATCH', 0, searchSize);
for (j = 0; j < threads.length; j+=batchSize) {
GmailApp.moveThreadsToTrash(threads.slice(j, j+batchSize));
}
}
How to add multiple email addresses to the list?
I have an issue and I can't debug it. Is it me or the docs are a little bit stingy? Anyways, I cannot run the script as it says
Exception: Gmail Operation not allowed
On the line using GmailApp.search
. Oddly enough, I left it running for something like an hour and it was working but then it stopped working. It sounds like a limit hit? but I am unsure as I am getting a Gmail operation not allowed
and not something like limit error
or something else. Any possible ideas?
Thank you!
How to add multiple email addresses to the list?
@birajblg1987 You can customize the GMail search terms on line 27 in any way you wish, including adding additional email addresses.
@Hectorhammett Indeed, @asifiqbal also mentions above encountering that limit.
This script changed my life
My script appears to be running but I don't see the overall count going down. Is there any code I can add which would allow me to log whether the threads were successfully removed?
Thank you for an amazing script. However, in my case, I have around 200k messages that I need to delete. Here is how I altered the code to keep it running continuously:
function processEmail(search, batchAction) {
var batchSize = 100; // Process up to 100 threads at once
var searchSize = 500; // Limit search result to a max of 500 threads. (google doesn't allow more)
do {
var threads = GmailApp.search(search, 0, searchSize);
console.log('processing ' + threads.length + ' threads');
for (j = 0; j < threads.length; j += batchSize) {
GmailApp[batchAction](threads.slice(j, j + batchSize));
}
} while (threads.length>0) // keep script running until there are no threads left
}
For the people like me that have thousands of emails to delete and don't have a fancy business account, if you use @ethaniel script you will get Exceeded maximum execution time after 6 minutes, a way to get over it is setting a trigger 🕐 to execute every 5 minutes calling the function 😄 Hope that helps!
For the people like me that have thousands of emails to delete and don't have a fancy business account, if you use @ethaniel script you will get Exceeded maximum execution time after 6 minutes, a way to get over it is setting a trigger 🕐 to execute every 5 minutes calling the function 😄 Hope that helps!
And don’t forget to “deploy” the script, so the trigger would actually work!
hi! i'm getting this message when i run the program. i may not be getting the proper authorization scope. please advise. thanks
Error
Exception: The script does not have permission to perform that action. Required permissions: (https://www.googleapis.com/auth/gmail.metadata || https://www.googleapis.com/auth/gmail.readonly || https://www.googleapis.com/auth/gmail.modify || https://mail.google.com/)
batchDeleteEmail @ BatchDeleteEmails.gs:3
hi! i'm getting this message when i run the program. i may not be getting the proper authorization scope. please advise. thanks
Error Exception: The script does not have permission to perform that action. Required permissions: (https://www.googleapis.com/auth/gmail.metadata || https://www.googleapis.com/auth/gmail.readonly || https://www.googleapis.com/auth/gmail.modify || https://mail.google.com/) batchDeleteEmail @ BatchDeleteEmails.gs:3
When I try to implement this script, I was prompted to log into my Gmail account. At that point, I got this pop-up message:
How do I get around this?
Update: I wrote up instructions to get around this issue: https://docs.google.com/document/d/1PLfAnNus-B87gHS1pkbmzFTkWckAPNcqmvO7hFo_gBc/