Python win32com outlook documentation

Saved searches

Use saved searches to filter your results more quickly

You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session.

Automating Outlook Using Python win32com Library

Hridai/Automating_Outlook

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

Sign In Required

Please sign in to use Codespaces.

Launching GitHub Desktop

If nothing happens, download GitHub Desktop and try again.

Launching GitHub Desktop

If nothing happens, download GitHub Desktop and try again.

Launching Xcode

If nothing happens, download Xcode and try again.

Launching Visual Studio Code

Your codespace will open once ready.

There was a problem preparing your codespace, please try again.

Latest commit

Git stats

Files

Failed to load latest commit information.

README.md

Automating Outlook using Python win32com

Saving attachments from a daily e-mail or moving an e-mail from one folder to another is super easy using Python! You can carry out literally any repetitive task using the Win32com library and the below will demonstrate a basic example which carries out the below:

• Goes through emails in a folder one by one and saves the attachment to a windows directory of your choice
• Moves the processed e-mail to another Outlook folder

This project contains a script which can be run to carry out the below:

• Save all attachments on emails in a folder
• Save all email bodies in a folder as csv
• Move emails from folder to subfolder

The below script can be called from the command line or can be embedded in another program so it is easy to schedule using a task scheduler (or crontab) as well as triggering manual runs as an embedded functionality in another program. All is explained below.

«Can you automate the saving down of attachments from a daily file I receive from x?» This is often the first question I’m asked when I tell people I can help them automate their most menial tasks. And the short answer is: Yes!.

There are two approaches. The VBA method which will require you to write this code in the VBE within Outlook. This is impossible to trigger via an e-mail event as Microsoft removed the ability to trigger a script on the back of one mid 2018. Task Scheduler is my method of choice to automate this functionality. It is possible to use the same Outlook objects in python by way of a very poorly documented library called win32com. It was tough to get it to work, but once you figure it out, it works without any of the funky hit-and-miss randomness anyone who’s ever used VBA will have experienced. It works like a dream and here’s how to get started.

Python 3 and pip-install pywin32

This will allow you to do

There is one main function that has been written such that you can call it from the command line or a GUI. The only difference between them is how an error message is displayed. If It is from the command line success and errors are printed to the console whereas if called from a GUI the function will return the error message (presumably to be displayed somewhere on screen).

def runOlScript(outdest, filefmt, olreadfolder, olprocessedfolder, guiEntry, proc): outdest = os.path.normpath(outdest) outlook = win32com.client.Dispatch("Outlook.Application").GetNamespace("MAPI") inbox = _find_subfolder(outlook.Folders, olreadfolder) if inbox is None: sys.exit(f'No Folder olreadfolder> found. Exiting.') procbox = _find_subfolder(outlook.Folders, olprocessedfolder) if procbox is None: sys.exit(f'Folder olprocessedfolder> not found. Exiting.') messages = inbox.Items if len(messages) == 0: _scriptOutput( 'No emails found in folder [<>]'.format(olreadfolder), gui_entry) mail_counter = 0 for msg in list(messages): b_processed = False if proc == 'olatt': for atmt in msg.Attachments: if filefmt == 'blank' or str.lower(_right(atmt.FileName, len(filefmt))) == str.lower(filefmt): temp_filename = os.path.normpath(os.path.join(outdest, f'msg.Subject> atmt.FileName>')) try: atmt.SaveAsFile(temp_filename) print('File Successfully Saved [<>]'.format(temp_filename)) b_processed = True except Exception as e: _scriptOutput(str(e) + ' | File NOT saved [<>]'.format(temp_filename), gui_entry) if proc == 'olbody': listbody = msg.Body.split("\r\n") temp_filename = os.path.normpath(os.path.join(outdest, f'msg.Subject> msg.CreationTime.strftime("%Y%m%d")> .csv')) b_processed = True with open(temp_filename, 'w', newline='') as file: writer = csv.writer(file) for row in listbody: writer.writerow([row]) if b_processed and procbox is not None: mail_counter += 1 msg.Move(procbox) return 'Succesfully processed <> emails!'.format(mail_counter) if mail_counter > 0 else 'No emails processed'

runOlScript has 6 function arguments:

1. outdest — the path to the folder you wish to save the attachments or email bodies
2. filefmt — the file format you would only like to save. Helpful if you only want to save the .csv files across many e-mails
3. olreadfolder — the name of the outlook folder which has the e-mails you wish to process (must be a uniquely named folder!)
4. olprocessedfolder — the name of the subfolder you wish you move these sucessfully processed e-mails to (must be a uniquely named folder!)
5. guiEntry — True if called from a GUI. False if called from a cmd prompt
6. proc — Name of the process being run «olatt» is save attachments only, «olbody» will save the text found in the body of the emails as a .csv each with a datestamp

Calling This From a Command Line

You will need to pass the 5 function by way of cmd line argument and parse them programatically to read them into the main funtion call, is illustrated below.

