Version 9.

0
InternetLink Module Guide
 RightFax 9.0 InternetLink Module Guide ii

Edition
Information in this document applies to version 9.0 of the InternetLink Module Guide.

Copyright Notice
©2004 Captaris. All rights reserved. No part of this publication may be reproduced, transmitted, transcribed, stored in a retrieval system, or translated into any language in any form by any means without the written permission
of Captaris. Captaris products Interchange, RightFax and Teamplate are trademarks of Captaris. All other company, brand and product names are the property and/or trademarks of their respective companies.
Captaris
10885 NE 4th Street
Suite 400
Bellevue, WA 98004
(425) 455-6000
[Link]
Information in this document is subject to change without notice. Companies, names, and data used in examples herein are fictitious unless otherwise noted.

JetPCL PCL Emulation Software copyright 1990-2003 Tech Know Systems, Ltd. Company, All rights reserved. Portions copyright ©1999 Ligature. All rights reserved. Portions copyright ©1988, 1996 Aladdin Enterprises. All
rights reserved. Portions copyright ©1993 Soft Horizons. All rights reserved. Outside In® Viewer Technology copyright ©1992-2003 Inso Corporation. All rights reserved. Copyright © TMS, Inc. 1994-2002. All rights reserved.
Portions copyright ©2001 artofcode LLC. Portions Copyright ©1996, 2001 Artifex Software Inc. Portions Copyright ©1998 Soft Horizons. All Rights Reserved. Adobe, Acrobat, and the Acrobat logo are trademarks of Adobe
Systems Incorporated. Includes Adobe® PDF Library technology. All rights reserved. PostScript is a trademark of Adobe Systems Incorporated. This software is based in part on the work of the Independent JPEG Group.

For More Information

Captaris is a leading provider of Business Information Delivery solutions that integrate, process and automate the flow of messages, data and documents. Captaris produces a suite of proven products and services, in partnership
with leading enterprise technology companies, delivered through a global distribution network. Captaris has installed over 80,000 systems in 44 countries, with 93 of the Fortune 100 using the company's award-winning products
and services to reduce costs and increase the performance of critical business information investments. For more information please contact us at [Link] or call +1.520.320.7000.
Contents

Chapter 1 Creating FCL Documents

with InternetLink Commands.............................................. 7
System Requirements......................................................................7
Activating the InternetLink Module................................................7
Understanding the InternetLink FCL Commands......................8
Attaching Native Files to InternetLink Documents ....................9
Sending Documents as E-mail if Faxes Fail ............................. 11
Receiving Notification When a Fax Fails
and Is Sent as an E-mail............................................................ 11

Chapter 2 FCL Commands..................................................................... 13

Standard FCL Commands with InternetLink Options ........... 13
InternetLink FCL Commands ...................................................... 14

Index ..................................................................................................................... 19

iii
RightFax 9.0 InternetLink Module Guide iv
Chapter 1
Creating FCL Documents with InternetLink Commands

The RightFax InternetLink Module is a component of the RightFax Activating the InternetLink Module
Enterprise Integration Module. The InternetLink Module enables the
Integration Module to build documents in Multipurpose Internet The files required by the InternetLink Module are installed on all
Mail Extensions (MIME) or text format and send them via Simple RightFax servers during the server installation. However, the
Mail Transfer Protocol (SMTP) through the Internet. InternetLink Module must be licensed and activated before its
functionality will be enabled.
You can use the InternetLink Module to send documents in native
mode or filter mode. For information on these two modes, see the To activate the InternetLink Module, you must have licensed a
RightFax Integration Module Guide. RightFax server type that includes this connector, or purchased and
licensed this connector separately. For information on activating
new components on the RightFax server, refer to the RightFax
Installation Guide.
System Requirements
Before you begin sending documents with the InternetLink Module,
The InternetLink Module requires the following: verify the name of your e-mail server.

RightFax Enterprise Server and Integration Module already
installed. To verify the name of your e-mail server

Network connection to the Internet.
1. On the RightFax server, select Start > Programs > Enterprise

SMTP gateway on the network. Fax Manager. The Enterprise Fax Manager window opens.

TCP/IP connection from the RightFax Integration Module to the
2. Select the RightFax server in the list of servers in the left pane of
network
the window. A list of services appears in the lower-right pane.
3. In the Service Name list, double-click RightFax Server
Module. The Server Configuration dialog box opens.
4. Click the eTransport tab.

