AutoUnsubscriber.py

#! python3

import pyzmail
import imapclient
import bs4
import getpass
import webbrowser
import re
import sys
import ssl

'''List of accepted service providers and respective imap link'''
servers = [('Gmail','imap.gmail.com'),('Outlook','imap-mail.outlook.com'),
           ('Hotmail','imap-mail.outlook.com'),('Yahoo','imap.mail.yahoo.com'),
           ('ATT','imap.mail.att.net'),('Comcast','imap.comcast.net'),
           ('Verizon','incoming.verizon.net'),('AOL','imap.aol.com'),
           ('Zoho','imap.zoho.com'),('GMX','imap.gmx.com'),('ProtonMail','127.0.0.1')]
#Rewrote with dictionaries
serverD = {
    'Gmail': {
        'imap': 'imap.gmail.com',
        'domains': ['@gmail.com']
        },
    'Outlook/Hotmail': {
        'imap': 'imap-mail.outlook.com',
        'domains': ['@outlook.com','@hotmail.com']
        },
    'Yahoo': {
        'imap': 'imap.mail.yahoo.com',
        'domains': ['@yahoo.com']
        },
    'ATT': {
        'imap': 'imap.mail.att.net',
        'domains': ['@att.net']
        },
    'Comcast': {
        'imap': 'imap.comcast.net',
        'domains': ['@comcast.net']
        },
    'Verizon': {
        'imap': 'incoming.verizon.net',
        'domains': ['@verizon.net']
        },
    'AOL': {
        'imap': 'imap.aol.com',
        'domains': ['@aol.com']
        },
    'Zoho': {
        'imap': 'imap.zoho.com',
        'domains': ['@zoho.com']
        },
    'GMX': {
        'imap': 'imap.gmx.com',
        'domains': ['@gmx.com']
        },
    'ProtonMail': {
        'imap': '127.0.0.1',
        'domains': ['@protonmail.com','@pm.me']
    }
}


'''Key words for unsubscribe link - add more if found'''
words = ['unsubscribe','subscription','optout']