if __name__ == "__main__": parser = argparse.ArgumentParser() parser.add_argument("-ola","--olatt",default=False) parser.add_argument("-olb","--olbody",default=False) parser.add_argument("-out","--outdest",default="") parser.add_argument("-olf1","--olfolder",default="") parser.add_argument("-olf2","--olprocfolder",default="") parser.add_argument("-typ","--olfiletype",default="blank") args = parser.parse_args() if (not args.olatt and not args.olbody): sys.exit('No process choice made, choose between ol attachments saver (--olatt) and ol mail body saver (--olbody)!') if args.outdest == '': sys.exit('No out destination defined using --outdest defined!') if args.olfolder == '': sys.exit('No outlook folder to search mails for defined using --olfolder!') if args.olprocfolder == '': sys.exit('No outlook folder to move processed mails to defined using --olprocfolder!') proc = 'olatt' if args.olatt else 'olbody' if args.olbody else '' runOlScript(args.outdest, args.olfiletype, args.olfolder, args.olprocfolder, False, proc )

Setting up the command line line you require down as a bat file and attaching this to a task in the Windows Task Scheduler is the easiest way to do this. This is what my .bat file looks like which is set to run this every day at 5pm:

The first path is where your Python interpreter lives, the second path is where your script is saved and the rest of them the 5 arguments required to get this script to run.

C:\GitProjects\dir1\dir2\Scripts\python.exe "C:/GitProjects/dir1/ol_script.py" --olbody True --olfolder CSVTester --olprocfolder CSVTesterProcessed --olfiletype csv --outdest "C:/Users/Username/Documents/CSV OutDir/"

For any questions do not hesitate to e-mail me at HridaiTrivedy@Gmail.com

Full script available for download here at the top of this page!

About

Automating Outlook Using Python win32com Library

Источник

Четкое документированное чтение функций электронной почты с помощью python win32com outlook

Я пытаюсь лучше понять взаимодействие Outlook через win32com. Я не смог найти четкую документацию, которая позволяет мне использовать win32com для эффективного чтения электронных писем, из моего текущего расследования это похоже на довольно регулярные чувства пользователей. Таким образом, появляется следующая информация и запрос:

1. Дайте ссылку на место четкой документации (если она существует)

2. Разверните ниже

Ниже приведена текущая функциональность, основанная на чтении кода других людей.

Возьмите приведенный ниже код:

import win32com outlook=win32com.client.Dispatch("Outlook.Application").GetNamespace("MAPI") inbox=outlook.GetDefaultFolder(6) messages=inbox.Items for message in messages: attachments = message.attachments for attachment in attachments: pass 

Объекты, используемые выше, имеют следующие функциональные возможности, о которых я знаю:

.GetFirst() .GetLast() .GetNext() .GetPrevious() .Attachments 

.Subject .Body .To .Recipients .Sender .Sender.Address 

Если вы знаете больше функциональности, добавьте к этому в свои ответы.

Визуальная базовая ссылка для приложений – ваш друг. Попробуйте начать с этой ссылки…

Например, я вижу, что это сообщение, вероятно, будет иметь дополнительные свойства, чем указано выше. Например.

Для всех интересующихся, как добраться до любой папки по умолчанию, а не просто “Входящие” здесь список:

3 Deleted Items 4 Outbox 5 Sent Items 6 Inbox 9 Calendar 10 Contacts 11 Journal 12 Notes 13 Tasks 14 Drafts 

Есть больше (напоминания, ошибки синхронизации и т.д.); вы можете получить весь список с помощью этого кода (вдохновленный John Cook solution в папки):

import win32com outlook=win32com.client.Dispatch("Outlook.Application").GetNamespace("MAPI") for i in range(50): try: box = outlook.GetDefaultFolder(i) name = box.Name print(i, name) except: pass 

Я не вставляю весь список здесь, потому что мой на польском языке и не будет действительно полезным.

Я думал, что добавлю что-то и для навигации по папкам – все это вытекает из документации Microsoft выше, но может быть полезно здесь, особенно если вы пытаетесь перейти в любую папку в структуре папок Outlook, кроме Входящие.

Вы можете перемещаться по коллекции папок с помощью folders – отметить в этом случае, нет GetDefaultFolder после GetNamespace (иначе вы, скорее всего, попадете в папку “Входящие” ).

outlook = win32com.client.Dispatch("Outlook.Application").GetNamespace('MAPI') folder = outlook.Folders[1] 

Число – это индекс папки, к которой вы хотите получить доступ. Чтобы узнать, сколько там подпапок:

Если у вас есть другие подпапки, вы можете использовать еще один folders для более глубокого:

folders возвращает список подпапок, поэтому, чтобы получить имена всех папок в текущем каталоге, вы можете использовать быстрый цикл.

for i in range(folder.Count): print (folder[i].Name) 

Каждая из подпапок имеет метод .Items , чтобы получить список писем.

Вы можете увидеть все живые объекты Outlook и их данные в OutlookSpy.

MailItem свойства объекта, методы и события полностью документированы в https://msdn.microsoft.com/en-us/library/office/ff861332.aspx

attachment.FileName attachment.Type attachment.Position attachment.BlockLevel attachment.Class attachment.DisplayName attachment.Parent attachment.Session attachment.Size attachment.Index attachment.Application 

Источник