7
 RightFax 9.0 InternetLink Module Guide 8

5. Verify that the fully qualified domain name of your SMTP server Table 1a Required FCL Commands (Continued)
appears in the SMTP Hostname box. If the name of your server Command Description
is not correct, enter the correct name.
{{to}} Recipient’s e-mail address.
To create and send documents with the InternetLink Module, use
the InternetLink FCL commands. {{type email}} {{type email}} sends a document as the editable
or body of an e-mail message.
{{type mime}} {{type mime}} sends a document as an attachment
Understanding the InternetLink FCL Commands to an empty e-mail message.

Documents sent via the InternetLink Module require six FCL The commands {{begin}} and {{type}} can be replaced with a
commands. Without all of these commands, the document will not “shortcut” command, {{begin mime}} or {{begin email}}.
be sent. The required commands are listed in the following table.

Table 1a Required FCL Commands

Choosing document types
The document type determines the type of document that the
Command Description
recipient receives via e-mail. The type of document is specified with
{{begin}} Indicates the beginning of a document. the {{type}} command.
The Integration Module will process all the data
{{type email}} converts the document to the editable body text of
that appears between a {{begin}} and {{end}} an e-mail message. This is plain text; it has no formatting.
command as a discreet document. Data that does
not appear between the {{begin}} and {{end}}

{{type mime}} converts the document to an un-editable,
commands is ignored. MIME-encoded graphic attachment to an empty e-mail message.
This retains all formatting and graphics. Sending documents in
This command must appear as the first command
MIME format is best when the document must not be editable or
in each InternetLink document.
when it must be an exact replica of a pre-printed, hardcopy form.
{{end}} Indicates the end of a document.
The Integration Module will process all the data Choosing image types
that appears between a {{begin}} and {{end}}
The image type refers to the type of graphic file that is created
command as a discreet document. Data that does
when you use the {{type mime}} command, PDF, TIF, or PCX. To
not appear between the {{begin}} and {{end}}
specify an image type, use the {{imagetype}} command (see
commands is ignored.
“IMAGETYPE” on page 17).
This command must appear as the last command in
each InternetLink document. PDF is the most universal image type, and Captaris recommends
that you use it when you are transmitting in MIME format. The
{{from}} Sender’s e-mail address.
default graphic format for {{type mime}} documents is PDF. (The
{{subject}} Subject line of the e-mail message. examples in this guide use the {{imagetype}} command in all
instances to avoid confusion, even though {{imagetype pdf}} is
redundant for a {{type mime}} document.)
 Using include files with the InternetLink Module If you use the {{attach}} command without the native option, then
When you activate the InternetLink Module, an empty include file the attached document and the host document are merged into
called [Link] is created in the RightFax\Production\Include one graphic file that is attached to an empty e-mail message. You
folder. You can insert plain text (but not FCL, formatted text, or determine the image type of this graphic file with the {{imagetype}}
graphics) in [Link], and this text will become the body of a command “Choosing image types” on page 8.
{{type mime}} document. Use the native option to the {{attach}} command when the file must
[Link] is linked by default to all InternetLink documents. be editable or when fax format cannot adequately represent the
Because it is empty, [Link] has no function unless you add content of a file. For example, fax format cannot adequately
information to it. If you add information to [Link], then that represent the content of an audio file.
information will appear in the body of each {{type mime}} message You can attach multiple documents by inserting multiple {{attach}}
that is sent using the InternetLink Module. commands. The {{attach}} command cannot be used with the
For information on other types of include files, see the RightFax {{type email}} command.
Integration Module Guide.
Example FCL for InternetLink documents that have
attachments
Attaching Native Files to InternetLink Documents The following examples illustrate FCL documents with attachments
created for the InternetLink Module. In each example, the FCL (on
Without the InternetLink Module, the Integration Module converts
the left) yields different final results (on the right).
all attachments to fax format (a TIF image) before sending. The
InternetLink Module gives you the option to attach documents in In the following example, the host data (“Here are last week’s
native file format. For example, a Microsoft Word document can be programs.”) is converted to PDF and is saved as the attachment
sent as a Word document. called [Link] (the file name is generated automatically by the
system) through the use of the {{type mime}} and {{imagetype pdf}}
To attach a file, use the {{attach}} or {{beginnative}} commands. For
commands. The attached document ([Link]) is also attached
a description of both commands, see Chapter 2, “FCL
in its native format (a Microsoft Excel file) through the use of the
Commands”.
{{attach}} command with the native option.
In the following example, [Link] will be attached in its native
The example includes text that was added to [Link], “This
format (as a Microsoft Excel document) to the host document.
message comes to you from Oswego Corporation”. For more
Example {{attach c:\\IST Files\[Link] native}} information, “Using include files with the InternetLink Module” on
If you create a {{type mime}} document that contains the {{attach}} page 9.
command with the native option, then the attached document
becomes the second attachment to an empty e-mail message.

