Postal API connector

Post letters direct from your system with our Postal API connector, saving time and money compared to printing and posting letters yourselves. Your system can connect to the iMail Postal API provider out of the box - you just need to set up an account. You can also post mail to an FTPS or SFTP site you host yourselves, or to any other mailing API provider that supports these delivery methods.

Setting up the Postal API connector

First make sure you have set up an account with iMail, or the postal API provider of your choice, and have the username and password handy.

Sign in to your system as a user with administrator priveleges.

Go to the Administration screen, then select General settings >> Printed correspondence. Scroll down to the Automated delivery section of the screen.

Select the method of delivery you wish to use. The options are iMail, FTPS or SFTP. Then fill in the relevant details as described below.

Using iMail

Username: Your iMail account username

Password: Your iMail account passowrd

First class post: Whether you wish delivery via first or second class post

Colour: Whether you wish iMail to print and send colour or black and white correspondence

Duplex: Whether you wish iMail to print and send duplex or single sided correspondence

Using FTPS

FTPS uses the FTP protocol over SSL.

Domain: The domain of your FTPS site - e.g. ftps.customer.com

Mode: Should be set as per your FTPS provider recommendations - if in doubt set to Explicit as this is the more modern standard.

Directory: The FTP directory to which letters will be posted

Username: Username for your FTPS account

Password: Password for your FTPS account

Using SFTP

SFTP uses the secure SSH protocol to provide an FTP like service over this more modern protocol.

Host: The hostname of your SFTP site - e.g. sftp.customer.com

Port: The port used for your SFTP site - normally this will be 22, unless otherwise recommended by your provider

Directory: The SFTP directory to which letters will be posted

Username: Username for your SFTP account

Password: Password for your SFTP account