Metadata-Version: 2.1
Name: SMTPEmail
Version: 0.2.2
Summary: Send MIME messages via SMTP server and retrieve messages via POP3 and IMAP
Home-page: https://github.com/Weizhang2017/SMTPEmail
Author: Zhang Wei
Author-email: zhangw1.2011@gmail.com
License: UNKNOWN
Description: ## A simple script to send MIME message via SMTP server and retrieve messages via POP3
        
        ### Installation ```pip install SMTPEmail```
        ### Latest test version ```pip install -i https://test.pypi.org/simple/ SMTPEmail```
        
        ### Usage
        
        #### Sending email via SMTP
        
        ```shell
        >>>from SMTPEmail import SMTP
        >>>client = SMTP(
        	SMTP_server = <domain> or <IP_address>,
        	SMTP_account = <account_name>,
        	password = <SMTP_password>
        	)
        >>>client.create_mime(
        	recipient_email_addr='Jane.Doe@jane.com',
        	sender_email_addr='John.Doe@john.com',
        	subject='subject',
        	sender_display_name='John Doe',
        	recipient_display_name='Jane Doe',
        	content_html='<p>hello world</p>',
        	content_text='hello world'
        )
           
        >>>print(client) #print the message
        
        Subject: subject
        From: John Doe <John.Doe@John.com>
        To: Jane Doe <Jane.Doe@jane.com>
        Date: Tue, 13 Nov 2018 17:52:01 +0800
        Message-Id: 154210272151.1976.14038029430513051529@Jane.com
        MIME-Version: 1.0
        Content-Type: multipart/alternative;
         boundary="===============0340024224523524971=="
        
        --===============0340024224523524971==
        Content-Type: text/plain; charset="utf-8"
        Content-Transfer-Encoding: 7bit
        
        hello world
        
        --===============0340024224523524971==
        Content-Type: text/html; charset="utf-8"
        Content-Transfer-Encoding: 7bit
        MIME-Version: 1.0
        
        <p>hello world</p>
        
        --===============0340024224523524971==--
        
        >>>client.send_msg()
        ```
        #### Retrieve email via POP3
        
        > messages will be returned in byte object
        
        ```shell
        >>>from SMTPEmail import POP3
        >>>client = POP3(
        	POP3_server = <domain> or <IP_address>,
        	POP3_account = <account_name>,
        	POP3_password = <POP3_password>
        )
        >>>msgs = client.retrieve_msg()
        
        >>>for msg in msgs:
        		print(msg)
        ...
        
        >>>print(client.mailbox_size())
        {'message count': 804, 'mailbox size': 18096539}
        ```
        #### Retrieve email via IMAP
        ```shell
        >>>from SMTPEmail import IMAP
        >>>client = IMAP(
        	IMAP_server = <domain> or <IP_address>,
        	IMAP_account = <account_name>,
        	IMAP_password = <IMAP_password>
        )
        #you can select which mailbox to access and which email to retrieve by passing parameters 'mailbox_name' and 'msg_id'
        >>>for msg in client.retrieve_msg(mailbox_name='inbox', msg_id='1,3,5-8,11'):
        	   print(msg)
        #'mailbox_name' and 'msg_id' are optional, the user will be promted to input the two parameters if either is missing
        >>>msgs = client.retrieve_msg()
        0. "INBOX"
        1. "Templates"
        ...
        Please select a mailbox:1
        message id: 1 2 3 4 5 6 ...
        Please select mail ID to retrieve email(e.g. 1-5,6,7): 1,3-6
        
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