Chapter 1 Creating FCL Documents with InternetLink Commands 9

 RightFax 9.0 InternetLink Module Guide 10

Figure 1.1 Attaching a File in its Native Format In the following example, the host data (“Here are last week’s
{{begin}} programs.”) is converted to PDF and becomes page 1 of the
{{type mime}} attachment called [Link] through the use of the {{type mime}}
{{imagetype pdf}} and {{imagetype pdf}} commands.
Here are last week’s programs.
{{attach “c:\\IST Files\[Link]” native}} Because the native option of the {{attach}} command was not
{{to css@[Link]}} used, [Link] is converted to PDF and becomes page 2 of
{{subject Weekly programs}} [Link].
{{from las@[Link]}}{{end}}
Figure 1.2 Attaching a File Converted to PDF Format
{{begin}}
{{type mime}}
{{imagetype pdf}}
Here are last week’s programs.
{{attach “c:\\IST Files\[Link]”}}
{{to css@[Link]}}
{{subject Weekly programs}}
{{from las@[Link]}}
{{end}}
Sending Documents as E-mail if Faxes Fail Receiving Notification When a Fax Fails and Is
With the InternetLink Module, you can an e-mail documents if fax Sent as an E-mail
numbers fail. To do this, use the {{onerror}} command. To create a notification that a fax has failed and has been sent as an
The {{onerror}} usage options relevant to the InternetLink Module e-mail, include the ^type^ keyword in the notification template.
are: Refer to the chapters on notification messages in the RightFax
Integration Module Guide.
{{onerror {email|mime e-mail address}}}
Unlike the {{type}} command, the e-mail and mime options for the
{{onerror}} command do the same thing. With either option, the



document is sent as a graphic image attached to an empty e-mail
message. With both options, you must use the {{imagetype}}
command to specify the type of graphic image to create.
In the following example, if the document fails to send as a fax, then
it will be sent as a PDF file attached to an empty e-mail message to
css@[Link].
{{begin}}
{{fax 503-555-4489}}
{{onerror email css@[Link]}}
{{imagetype pdf}}
Body of the document to be sent.
{{end}}
When a fax fails and is sent as an e-mail, all e-mail addressing
options (such as {{to}} and {{cc}}) in the original document are
replaced with the e-mail address specified in the {{onerror}}
command. The content of the {{contact}} command is replaced
with “To whom it may concern.” All other fields, such as {{subject}}
or {{from}}, are retained as they were in the original document.

Chapter 1 Creating FCL Documents with InternetLink Commands 11

RightFax 9.0 InternetLink Module Guide 12
Chapter 2
FCL Commands

Standard FCL Commands with InternetLink ONSUCCESS

Options The {{onsuccess}} command specifies an action for the document
in the event that it is successfully transmitted. For example, a copy
The following standard FCL commands have options that can be of the document can be faxed or e-mailed to alternate recipients,
used with the InternetLink Module. The commands are described in such as the original sender of the document.
detail in the RightFax Integration Module Guide.
TYPE
ATTACH
The {{type}} command establishes the type of document that
The {{attach}} command ends the current page (unless it is blank) should sent.
and attaches one or more files, optionally deleting them after they
have been added to the current document.
The {{type email}} command specifies that the document will be
sent as the editable body text of an e-mail message.
This command can specify that an attached file be sent in its native

