Docmail physical mail API v2.0
Welcome to the new and improved Docmail physical mail API!
As ever, Docmail's secure API (Application Programming Interface) allows you to send A4 letters, Postcards, Greeting Cards and Business Cards (corporate only) from a click of a button within your own computer systems.
Docmail creates a Hybrid of electronic and physical mail by transmitting an electronic document and mailing list to us, where we print and mail it as real post!
The Docmail API allows you to add a Hybrid Mail service right into your own systems and workflows.
The API is a SOAP-based webservice allowing the creation, proofing and confirmation of orders for mailings, single letters, postcards and greeting cards. Documents (PDF, RTF or Word files) are submitted as files or selected by name from your account. Address lists may be selected by name, submitted as a file (CSV, XLS, XLSX, Tab delimited, fixed length fields etc.) or added as individual addresses using the AddAddress call.
A PDF proof approval is available, but is no longer a required step in the process.
Payment is made via Top-Up credit on the customer Account, or for large volume users, payment on invoice may be available (subject to status, volume and regularity of orders).
Examples in the API documentation are based around Microsoft Visual Basic .Net © code and the Microsoft Visual Studio 2008 © development environment.
Here you'll find sample codes and projects to get you started with Docmail's physical mail API.
Microsoft Visual Basic .Net
More Code Samples & Examples to help get you started in other languages and coding environments will follow.
Docmail Test Environment
Docmail provides a seperate testing environment for use with the API. It provides the same API, and web functionality as the live system, with a website mirroring the live version. We do not produce any print or mail output from the test environment and any credit has no cash value. Credit in the test system can be topped up from the Account Admin section of the test website without charge.
The test environment uses seperate databases, so your live login details don't apply. Likewise, your test login credentials are not available for use in the live environment.
Feel free to browse & access the test website and test with the API, remembering that to send any live mailings, you'll need to switch your credentials to your live account and the webservice URL over to the live address, shown below.
Webservice definitions for the API are available at these URL’s:
More power (via newly exposed features)
Faster, Simpler calls
Version 1 of the API is still available and still supported, though it is no longer under active development. For more details on the previous version please use the link in the sidebar.
The Docmail API supports envelope size selection via the MinEnvelopeSize property, along with access to the Postcard, Greeting Card and Business Card (corporate only) products via the DocumentType parameter (e.g. on the AddTemplateFile calls).
This means you can now send custom letters, postcards, greeting cards and business cards (*) directly via our API!
(*) business cards available on corporate accounts only
PDF Document Streams (see Webservice Help Guide for more details) are still supported via the TemplateType parameter (e.g. on the AddTemplateFile calls).
Envelope Selection. Use parameter [MinEnvelopeSize]
Stream of Documents in PDF . Use parameter [TemplateType]