class AutoUnsubscriber():
    def __init__(self):
        self.email = ''
        self.user = None
        self.password = ''
        self.imap = None
        self.goToLinks = False
        self.delEmails = False
        self.senderList = []
        self.noLinkList = []
        self.providers = []
        #server name is later matched against second level domain names
        for server in servers:
            self.providers.append(re.compile(server[0], re.I))
        #TODO maybe add support for servers with a
        #company name different than their domain name...
    '''Get initial user info - email, password, and service provider'''
    def getInfo(self):
        print('This program searchs your email for junk mail to unsubscribe from and delete')
        print('Supported emails: Gmail, Outlook, Hotmail, Yahoo, AOL, Zoho,')
        print('GMX, AT&T, Comcast, ProtonMail (Bridge), and Verizon')
        print('Please note: you may need to allow access to less secure apps')
        getEmail = True
        while getEmail:
            self.email = str.lower(input('\nEnter your email address: '))
            for prov in serverD:
                match=False
                for domain in serverD[prov]['domains']:
                    if domain in self.email:
                        print('\nLooks like you\'re using a '+prov+' account\n')
                        self.user = (prov, serverD[prov]['imap'])
                        getEmail = False
                        match = True
                        break
                if match: break
            if self.user is None:
                print('\nEmail type not recognized, enter an imap server, or press enter to try a different email address:\n')
                myimap = input('\n[myimapserver.tld] | [enter] : ')
                if myimap:
                    self.user = ('Self-defined IMAP', myimap)
                    print('\nYou are using a '+self.user[0]+' account!\n')
                    getEmail = False
                    break
                print('\nTry a different account')
        self.password = getpass.getpass('Enter password for '+self.email+': ')

    '''Log in to IMAP server, argument determines whether readonly or not'''
    def login(self, read=True):
        try: 
            '''ProtonMail Bridge Support - Requires unverified STARTTLS and changing ports'''
            if self.user[0]=='ProtonMail':
                print("\nProtonMail require ProtonMail Bridge installed, make sure you've used the password Bridge gives you.")
                self.context = ssl.create_default_context()
                self.context.check_hostname = False
                self.context.verify_mode = ssl.CERT_NONE
                self.imap = imapclient.IMAPClient(self.user[1], port=1143, ssl=False)
                self.imap.starttls(ssl_context=self.context)
            else: self.imap = imapclient.IMAPClient(self.user[1], ssl=True)
            self.imap._MAXLINE = 10000000
            self.imap.login(self.email, self.password)
            self.imap.select_folder('INBOX', readonly=read)
            print('\nLog in successful\n')
            return True
        except:
            print('\nAn error occured while attempting to log in, please try again\n')
            return False

    '''Attempt to log in to server. On failure, force user to re-enter info'''
    def accessServer(self, readonly=True):
        if self.email == '':
            self.getInfo()
        attempt = self.login(readonly)
        if attempt == False:
            self.newEmail()
            self.accessServer(readonly)

    '''Search for emails with unsubscribe in the body. If sender not already in
    senderList, parse email for unsubscribe link. If link found, add name, email,
    link (plus metadata for decisions) to senderList. If not, add to noLinkList.
    '''
    def getEmails(self):
        print('Getting emails with unsubscribe in the body\n')
        UIDs = self.imap.search([u'TEXT','unsubscribe'])
        raw = self.imap.fetch(UIDs, ['BODY[]'])
        print('Getting links and addresses\n')
        for UID in UIDs:
            '''If Body exists (resolves weird error with no body emails from Yahoo), then
            Get address and check if sender already in senderList '''
            if b'BODY[]' in raw[UID]: msg = pyzmail.PyzMessage.factory(raw[UID][b'BODY[]'])
            else:
                print("Odd Email at UID: "+str(UID)+"; SKIPPING....")
                continue
            sender = msg.get_addresses('from')
            trySender = True
            for spammers in self.senderList:
                if sender[0][1] in spammers:
                    trySender = False
            '''If not, search for link'''
            if trySender:
                '''Encode and decode to cp437 to handle unicode errors and get
                rid of characters that can't be printed by Windows command line
                which has default setting of cp437
                '''
                senderName = (sender[0][0].encode('cp437', 'ignore'))
                senderName = senderName.decode('cp437')
                print('Searching for unsubscribe link from '+str(senderName))
                url = False
                '''Parse html for elements with anchor tags'''
                if html_piece := msg.html_part:
                    html = html_piece.get_payload().decode('utf-8')
                    soup = bs4.BeautifulSoup(html, 'html.parser')
                    elems = soup.select('a')
                    '''For each anchor tag, use regex to search for key words'''
                    elems.reverse()
                    #search starting at the bottom of email
                    for elem in elems:
                        for word in self.words:
                            '''If one is found, get the url'''
                            if re.match( word, str(elem), re.IGNORECASE):
                                print('Link found')
                                url = elem.get('href')
                                break
                        if url: break
                '''If link found, add info to senderList
                format: (Name, email, link, go to link, delete emails)
                If no link found, add to noLinkList
                '''
                if url: self.senderList.append([senderName, sender[0][1], url, False, False])
                else:
                    print('No link found')
                    notInList = True
                    for noLinkers in self.noLinkList:
                        if sender[0][1] in noLinkers:
                            notInList = False
                    if notInList:
                        self.noLinkList.append([sender[0][0], sender[0][1]])
        print('\nLogging out of email server\n')
        self.imap.logout()

    '''Display info about which providers links were/were not found for'''
    def displayEmailInfo(self):
        if self.noLinkList != []:
            print('Could not find unsubscribe links from these senders:')
            noList = '| '
            for i in range(len(self.noLinkList)):
                noList += (str(self.noLinkList[i][0])+' | ')
            print(noList)
        if self.senderList != []:
            print('\nFound unsubscribe links from these senders:')
            fullList = '| '
            for i in range(len(self.senderList)):
                fullList += (str(self.senderList[i][0])+' | ')
            print(fullList)

    '''Allow user to decide which unsubscribe links to follow/emails to delete'''
    def decisions(self):
        def choice(userInput):
            if userInput.lower() == 'y': return True
            elif userInput.lower() == 'n': return False
            else: return None
        self.displayEmailInfo()
        print('\nYou may now decide which emails to unsubscribe from and/or delete')
        print('Navigating to unsubscribe links may not automatically unsubscribe you')
        print('Please note: deleted emails cannot be recovered\n')
        for j in range(len(self.senderList)):
            while True:
                unsub = input('Open unsubscribe link from '+str(self.senderList[j][0])+' (Y/N): ')
                c = choice(unsub)
                if c:
                    self.senderList[j][3] = True
                    self.goToLinks = True
                    break
                elif not c:
                    break
                else:
                    print('Invalid choice, please enter \'Y\' or \'N\'.\n')
            while True:
                delete = input('Delete emails from '+str(self.senderList[j][1])+' (Y/N): ')
                d = choice(delete)
                if d:
                    self.senderList[j][4] = True
                    self.delEmails = True
                    break
                elif not d:
                    break
                else:
                    print('Invalid choice, please enter \'Y\' or \'N\'.\n')
    '''Navigate to selected unsubscribe, 10 at a time'''
    def openLinks(self):
        if self.goToLinks != True:
            print('\nNo unsubscribe links selected to naviagte to')
        else:
            print('\nUnsubscribe links will be opened 10 at a time')
            counter = 0
            for i in range(len(self.senderList)):
                if self.senderList[i][3] == True:
                    webbrowser.open(self.senderList[i][2])
                    counter += 1
                    if counter == 10:
                        print('Navigating to unsubscribe links')
                        cont = input('Press \'Enter\' to continue: ')
                        counter = 0

    '''Log back into IMAP servers, NOT in readonly mode, and delete emails from
    selected providers. Note: Deletes all emails from unsubscribed sender.
    Emails from provider without unsubscribe in the body will be deleted.
    '''
    def deleteEmails(self):
        if self.delEmails != True:
            print('\nNo emails selected to delete')
        else:
            print('\nLogging into email server to delete emails')
            '''Pass false to self.login() so as to NOT be in readonly mode'''
            self.login(False)
            DelTotal = 0
            for i in range(len(self.senderList)):
                if self.senderList[i][4] == True:
                    sender=str(self.senderList[i][1])
                    print('Searching for emails to delete from '+sender)
                    '''Search for UID from selected providers'''
                    DelUIDs = self.imap.search([u'FROM', sender])
                    DelCount = 0
                    for DelUID in DelUIDs:
                        '''Delete emails from selected providers'''
                        self.imap.delete_messages(DelUID)
                        self.imap.expunge()
                        DelCount += 1
                    print('Deleted '+str(DelCount)+' emails from '+str(self.senderList[i][1]))
                    DelTotal += DelCount
            print('\nTotal emails deleted: '+str(DelTotal))
            print('\nLogging out of email server')
            self.imap.logout()

    '''For re-running on same email. Clear lists, reset flags, but use same info
    for email, password, email provider, etc.
    '''
    def runAgain(self):
        self.goToLinks = False
        self.delEmails = False
        self.senderList = []
        self.noLinkList = []

    '''Reset everything to get completely new user info'''
    def newEmail(self):
        self.email = ''
        self.user = None
        self.password = ''
        self.imap = None
        self.runAgain()

    '''Called after program has run, allow user to run again on same email, run
    on a different email, or quit the program
    '''
    def nextMove(self):
        print('\nRun this program again on the same email, a different email, or quit?\n')
        while True:
            print('Press \'A\' to run again on '+str(self.email))
            print('Press \'D\' to run on a different email address')
            again = input('Press \'Q\' to quit: ')
            if again.lower() == 'a':
                print('\nRunning program again for '+str(self.email)+'\n')
                self.runAgain()
                return True
            elif again.lower() == 'd':
                print('\nPreparing program to run on a different email address\n')
                self.newEmail()
                return False
            elif again.lower() == 'q':
                print('\nSo long, space cowboy!\n')
                sys.exit()
            else:
                print('\nInvalid choice, please enter \'A\', \'D\' or \'Q\'.\n')

    '''Full set of program commands. Works whether it has user info or not'''
    def fullProcess(self):
        self.accessServer()
        self.getEmails()
        if self.senderList:
            self.decisions()
            self.openLinks()
            self.deleteEmails()
        else:
            print('No unsubscribe links detected')

    '''Loop to run program and not quit until told to by user or closed'''
    def usageLoop(self):
        self.fullProcess()
        while True:
            self.nextMove()
            self.fullProcess()
            

def main():
    Auto = AutoUnsubscriber()
    Auto.usageLoop()

if __name__ == '__main__':
    main()