StreamServe . User Guide SP2 Rev A

Transcription

1 StreamServe User Guide SP2 Rev A

2 StreamServe User Guide SP2 Rev A 2007 StreamServe, Inc. StreamServe is a trademark of StreamServe, Inc. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of StreamServe, Inc. Information in this document is subject to change without notice. StreamServe Inc. assumes no responsibility or liability for any errors or inaccuracies that may appear in this book. All registered names, product names and trademarks of other companies mentioned in this documentation are used for identification purposes only and are acknowledged as property of the respective company. Companies, names and data used in examples in this document are fictitious unless otherwise noted. StreamServe, Inc. offers no guarantees and assumes no responsibility or liability of any type with respect to third party products and services, including any liability resulting from incompatibility between the third party products and services and the products and services offered by StreamServe, Inc. By using StreamServe and the third party products mentioned in this document, you agree that you will not hold StreamServe, Inc. responsible or liable with respect to the third party products and services or seek to do so. The trademarks, logos, and service marks in this document are the property of StreamServe, Inc. or other third parties. You are not permitted to use the marks without the prior written consent of StreamServe, Inc. or the third party that owns the marks. Use of the StreamServe product with third party products not mentioned in this document is entirely at your own risk, also as regards the StreamServe products. StreamServe Web Site

3 3 Contents Retrieving s...5 Specifying what to retrieve...7 Specifying what to delete...8 Attachment handling...9 Scripting functions for attachment handling... 9 Sending s...11 Standard Process and connector...12 MailOUT Process and connector...13 MailOUT Process and Topcall connector...15 MailOUT Process reference...16

4 4

5 5 Retrieving s The IN input connector enables the Communication Server to retrieve input from a designated mailbox. Access to the mailbox You must specify the parameters that the Communication Server needs in order to access the mail folder to scan for input. Use the following IN connector settings: Mailbox type Port Mail server name Mail folder User name Password What to retrieve from the mailbox You must specify which s to retrieve from the mailbox. You can select to retrieve all s, and you can also create a filter that determines which s to retrieve. Use the following IN connector settings: Mail read filter From To Cc Date Subject Reply To Signed Encrypted See also Specifying what to retrieve on page 7. Which type of information in an to process You must specify which type of information in an to select and process attachment, body, or both. Use the following IN connector settings: Read mail text Read attachment file

6 6 Retrieving s What to delete You must specify whether or not to delete an after it has been retrieved by the Communication Server. You can select to delete the after it has been retrieved, after it has been retrieved and processed, and you can also create a filter that determines which s to delete. Use the following IN connector settings: Delete mail Mail delete filter Delete From Delete To Delete Cc Delete Date Delete Subject Delete Reply to See also Specifying what to delete on page 8. Whether or not to save attachments You must specify whether or not to save attachments, and where to save them. Use the following IN connector settings: Save attachment Attachment directory See also Attachment handling on page 9. S/MIME encryption and authentication You can select to use S/MIME for authentication and encryption. See the Encryption and authentication documentation.

7 Specifying what to retrieve 7 Retrieving s Specifying what to retrieve To retrieve all s In the connector settings dialog box, select Mail read filter> Read all. To use a filter 1 In the connector settings dialog box, select Mail read filter > Advanced. 2 Use To, Cc, etc. to specify the filter.

8 8 Specifying what to delete Retrieving s Specifying what to delete To delete all s 1 In the connector settings dialog box, select Delete mail > Yes. 2 Select Mail delete filter > Delete all. To delete processed s 1 In the connector settings dialog box, select Delete mail > Yes. 2 Select Mail delete filter > Delete Processed. To use a filter 1 In the connector settings dialog box, select Delete mail > Yes. 2 Select Mail delete filter > Advanced. 3 Use Delete To, Delete Cc, etc. to specify the filter.

9 Attachment handling 9 Retrieving s Attachment handling To save attachments to disk 1 In the connector settings dialog box, select Save attachment > Yes. 2 Select the Attachment directory where to save the attachment files. To use saved attachments The attachment files saved to disk will be given new unique names. The reason for this is to prevent files from being overwritten. You must use scripting functions where you map the original file names to the corresponding names of the files saved to disk. See Scripting functions for attachment handling on page 9. To delete saved attachments Attachments saved to disk are not removed automatically. One way to delete the attachments is to call an After Event script using the FileDelete scripting function. See Scripting functions for attachment handling on page 9. Scripting functions for attachment handling Current attachment You can use the CurrInFileName scripting function to fetch the file name of the current attachment sent through the Communication Server. See the Scripting reference. Attachments saved on disk To manage the attachments saved to disk you must use the following scripting functions where you map the original file names to the corresponding file names of the files saved to disk: GetAttachmentFile GetAttachmentOriginalFile GetAttachmentCount See the Scripting reference. Example 1 Get the attachment streamserve.gif $i=1; $count = GetAttachmentCount(); while(num($i)<=num($count)) { $original = GetAttachmentOriginalFile(num($i)); if($original = "streamserve.gif") { $file = GetAttachmentFile(num($i)); }

10 10 Attachment handling Retrieving s } $i++; Content type and encoding of attachments To retrieve content type and encoding of attachments you can use the following scripting functions. GetAttachmentContentEncoding GetAttachmentContentType See the Scripting reference. Deleting saved attachments Attachments saved to disk are not removed automatically. One way to delete the attachments is to call an After Event script using the FileDelete scripting function. Example 2 Deleting attachments $i=1; $count = GetAttachmentCount(); while(num($i)<=num($count)) { $delete = GetAttachmentFile(num($i)); FileDelete($delete); $i++; } GetConnectorValue You can use the scripting function GetConnectorValue to fetch IN attributes. See the connector reference.

11 11 Sending s There are three types of configurations for sending A standard Process and an connector A MailOUT Process and an connector A MailOUT Process, a PageOUT Process and a Topcall connector Standard Process and connector This configuration includes a standard Process (PageOUT Process, StreamOUT Process, etc.) and an connector. Processed output will be sent directly from the Process, via the connector, to a mail server. The address information, subject, etc. is set-up in the connector configuration. Which connector to use depends on the type of mail server. This is the most effortless method if you want to processed output. See Standard Process and connector on page 12. MailOUT Process and connector This configuration includes a MailOUT Process, an connector and, optionally, a standard Process. The output from the MailOUT Process is an . To this you can attach files from disk and output from other Processes. The is sent via an connector to a mail server. Which connector to use depends on the type of mail server. This is the most effortless method if you only want to attach files on disk to an , or send plain information in the body. See MailOUT Process and connector on page 13. MailOUT Process, PageOUT Process and Topcall connector TOPCALL is a registered trademark of TOPCALL International AG. This configuration includes a MailOUT Process, a PageOUT Process, and a Topcall output connector. The PageOUT output is sent as a PDF or PCL attachment, via the MailOUT Process and the Topcall connector, to a designated directory. TOPCALL picks up the attachment and sends it via fax or . See MailOUT Process and Topcall connector on page 15.

12 12 Standard Process and connector Sending s Standard Process and connector This configuration includes a standard Process (PageOUT Process, StreamOUT Process, etc.) and an connector. Processed output will be sent directly from the Process, via the connector, to a mail server. The address information, subject, etc. is set-up in the connector configuration. Which connector to use depends on the type of mail server. This is the most effortless method if you want to processed output. connectors You can use the following output connectors for this purpose: MAPI SMTP (MIME) TFS Attaching the processed output to the The processed output will be sent as an attachment. For example, if you select the PDF driver when you configure the connector, the output will be attached as a PDF file. You specify attachment name, whether or not to compress the attachment, etc. in the Runtime settings for the connector. Specifying a mail server You specify which type of mail server to send the output to when you select the connector. For example, select an SMTP (MIME) connector if you want to use an SMTP mail server. editor The address information, subject, etc. is set-up in the Runtime connector configuration. Attaching files on disk to the In the editor you can also add supplementary attachments, such as product sheets, price lists, etc. These attachments must be available as files on disk. Scripting functions for attachments You can use the scripting functions AttachmentBegin and AttachmentEnd to handle attachments. See the Scripting reference.

