PostGrid Integration
Jump to
↵select↑↓navigateescclose

Direct Mail via PostGrid

On this page

Direct Mail via PostGrid is a Frappe app that enables you to send physical letters directly from your Frappe/ERPNext system using PostGrid's Print & Mail API. With this app, you can mail the printed version of a submitted document, such as an invoice, purchase order, or customer statement, to any Frappe Address (optionally addressed to a Contact), such as those of customers, vendors, and employees. Furthermore, you can automate direct mail campaigns using the additional capabilities added to core Notifications.

Features

  • Send physical letters directly from Frappe/ERPNext

  • Automate direct mail campaigns

  • Choose a print format (and an optional cover letter) for each mailing

  • Track delivery status of each letter through PostGrid webhooks

  • View letter history and details in the document timeline, with an optional saved PDF copy

  • Seamless integration with PostGrid's direct mail service

Demo

From the print view of a submitted document, you can send a physical letter to any recipient using the added "Mail" button: PostGrid Mailing

You can also automate your mailings on doctype events using Notifications: PostGrid Notification

Installation

bench get-app avunu/postgrid_direct_mail
bench --site [site-name] install-app postgrid_direct_mail

Configuration

  1. Set up your PostGrid account and obtain the API credentials.

  2. In Frappe/ERPNext, open the PostGrid Settings.

  3. Enter your PostGrid Test and Live API keys, and choose which Mode (Test or Live) is active.

  4. Set the default options (address placement, envelope type, double sided, color, express), and choose whether to save PDF copies and update addresses from PostGrid's verified results.

  5. Save the configuration. The first save in each mode registers a PostGrid webhook for that mode, so your site must be reachable from the internet for delivery status updates to arrive.

Current limitations

  • Only letters are supported. Postcards and cheques are not implemented yet.

  • A Mailed Letter notification mails on the New, Save, Submit, Cancel, Days Before and Days After events, and on a Method event for after_insert, on_update, on_submit or on_cancel. The Value Change, Minutes Before and Minutes After events don't mail.

License

MIT. See license.txt.