2019.1
Table Of Contents
- Table of Contents
- Welcome to the PlanetPress Connect REST API Cookbook
- Technical Overview
- Working Examples
- Getting Started
- Server Security & Authentication
- Working with the File Store
- Working with the Entity Services
- Working with the Workflow Services
- Running a Data Mapping Operation
- Running a Data Mapping Operation (Using JSON)
- Running a Data Mapping Operation for PDF/VT File (to Data Set)
- Running a Data Mapping Operation for PDF/VT File (to Content Set)
- Running a Content Creation Operation for Print
- Running a Content Creation Operation for Print By Data Record (Using JSON)
- Running a Content Creation Operation for Email By Data Record (Using JSON)
- Creating Content for Web By Data Record
- Creating Content for Web By Data Record (Using JSON)
- Running a Job Creation Operation (Using JSON)
- Running an Output Creation Operation
- Running an Output Creation Operation (Using JSON)
- Running an Output Creation Operation By Job (Using JSON)
- Running an All-In-One Operation (Using JSON)
- REST API Reference
- Authentication Service
- Content Creation Service
- Service Handshake
- Process Content Creation
- Process Content Creation (By Data Record) (JSON)
- Process Content Creation (By Data) (JSON)
- Create Preview PDF
- Create Preview PDF (By Data Record)
- Create Preview PDF (By Data) (JSON)
- Get All Operations
- Get Progress of Operation
- Get Result of Operation
- Cancel an Operation
- Service Version
- Content Item Entity Service
- Content Set Entity Service
- Data Record Entity Service
- Data Set Entity Service
- Data Mapping Service
- Document Entity Service
- Document Set Entity Service
- Content Creation (Email) Service
- Entity Service
- File Store Service
- Content Creation (HTML) Service
- Job Creation Service
- Job Entity Service
- Job Segment Entity Service
- Job Set Entity Service
- Output Creation Service
- All-In-One Service
- Copyright Information
- Legal Notices and Acknowledgements
into the appropriate text fields as your inputs.
Next you need to specify the email parameters to use with the content creation operation:
l Section – the section within the Email context of the template to use
l From – the email address to be shown as the sender in the email output
l Host – the network address or name of your SMTP mail server through which the emails
will be sent. If required, a server port value can also be specified
l Use From as To Address – use the sender address as the receiver address for all
emails in the output
l Attach PDF Page to Email – if a Print context exists in the template, create it's output as
a PDF and attach it to the email output
l Attach Web Page to Email – if a Web context exists in the template, create it's output as
a single HTML web page (with embedded resources) and attach it to email output
Then you need to specify how email security is to be used with the content creation operation:
l Use Authentication – if authentication is to be used with the mail server
l Start TLS – if Transport Layer Security (TLS) is to be used when sending emails
l Username – the username to authenticate/login with
l Password – the password to authenticate/login with
Lastly, select the Submit button to start the content creation operation.
Once the operation has started processing, the Operation ID will be displayed in the Results
area and the Cancel button will become enabled, giving you the option to cancel the running
operation.
The progress of the operation will be displayed in the progress bar, and once the content
creation operation has completed, a report of the emails successfully sent will be returned and
displayed to the Results area.
Further Reading
See the Content Creation (Email) Service page of the REST API Reference section for further
detail.
Page 250