Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Python wrapper for the WestFax API

Project Description

A Python implementation of the WestFax API (http://westfax.com/)

Usage requires a WestFax account.

Usage

wf = new westfax.WestFax( username, password, product )
wf.add_number('555-555-5555')
wf.set_header('This is a fax')
wf.set_job_name('My fax job')
wf.set_content("Yah! I'm a fax message!")

try:
        wf.send()
except westfax.FaxFail:
        print "Failed to send"

Methods

add_number( number )

Adds a number to the send the fax to. Mulitple numbers can be added. send() will raise westfax.NoRecipients if no valid numbers are found.

set_billing_code( billing_code )

Sets an optional billing code to track billing for the message in the WestFax dashboard

set_job_name( name )

Sets an optional job name to identify the message in the WestFax dashboard

set_header( header )

Sets the top header on the fax. (Sent with the fax. Often a company name or subject message)

set_content( content )

Text or HTML content of the message. send() will raise westfax.MissingFaxContent if no content was added to the message.

send()

Send the message to all recipients. If WestFax returns anything other than a 200 status then send() will raise westfax.FaxFail

Exceptions

All exceptions are raised on send()

NoRecipients

Raised when no numbers were added.

MissingFaxContent

Raised when no content was added to the fax message

FaxFail

Raised when the WestFax API returns anything other than a 200 status. The error message is returned as the exception message.

TODO

  • verify phone number validity on add_number()
  • Parse the error message from WestFax to raise more useful exceptions

AUTHOR

ConstituentVoice opensource@constituentvoice.com

Release History

Release History

This version
History Node

0.1.2

History Node

0.1.1

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
WestFax-0.1.2.tar.gz (3.5 kB) Copy SHA256 Checksum SHA256 Source Sep 5, 2014

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting