Official Python Library by Pepipost for sending email using Web API v2
Official Python library :snake: for Pepipost
This SDK contain methods for easily interacting with the Pepipost Email Sending API to send emails within few seconds.
We are trying to make our libraries a Community Driven. To help us building right things in proper order we would request you to help us by sharing comments, creating new issues or pull request.
We welcome any sort of contribution to this library.
The latest 2.5.0 version of this library provides is fully compatible with the latest Pepipost v2.0 API.
For any update of this library check [Releases]
Table of Content
There are two ways of installing the library for Pepipost either you can use
pip install pepipost
git clone https://github.com/hellovikram/pepipost-python.git pepipost_python
Below are the steps inorder to install the library
- Python (2 >=2.7.9 or 3 >= 3.4)
- Python IDE (we are using Pycharm )
- Python packages
Installation of PIP can be done from here.
We recommend using PIP Dependency manager in order to install all the dependencies which we had mentioned in
requirements.txt files that comes in SDK.
Defining Enviroment variable.
Python and PIP Should be defined in your PATH.
pip --version--> Will display the version of PIP dependency manager installed.
python --version--> Will display the version of Python installed
which should be >=2.7.1 if you are using python 2 else it can be >=3.4 if you are using python 3.
Use Command line to navigate to directory
Using SDK from Github repository, Run the below command to download the requirements
pip install -r requirement.txt
Using PIP dependency manager download our official library directly from PIP
Run below Command inorder to download Pepipost library.
pip install pepipost
Open Project in an IDE
Open up a Python IDE like PyCharm. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.
Openin PyCharm to browse to your generated SDK directory and then
The project files will be displayed in the side bar as follows:
Add a new Test Project
Create a new directory by right clicking on the solution name as shown below:
Name the directory as "test"
Add a python file to this project with the name "testsdk"
Name it "testsdk"
Importing files from python library
Inorder to import file you need to just copy the sample file from here.
Update API key and Sending Domain
apikey: This will be available under: Login to your Pepipost account -> Settings -> Integration.
FromEmail: If your fromemail address is e.g. email@example.com, then the Sending Domain mydomain need to be verified and active under your Pepipost account. You can manage the Sending Domain under: Login to Pepipost -> Settings -> Sending Domains.
Run the Test Project
To run the file
Right click on your Python file inside your Test project and click on
from pepipost.pepipost_client import PepipostClient from pepipost.models.email_body import EmailBody from pepipost.models.personalizations import Personalizations from pepipost.models.attachments import Attachments from pepipost.models.mfrom import From from pepipost.models.email_body_attachments import EmailBodyAttachments from pepipost.models.settings import Settings from pepipost.exceptions.api_exception import APIException import jsonpickle client = PepipostClient() email_controller = client.email body = EmailBody() body.personalizations =  api_key = 'api_key here ' body.personalizations.append(Personalizations()) body.personalizations.recipient = 'firstname.lastname@example.org' body.tags = 'tagsPython' body.mfrom = From() body.mfrom.from_email = 'example@your-verified-domain' body.mfrom.from_name = 'Example Pepi' body.subject = 'Emailing with Pepipost is easy' body.content = '<html><body>Hey,<br><br>Do you know integration is even simpler in Pepipost, <br>with Python <br> Happy Mailing ! <br><br>Pepipost </body></html>' body.settings = Settings() body.settings.footer = 1 body.settings.clicktrack = 1 body.settings.opentrack = 1 body.settings.unsubscribe = 1 try: result = email_controller.create_send_email(api_key, body) if not (result.error_info.error_message is None): print("Reason :: " + str(result.error_info.error_message) + "\n" + "Message :: " + str(result.message)) else: print("Message :: " + result.message) except APIException as e: print(e)
v2.5.0 has been released! Please see the release notes for details.
pepipost-php-sdk library is guided and supported by the Pepipost Developer Experience Team . This pepipost-php-sdk library is maintained and funded by Pepipost Ltd. The names and logos for pepipost-php-sdk are trademarks of Pepipost Ltd.
This code library was semi-automatically generated by APIMATIC v2.0 and licensed under The MIT License (MIT).
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size pepipost-2.5.0-py2-none-any.whl (27.6 kB)||File type Wheel||Python version py2||Upload date||Hashes View hashes|
|Filename, size pepipost-2.5.0.tar.gz (15.6 kB)||File type Source||Python version None||Upload date||Hashes View hashes|