13 MailOUT Process and connector 13 Sending s MailOUT Process and connector This configuration includes a MailOUT Process, an connector and, optionally, a standard Process. The output from the MailOUT Process is an . To this you can attach files from disk and output from other Processes. The is sent via an connector to a mail server. Which connector to use depends on the type of mail server. This is the most effortless method if you only want to attach files on disk to an , or send plain information in the body. connectors You can use the following output connectors for this purpose: MAPI for MailOUT SMTP (MIME) for MailOUT TFS for MailOUT Specifying a mail server You specify which type of mail server to send the output to when you select the connector. For example, select an SMTP (MIME) for MailOUT connector if you want to use an SMTP mail server. editor The MailOUT tool is the editor. In the editor you specify address information, subject, body, etc. The same editor is used for MAPI, SMTP MIME, and TFS s. This means that all parameters are not applicable to all types. See MailOUT Process reference on page 16. Attaching files on disk to the In the editor you can add attachments to the , for example product sheets, price lists, etc. These attachments must be available as files on disk. Attaching processed output to the You can attach output from standard Processes (PageOUT etc.) to the . 1 In the Runtime configuration window, right-click the MailOUT Process and select Settings. The Runtime Process Settings dialog box opens. 2 On the Attach Process tab, click Add New. The Process Attachment dialog box opens. 3 Enter the Attachment name. 4 From the Select Process drop-down list, select the appropriate Process and click OK. The standard Process must be connected to some kind of output connector. The driver options on that connector determines the format of the attachment. For example, if you select the PDF driver, the output will be attached as a PDF file. If you are using an SMTP mail server you can also specify the content-type for the attached output:

14 14 MailOUT Process and connector Sending s Autoselect the Communication Server determines which content-type to use. The information is retrieved from the driver that generates the attachment file. Predefined select content-type from a predefine list. Custom specify a custom content-type. Scripting functions for attachments You can use the scripting functions AttachmentBegin and AttachmentEnd to handle attachments. See the Scripting reference.

15 MailOUT Process and Topcall connector 15 Sending s MailOUT Process and Topcall connector TOPCALL is a registered trademark of TOPCALL International AG. This configuration includes a MailOUT Process, a PageOUT Process, and a Topcall output connector. The PageOUT output is sent as a PDF or PCL attachment, via the MailOUT Process and the Topcall connector, to a designated directory. TOPCALL picks up the attachment and sends it via fax or . connectors You must use a Topcall connector for this purpose. Specifying output directories TOPCALL and the Communication Server use two directories to exchange information: one directory that contains the attachments, and one directory that contains address information. You specify these directories when you configure the Topcall connector. editor The MailOUT tool is the editor. In the editor you must specify a To and From address. You can use dummy values. Attaching processed output to the The PageOUT Process must be connected to some kind of output connector. The driver options on that connector determines the format of the attachment. For example, if you select the PDF driver, the output will be attached as a PDF file. 1 In the Runtime configuration window, right-click the MailOUT Process and select Settings. The Runtime Process Settings dialog box opens. 2 On the Attach Process tab, click Add New. The Process Attachment dialog box opens. 3 Enter the Attachment name. 4 From the Select Process drop-down list, select the appropriate Process and click OK.

16 16 MailOUT Process reference Sending s MailOUT Process reference MailOUT settings From Display name Reply to To Cc Bcc Subject Request receipt Attachments Standard attribute. Not applicable to MAPI. The From address will be replaced by this name when the is delivered. This functionality must be supported in the client. Not applicable to MAPI and TFS. Used by the client instead of the From address when responding to an . Not applicable to MAPI and TFS. Standard attribute. Standard attribute. Standard attribute. Not applicable to TFS. Standard attribute. Request a read receipt from the recipient. A delivery notification will be received when the recipient reads the provided that this functionality is supported by the servers and clients. Not applicable to TFS. Free attachments (not Process output). Use the Add, Edit buttons. Attachment settings File to attach Attachment name Path to file to attach. Name of attachment.

17 MailOUT Process reference 17 Sending s Attachment settings MIME Type Convert attachment from PCL to PDF Compress attachment Content-type of the attachment. Predefined: Select content-type from a predefine list. Custom: Specify a custom content-type. Not applicable to: MAPI, TFS. Select whether or not to convert PCL attachments to PDF. Select whether or not to compress the attachments.

18 18 MailOUT Process reference Sending s