com.adobe.icc.ddg.api

Interface DeliveryService

public interface DeliveryService

Service that performs the post complete or delivery actions of a correspondence, such as email, print, save to file system.

Method Summary

Modifier and Type	Method and Description
void	sendForCustomAction(String letterInstanceId, String processName) Send the correspondence to a process, for any custom action on the correspondence.
void	sendForEmail(String letterInstanceId, int format, String sender, String toRecipients, String ccRecipients, String bccRecipients, String subject, String body) Email the correspondence to the designated recipients with the given subject and body.
void	sendForPrint(String letterInstanceId, int format, int printType, String customPrinterUrl) Sent the correspondence for print.
void	sendForSave(String letterInstanceId, int format, String filename, String savePath) Saves the correspondence at the given location on the file system.

Method Detail

sendForEmail

void sendForEmail(String letterInstanceId,
                  int format,
                  String sender,
                  String toRecipients,
                  String ccRecipients,
                  String bccRecipients,
                  String subject,
                  String body)
           throws ICCException

Email the correspondence to the designated recipients with the given subject and body.

Parameters:

letterInstanceId - GUID of the letter instance to be sent via email

format - Email format (PDF/HTML)

sender - email address of sender

toRecipients - comma-separated list of recipients

ccRecipients - comma-separated list of recipients

bccRecipients - comma-separated list of recipients

subject - subject of the email

body - body of the email

Throws:

ICCException

sendForPrint

void sendForPrint(String letterInstanceId,
                  int format,
                  int printType,
                  String customPrinterUrl)
           throws ICCException

Sent the correspondence for print.

Parameters:

letterInstanceId - GUID of the letter instance to be sent for printing

format - Print format (PS/PCL)

printType - Print Type (Simplex, Duplex Long Edge, Duplex Short Edge)

customPrinterUrl - custom printer URL (optional)

Throws:

ICCException

sendForSave

void sendForSave(String letterInstanceId,
                 int format,
                 String filename,
                 String savePath)
          throws ICCException

Saves the correspondence at the given location on the file system.

Parameters:

letterInstanceId - GUID of the letter instance to be sent.

format - Save format (PDF/HTML/XML)

filename - filename to be used when saving the correspondence PDF.

savePath - file system path to be used to save the correspondence PDF.

Throws:

ICCException

sendForCustomAction

void sendForCustomAction(String letterInstanceId,
                         String processName)
                  throws ICCException

Send the correspondence to a process, for any custom action on the correspondence.

Parameters:

letterInstanceId - GUID of the letter instance to be sent.

processName - the custom process name

Throws:

ICCException