Provider APIs

The inbox row's api_adapter chooses the client. PostScan Mail is documented at github.com/PostScanMail/api-docs (https://api.postscanmail.com/api/account-docs/v2, x-api-key). VirtualPostMail is Zapier plus a partner API at virtualpostmail.com/developers. iPostal1 is the customer portal.

PostScan Mail

Method	Path	Use
GET	/items	list items; sort_order, page (documented)
GET	/user-defined-rules/system-user-defined-rules	auto scan / shred / discard rules (documented)
PUT	/user-defined-rules/update-system-user-defined-rule	toggle a system rule (documented)
POST	/addresses/{address_id}/items/actions/open	scan / open (documented)
POST	/addresses/{address_id}/items/actions/open/cancel	cancel open (documented)
POST	/addresses/{address_id}/items/actions/rescan	rescan (documented)
POST	/addresses/{address_id}/items/actions/rescan/cancel	cancel rescan (documented)
POST	/addresses/{address_id}/items/actions/shred	shred physical (documented)
POST	/addresses/{address_id}/items/actions/shred/cancel	cancel shred (documented)
POST	/addresses/{address_id}/items/actions/discard	discard / recycle (documented)
POST	/addresses/{address_id}/items/actions/discard/cancel	cancel discard (documented)
POST	/addresses/{address_id}/items/actions/forward	physical forward (product; not in public README)
POST	/addresses/{address_id}/items/actions/forward/cancel	cancel forward (product)
POST	/addresses/{address_id}/items/actions/ship	ship alias used by live accounts
POST	/addresses/{address_id}/items/actions/ship/cancel	cancel ship
POST	/addresses/{address_id}/items/actions/check	check / deposit-adjacent
POST	/addresses/{address_id}/items/actions/check/cancel	cancel check

VirtualPostMail

Method	Path	Use
GET	/api/v1/mail	list items (partner API)
GET	/api/v1/mail/{id}	one item
GET	/api/v1/mail/{id}/images	envelope / content images
POST	/api/v1/mail/{id}/scan	open and scan
POST	/api/v1/mail/{id}/forward	forward / ship
POST	/api/v1/mail/{id}/shred	shred physical, keep images
POST	/api/v1/mail/{id}/recycle	archive / recycle (keep images)
POST	/api/v1/mail/{id}/archive	archive alias
POST	/api/v1/mail/{id}/trash	trash physical + images
POST	/api/v1/mail/{id}/deposit	check deposit when the mailbox offers it

iPostal1

Method	Path	Use
PORTAL	my.ipostal1.com inbox toolbar	Scan / Discard / Shred / Ship via Playwright