Quickstart

Install the Paubox Python SDK and send your first HIPAA compliant email in minutes.

1. Install the SDK

   pip3 install paubox-python3
   
2. Set your credentials

   Export your API key and endpoint host as environment variables:

   export PAUBOX_API_KEY="YOUR_API_KEY"
   export PAUBOX_HOST="https://api.paubox.net/v1/YOUR_USERNAME"
   

   Replace YOUR_USERNAME with your Paubox API endpoint username. To obtain credentials, see Authentication.

3. Send your first email

   Create send.py:

   from paubox import PauboxApiClient
   from paubox.helpers.mail import Mail
   
   client = PauboxApiClient()
   
   mail = Mail(
       from_      = '[e-mail]',
       subject    = 'Your first Paubox email',
       recipients = ['[e-mail]'],
       content    = {'text/plain': 'This message was sent with the Paubox Python SDK.'}
   )
   
   response = client.send(mail.get())
   
   print('Status:', response.status_code)
   print('Response:', response.to_dict)
   

   Run it:

   python3 send.py
   

   The response dict contains sourceTrackingId.

4. Check delivery status

   tracking_id = response.to_dict['sourceTrackingId']
   
   disposition = client.get(tracking_id)
   print(disposition.to_dict)
   

   The response includes message_deliveries with per-recipient status.

Next steps

• Email client: add HTML, attachments, CC/BCC, and handle errors
• Forms client: retrieve form schemas and submit responses