imap_storage.storage package

Subpackages

• imap_storage.storage.email package
  • Submodules
  • imap_storage.storage.email.address module
  • imap_storage.storage.email.body module
  • imap_storage.storage.email.email module
  • imap_storage.storage.email.file module
  • imap_storage.storage.email.head module
  • Module contents

Submodules

imap_storage.storage.directory module

Directory class This represents a physical directory at storage level (imap)

class imap_storage.storage.directory.Directory(storage, folder)

Bases: object

Directory class

add_file_email(file)

Create new Email with one file

Parameters:file (File) – object to append as file to the directory Returns:new created file Email Return type:Email

app_name

the name of the application of this directory

Returns: Return type:str

breadcrumbs

path of this directory in breadcrumb format

Returns:[self.parent.parent.parent, self.parent.parent, self.parent] Return type:list

childs

childs of this directory

Returns:of directories [Directory, …] Return type:list

delete()

Delete this storage

Warning

Also deletes its subdirectories recursively

Returns:True if success Return type:bool

delete_email(email_uid_or_obj)

delete email within this directory

Parameters:email_uid_or_obj (Email, int, str) – email to delete Returns:True if success Return type:bool

email_by_uid(uid)

get email by uid

Parameters:uid (int) – uid you want to have the email object Returns:if email with uid exists in this directory or None Return type:Email

emails

cannot be dynamic because of self.fetch methods

fetch_body(email)

fetch email body

Parameters:email (Email) – fetch body of this email Returns:body of email Return type:str

fetch_head(email)

fetch email head

Parameters:email (Email) – fetch head of this email Returns:head of email Return type:str

fetch_payloads(email)

Returns:payloads as string

fetch_subjects(email=None)

fetch subjects

Parameters:email (Email, optional) – fetch only from this email Returns:{uid: subject} Return type:dict

file_by_name(name)

get file by name

Parameters:name (str) – name of the file to get Returns:first file with name Return type:File

files

List files of all emails inside this directory

Returns:of files Return type:list

item_name

this is the name of the item

Returns:str

new_email(item_name, from_addr=None, from_displ=None)

needs to be runned if its a ne Email with no uid

parent

parent directory

Returns: Return type:Directory

refresh()

refresh the directories cached properties

save_message(msg_obj)

save msg_obj to imap directory :returns: new uid on success or False

uids

keep this uptodate because self.emails compares to it

url

makes the Django life easier

Returns:path as url Return type:str

imap_storage.storage.storage module

Factory for Storage This is the layer between bare Imap and the directories that hold the data

class imap_storage.storage.storage.Storage(imap)

Bases: object

Storage is the view of the IMAP directory

clean_folder_path(folder_name)

Parameters:folder_name (str) – folder name to clean Returns:cleaned folder name Return type:str

delete_directory(path)

Delete directory and its subdirectories

Parameters:path (str) – directory path to delete Returns:of paths(str) that have been deleted at imap Return type:list

directories

Lists of all Directory objects at this storage

Returns:Containing Directory objects Return type:list

directory_by_path(path)

Parameters:path (str) – find directory with that path Returns:with the given path Return type:Directory

get_bodies(uids)

fetch the body of one or multiple messages

Parameters:uids – which message bodies should get fetched. can be one of type(list, str, float, int) Returns:with bodies of uids {int(uid): str(body)} Return type:dict

get_file_payloads(uids)

fetch the payload of one or multiple messages :param uids: which message payloads should get fetched.

can be one of type(list, str, float, int)

Returns:with payloads of uids {int(uid): payloads of uid} Return type:dict

get_heads(uids)

fetch the head of one or multiple messages

Parameters:uids – which message heads should get fetched. can be one of type(list, str, float, int) Returns:with heads of uids {int(uid): str(head)} Return type:dict

get_subjects(folder=None)

Fetch subjects

Parameters:folder (str, optional) – select which folder you want to fetch subjects of. It will be created and selected if needed. Returns:of subjects and uids {subject: [uid, uid]} Return type:dict

new_directory(path)

creates new directory and all subdirectories along the path :param path: create directory with that path :type path: str

Returns:new created Return type:Directory

uninstall()

deletes the complete storage directory recursive and log out

Returns:at the moment :TODO: Return type:None

Module contents