The {{type mime}} command specifies that the document will be
format, such as Word or Excel). Include the “native” option in the
sent as an un-editable, MIME-encoded graphic attachment to an
command, as illustrated in the following example.
empty e-mail message.
The {{attach}} command cannot be used with the {{type email}}
If you choose {{type mime}}, then you must also use the
command.
{{imagetype}} command to specify the type of MIME-encoded
Example {{attach “C:\Pricing\[Link]” native}} graphic attachment to create (PCX, TIF, or PDF).
If you use the {{begin mime}} or {{begin email}} commands, do not
ONERROR use the {{type}} command.
The {{onerror}} command specifies an action for the document in
the event that it fails in transmission. For example, the document
can be faxed or e-mailed to alternate recipients.

13
 RightFax 9.0 InternetLink Module Guide 14

InternetLink FCL Commands {{Beginnative}} requires {{endnative}}.

Syntax {{beginnative “filename” [body] [inline]
The following commands are specific to the InternetLink Module.
[mediatype=type] [{base64|quotedprintable}]}}

BEGIN MIME or BEGIN EMAIL Example {{beginnative “[Link]” body mediatype=text/plain}}

Syntax {{begin {mime|email}}} The example creates an attachment called [Link] (whose content
Examples {{begin email}}
is the host data between the {{beginnative}} and {{endnative}}
{{begin mime}} commands in the FCL document). The attachment will be displayed
as editable text in the body of an e-mail message.
The {{begin mime}} and {{begin email}} commands specify the
Configurable attributes of {{beginnative}}:
transmission type. They can replace the {{begin}} and {{type}}
commands.
File name, described on page 14

Body, described on page 15
BEGINNATIVE
Inline, described on page 15
{{Beginnative}} is similar to the {{attach}} command with the native
Mediatype, described on page 16
option. Both commands let you send documents in native format.
Base64 or quotedprintable, described on page 16
The {{beginnative}} command also lets you specify advanced
configuration options that {{attach}} does not support. The key
difference between {{beginnative}} and {{attach}} is that File name
{{beginnative}} requires you to put the content of the This is the suggested file name for the data. You need not supply a
to-be-attached file in the FCL itself, while {{attach}} attaches a file path with this file name because the file data is stored between the
from a different location. {{beginnative}} and {{endnative}} commands. This is the only
required parameter of {{beginnative}}.
The body option of {{beginnative}} inserts the data (which appears
between {{beginnative}} and {{endnative}} commands in your host Example {{beginnative “[Link]” inline
data stream) into the body of an e-mail message. mediatype=application/pdf}}
Here are the files you wanted
The inline option suggests to the recipient e-mail client that the
{{endnative}}
data between {{beginnative}} and {{endnative}} commands be
displayed as an embedded object in the body of the e-mail In this example, RightFax will suggest to the recipient e-mail client
message. If the recipient e-mail client cannot display the host data that “Here are the files you wanted” be displayed as an embedded
in this way, then the data will be sent as an attachment that is object in the body of the e-mail message. If the recipient e-mail
represented by an icon in the body of the e-mail message. The icon client cannot perform this task, then an icon labeled [Link] will
can be opened with the appropriate application. appear in the e-mail message. The content of [Link] will be “Here
are the files you wanted.”
Body To specify alternative formats, use multiple {{beginnative}}
This sends the data that appears between the {{beginnative}} and commands with the body option.
{{endnative}} commands as text in the body of the e-mail message. Example To send a document that contains both HTML and text,
Using the body option, you can specify alternative file formats when you might use the following FCL:
you want to choose the format that the recipient's e-mail software {{begin mime}}
should display. {{to drew@[Link]}}
For example, you can send a text file and an HTML file. Generally, {{from sarah@[Link]}}
the recipient's e-mail software will display the file in the format that {{subject Sample of text and HTML in the body of the
it supports. It will not display both files. message}}
{{beginnative “[Link]” body mediatype=text/plain}}
The sequence of the file formats determines the format that the Drew,
recipient's e-mail software will display. Generally, it will display the Here are the files that you asked for.
first file format that it supports. For example, if you specify text and {{endnative}}
HTML format, a software program that supports both formats will {{beginnative “[Link]” body mediatype=text/html}}
display text first. <HTML><HEAD><TITLE></TITLE><META
content=”text/html; charset=iso-8859-1”
http-equiv=Content-Type></HEAD>
<BODY><HR><STRONG>Drew,</STRONG><BR>
Here are the file that you asked for.<HR>
</BODY></HTML>
{{endnative}}
{{end}}

