This library helps to dump letters from outlook to some local folder in human readable format.
Project description
Short Overview.
outlook_mail_loader is a python package (py>=3.6) which helps in handling outlook letters
This library helps to dump letters from outlook to some local folder in human readable format.
Installation via pip:
pip install outlook_mail_loader
Typical usages
1) Dump letters from outlook to local directory
Simplest example
from outlook_mail_loader import MailFolderDumper
mail_loader_obj = MailFolderDumper(
str_outlook_folder_name="inbox",
str_path_dir_where_to_save="mails",
)
# To dump the new letters from the asked outlook folder
mail_loader_obj.dump_new()
After the dump you will get file-folder structure like that:
Full signature of mail_loader_obj.dump_new method
# Full signature of the dump_new method
mail_loader_obj.dump_new(
int_max_last_letters_to_dump=10,
is_to_mark_messages_as_read=False,
is_to_remove_attachments=False,
is_to_preserve_msg_obj=False,
)
Attributes and methods of mail_loader_obj
Attributes:
.str_outlook_folder_name (str): Folder name which to dump
.str_path_dir_where_to_save (str): Path where to dump
Methods:
.dump_new(…) - Dump new letters to set local directory
.print_stats_about_initialized_folders() - Print hierarchy for initialized outlook mail folder
.print_full_folders_hierarchy_from_root() - Print full hierarchy from root outlook mail folder
2) Process dumped letters
Example
from outlook_mail_loader import DumpedMails
dumped_mails_obj = DumpedMails(str_path_dir_with_mails="mails",)
# Get dictionary with last letter
dict_last_letter = dumped_mails_obj.get_last_letter()
print(get_last_letter)
# Get dictionary with last N letter
list_dict_last_5_letter = dumped_mails_obj.get_last_n_letters(5)
# Print statistics about all dumped letters
dumped_mails_obj.print_stats_about_dumped_mails()
Format of the dictitonary with dumped letter
dict_one_letter[“letter”] - Text of the letter
dict_one_letter[“dict_metainfo”] - All metainfo about the letter
dict_one_letter[“list_attachments”] - List pathes to files with letter’s attachments
Attributes and methods of dumped_mails_obj
Attributes:
.str_path_dir_with_mails (str): Path to dir with dumped letters
.int_last_dumped_id (str): Id of the last dumped letter
Methods:
.get_last_letter() - Get dictionary with last letter
.get_last_n_letters(int_last_letters_to_get) - Get list of dicts of last N letters
.print_stats_about_dumped_mails() - Print statistics about all dumped letters
.clear_dumped_mails() - Clear from cache dumped mails
3) Listen to some outlook folder to dump all letters continuously
Example
from outlook_mail_loader import listen_outlook_mail_folder
# To dump the new letters from the asked outlook folder
listen_outlook_mail_folder(
str_outlook_folder_name="inbox",
str_path_dir_where_to_save="mails",
int_seconds_step_in_dump=60,
)
Full signature of listen_outlook_mail_folder
from outlook_mail_loader import listen_outlook_mail_folder
# Full signature of the dump_new method
listen_outlook_mail_folder(
str_outlook_folder_name="inbox",
str_path_dir_where_to_save="mails",
int_seconds_step_in_dump=60,
is_to_mark_messages_as_read=False,
is_to_remove_attachments=False,
is_to_preserve_msg_obj=False,
)
Arguments description:
str_outlook_folder_name (str, optional): Which outlook folder to listen
str_path_dir_where_to_save (str, optional): Path to dir. where to save letters.
int_seconds_step_in_dump (int, optional): Seconds to wait between dumping new letters.
is_to_mark_messages_as_read (bool, optional): Flag if to mark as read saved letters. Default is False.
is_to_remove_attachments (bool, optional): Flag if to remove attachments to save disk space. Default is False.
is_to_preserve_msg_obj (bool, optional): Flag if to preserve outlook .msg object. Default is False.
Links
Project local Links
Contacts
License
This project is licensed under the MIT License.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for outlook_mail_loader-0.1.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eebb9e8e2c83ad0d6e3a4e67d739dd41e5310c82ed60b01fb5a3966a67261b95 |
|
MD5 | a786f829e828833cf758c40697a24f7e |
|
BLAKE2b-256 | b2522962256a62ac8a675ab46d8906494a5c2a6f5a8ae09aba1d4318345af605 |