Interpage OutFax Protocol and Commands
[Back to Main] |
[Fax Svcs Menu] |
[OutFax Service] |
[Unlimited OutFax] |
[Secure/TLS OutFax] |
[Fax Signup] |
[OutFax Free Trial]
|
[Contact Interpage]
The command list and examples below are used in conjuction with the OutFax service.
I N T E R P A G E Network Services Inc. http://www.interpage.net
===========================================================================
[] Fax Send and Configuration Commands for the OutFax(sm) Service, 08/2005
This file describes the various commands and options which can be used to
have Interpage's OutFax(sm) service convert your e-mail messages,
attachments, and URLs (Web pages) into faxes.
Note that the these commands override on a ONE TIME basis any customized
settings your account may have in place. To access and modify your
customized settings, you may connect to our server via:
http://www.interpage.net/webreach/faxindex
...or...
telnet interpage.net
...and select option 5 ("Fax Settings") from the main telnet menu.
----------------
[] Sending a fax via the OutFax service:
In order to send a fax via our OutFax service, all you need to do is send
email from your "home" account to "yourusername-config@interpage.net".
In the Subject line, put:
Subject: fax destination
Notes:
1. Use only the bolded fields, do NOT type "Subject:", as
that is the field you are placing the destination information in
2. Each number must be a 10-digit US/Canada/North American number (no
leading 1), or if outside the North American Numbering Plan (NANP), then
prefixed by 011. See examples, below.
..and that's all there is to it. There must be a space between "fax" and
the destination number, no leading "1", and there can be no spaces within
the destination number. Multiple destinations can be entered into the
subject line as:
Subject: fax dest#1,dest#2,dest#3
Thus, to fax to Chicago, the Subject like should look like:
Subject: fax 3125551212
...while to fax to London, UK, the Subject line should look like:
Subject: fax 011442075551212
(See the "Examples" section, below, for more details and sample commands)
NOTE: In order for our system to accept your fax requests, you must send
FROM the e-mail account indicated on your sign up form. If you would like
to add additional "accepted" addresses, please telnet to "interpage.net",
and select Option 8. Select the option to add alternate email addresses,
and then follow the prompts.
----------------
[] Fax Commands
FAX [options] phone recipient
Options:
-postscript Body is a plaintext postscript file
-postscript2 Body is a postscript file, as text, but search for
"%!PS-Adobe" before starting and "%%EOF" to end
-psatt Attached postscript or Attached PDF file
-uups replaces fax uuencode -postscript and fax -postscript2
Enables customer to send uuencoded (and gzipped, if they
desire) postscript (level 1, 2, or PDF) files for faxing.
PDF rules:
1) PDF must not be encrypted
2) PDF should be v2.1 or v3.0 of Adobe Acrobat compliant
3) PDF should be uuencoded when sent OR be kept in text format
-doc Body may be any of the following:
*MIME/ATTACHED MS Word DOC file
*MIME/ATTACHED MS Word RTF file (NOTE: File type suffix
and content-type MUST say .DOC and not .RTF)
*Uuencoded MS Word DOC file
*GZipped uuencoded MS Word DOC file
*Uuencoded RTF file
*GZipped uuencoded RTF file (content-type MUST say DOC/text)
(MIME/ATTACHMENT detection is automatic)
-doca Forces an ATTACHED file to be decoded as MIME/ATTACHED DOC
-xls File is an attached Microsoft Excel (.XLS) file
-url Use: -url http://www.site.domain; faxes Web page at given URL
-html Body is an HTML file to be interpreted and converted to fax
-htmla Body is an attached HTML file to be decoded and converted
-text Body is a regular text message (default)
-delay H:M:S Delay the sending H hours, M minutes, and S seconds
-pgp Body is ASCII armor PGP encoded
-lowres Send the fax as low resolution (also -lores)
-highres Send the fax as high resolution (also -hires)
-noheaders Strip out the e-mail headers (text only)
-headers Keep all headers (text only)
-someheaders Keep only important headers (text only)
-bold Use a bold font (text only)
-plain Use a non-bold font (text only)
-cover Add a cover page
-nocover Don't add a cover page
-conf Generate a QUEUED confirmation (restricted)
-noconf Do not generate a QUEUED confirmation (restricted)
-layout 1/2/4 Put one, two, or four pages per page (text only)
-columns N Reformat the fax to N columns (text only)
-confsucc A Send a success confirmation to address A (multiple times)
-conffail B Send a fail conf to address B (can be used multiple times)
-queuesucc C Send a successful queue confirmation to C (multiple times)
-queuefail D Send a failed queue confirmation to D (can use multiple times)
-fontsize 6-20 Use a font from 6-20 points (text only)
-font F Use selected font: courier, helvetica, or times (text only)
-code C Mark fax with code C
-stored xxxxxx Send a fax stored in with FaxUp with index # xxxxxx
-from Changes the "From:" field on the cover sheet
Syntax: -from "[text string]"
-re Puts a "Re: [text]" message on the cover sheet; needs a
special cover sheet. Also, X-Re in the headers can be used
to accomplish the same thing; both "-re" and "X-Re" can be
used simultaneously and the content of both will be displayed.
Syntax: -re "[text string]"
-select (word) Used in text faxes to specify only certain portions of
text to be faxed. Use the -select command in the Subject:
or -extword extended command line followed by a variable
(word) of your choice. The section of the text body of a given
email should use the <<begin (word)>> and <<end (word)>>
commands before and after the desired text. For example:
Subject: fax -select test1 2135551212
Hello,
This is a test, and this line and all above it will NOT
be printed.
<<begin test1>>
This line WILL be printed on the destination fax
<<end test1>>
This text will NOT be printed on the remote fax, nor will
anything which follows.
Good bye!
...will result in a fax to (213) 555-1212 which says ONLY
"This line WILL be printed on the destination fax".
-extword (word) Used to embed commands which would normally be placed in the
Subject: line in the body of the message. This is
generally useful if you have limitations on the size of your
Subject: line or need to include a lot of information. The
commands between the "extended begin" and "extended end",
inclusively, will not be faxed. The "extended begin ..."
command MUST be the first line of text in your message. (It
may work if it is not, however, this feature in unsupported).
The Subject: line of your e-mail MUST contain "fax
-extword (word)", where (word) is any string of your
choosing. Do NOT use parenthesis around your keyword. The
remaining commands are then placed in the body, as per below:
[extended begin (word)] - this indicates that all text
which follows until the "end"
command (below) is to be
interpreted as a set of Subject:
line commands. (word) is the
keyword, without the parenthesis,
which you used in the Subject: line
[extended end (word)] - this indicates that the commands
are done.
Example:
Subject: fax -extword abcd
(this is what would be placed in the Subject of your e-mail
to your Interpage account; the remainder would go in the
body, as per below:)
[extended begin abcd]
-code 123456-6561 -font times -fontsize 10
-nocover -confsucc xyz@interpage.net -conffail
zyx@interpage.net 2135551212,2155551212,011618111222
[extended end abcd]
save Send a fax to your WWW storage area for viewing from the WWW
(as in "Subject: fax save", where "save" replaces a tel.#)
list replace: Used to upload lists or multiple recipients to a list.
Subject: list replace [name-of-list] fax
...will create a list named with [name-of-list] for faxing.
Lists should be two columns, separated by at least one space.
The recipient phone number is placed in the first column, and
Station ID info appears in the second. Thus e-mail with:
Subject: list replace groupa fax
2135551212 John Smith
6175551212 Jane Smith
...will result in a list of two entries, called "groupa".
(List save and availability is based upon your Rateplan
Tier; please inquire for details.)
NOTE: List names should be letters only! Lists with
invalid numbers, such as "4150001111" or numbers to areas
not available to a given current rateplan (such as
International calls, for example) will not be saved.
---------------------------------------------------------------------------
This handles special G3 fax sending...
Format of the subject line:
G3 [num_pages] [hires_flag] [phone_number] [code] [station_id]
Format of the body:
uuencoded gzipped file of page 1
blank line
uuencoded gzipped file of page 2
blank line
...
The files should be standard group 3 files. If the filename ends in
.gz it will be assumed to be gzipped, in which case it will be ungzipped
prior to use. The filename is irrelevant, only if it ends in .gz or
not.
hires_flag is 1 or high resolution or 0 for low resolution.
----------------------------------------------------------------------
Billing formats:
1. Regular (Col. Delimited)
2. Comma Delimited, with per-user/code summary at end
----------------------------------------------------------------------
Examples:
#1.
To: joe-config@interpage.net
Subject: fax -cover -hires -bold 3125551212 John, extension 3322
....will result in Interpage ignoring whatever default "cover",
"resolution" and "bold" settings Joe has in his "Faxing Style"
settings, and send a fax to (312) 555-1212, with the words "To: John,
extension 3322" on the cover sheet. The fax will be sent in hires mode,
and all text will appear in bold.
Additionally and optionally, the textual content AFTER the destination
phone number(s) can be used for force a change to the sent fax Station ID.
Thus, in the above example, the sent Station ID will be set to:
John, extension 3322
...and should appear on the top of the received fax page and in local fax
logs on the received fax machine as "John, extension 3322".
(NOTE: The ability to change Station ID is not available on all accounts
and must be activated on a given account before the feature may be used;
please contact Interpage for details.)
#2.
To: joe-config@interpage.net
Subject: fax -nocover -plain 8185551212 John, at the water cooler
....will result in a fax to (818) 555-1212, in plain text. The "To:" line
"John, at the water cooler" will NOT be sent, as the "-nocover" override
is present, and thus no cover sheet will be generated. All other settings
will be subject to Joe's defaults.
#3.
To: joe-config@interpage.net
Subject: fax -postscript 2135551212 John
....will result in a fax to (213) 555-1212 as a true reproduction of the
PostScript file which is added to the body of the letter as TEXT, not as
an attachment.
You may also use commas (,) between destination phone numbers to specify
multiple recipients:
#4.
To: joe-config@interpage.net
Subject: fax 2135551212,2125551212,9045551212
....will send the same fax to all the above destination numbers.
You may also specify a Group List, or individual telephone numbers AND
a group list(s):
#5.
To: joe-config@interpage.net
Subject: fax group1
....will send a fax to everyone listed on "Group1".
#6.
To: joe-config@interpage.net
Subject: fax group1,joegroup,group2
....will send a fax to everyone listed on "Group1", "joegroup", and "Group2".
#7.
To: joe-config@interpage.net
Subject: fax group1,2125551212,group2
...will send a fax to everyone listed on "Group1", to telephone number
(212) 555-1212, and to everyone listed on "Group2".
NOTE: To create and set groups, telnet to interpage.net, select Option
8, select "Edit/Create Fax Group Lists", and follow the prompts. To
upload group lists, please contact Interpage Support for assistance.
For additional information and/or help, please call +1 (650) 331-3900 or
visit http://www.interpage.net