Inline
This suggests to the recipient e-mail client that the data between
{{beginnative}} and {{endnative}} commands be displayed as an
embedded object in the body of the e-mail message. If the recipient
e-mail client cannot display the host data in this way, then the data
will be sent as an attachment that is represented by an icon in the
body of the e-mail message. The icon can be opened with the
appropriate application.

Chapter 2 FCL Commands 15

 RightFax 9.0 InternetLink Module Guide 16

Mediatype Base64 or Quotedprintable

Specifies the nature of the data between {{beginnative}} and The data between {{beginnative}} and {{endnative}} commands will
{{endnative}} commands. The content type (which is required if you be encoded using the specified scheme. This does not necessarily
use the mediatype option) is represented by a top-level mediatype, require that the attachment be encoded using this scheme in the
a slash, and a subtype. e-mail that is sent to the recipient. If these options are not
Example text/plain specified, then the data will not be encoded (8 bit).

The top-level media type identifies a general type of data, and the
CC
subtype identifies a specific format for that type of data. Thus, a
media type of image/tif is enough to tell a recipient e-mail client that Stores the SMTP address for a carbon copy recipient of a
the data is an image, even if the recipient e-mail client cannot document. To store multiple addresses, repeat this command for
interpret the specific image format of .tif. each recipient.

The default mediatype for native documents with the body option Syntax {{cc address}}
is text/plain. Without the body option, the default mediatype is Example {{cc Justin@[Link]}}
application/octet-stream. Other common mediatypes are (but are {{cc Tommy@[Link]}}
not limited to):
The examples send a copy of the e-mail message to both

application/ms-word Justin@[Link] and Tommy@[Link].

application/pdf

audio/mid ENDNATIVE

audio/wav Ends the processing of an attached native document that was

image/gif begun with the {{beginnative}} command.

text/html Syntax {{endnative}}

text/xml Example {{endnative}}

video/mpeg
If you do not supply a media type, or if you supply a media type that FROM
the recipient e-mail client cannot interpret, the document most Stores the return SMTP address of the sender of the document.
likely will not fail because most current e-mail clients can detect the Syntax {{from address}}
media type.
Example {{from Donny@[Link]}}
The example uses Donny@[Link] as the return e-mail address
for the e-mail message.
IMAGETYPE
Selects the graphic format of a {{type mime}} document.
Syntax {{imagetype {pdf|group3|group4|pcx}}}
Example {{imagetype pdf}}
The example identifies PDF as the graphic format for a {{type
mime}} document.

SUBJECT
Stores the subject of an SMTP document. The subject appears in
the subject field of the e-mail message.
Syntax {{subject topic}}
Example {{subject RightFax InternetLink example.}}
The example creates an e-mail message with a subject field that
says, “RightFax InternetLink example.”

TO
Stores the SMTP address for the recipient of an SMTP document.
Syntax {{to address}}
Example {{to John@[Link]}}
The example sends the e-mail message to
John@[Link].

Chapter 2 FCL Commands 17

RightFax 9.0 InternetLink Module Guide 18
Index

A email server name 7 O

ENDNATIVE command 16
activate InternetLink Module 7 ONERROR command 11, 13
ATTACH command 9, 13 ONSUCCESS command 13
attachments F
examples 9 failed fax 11 P
in native file format 9, 13 FCL, required in InternetLink documents 8
PCX image type 8
FROM command 16
PDF image type 8
B
base 64 16 H Q
BEGIN EMAIL command 14 host name 7
quotedprintable 16
BEGIN MIME command 14
BEGINNATIVE command 9, 14
I R
image type 8
C IMAGETYPE command 8, 17
requirements, system 7
CC command 16 include files 9
create InternetLink documents 8 inline 15 S
send documents as email if faxes fail 11
D M SMTP host name 7
SUBJECT command 17
document types, choosing 8 mediatype 16
system requirements 7
documents, FCL requirements for 8 message body 8
[Link] 9
E T
N TIF image type 8
email messages
TO command 17
document content for 8 native files, attaching to documents 9, 13
TYPE command 13
send notification when a fax fails 11 notification messages 11

19
RightFax 9.0 InternetLink Module Guide 20