Revised: 1/17/2007 Page 1 of 6
Vessel API usage Configuration instructions for use with
AmosConnect
Document version: v.3
Based on AmosConnect/Mail Software Version: 5.2 and later.
Introduction
The AmosConnect API function allows you to automatically send files to a vessel and place them in a
predefined folder. In this document the instructions are given to setup an API on the on the
AmosConnect Client software
Process:
Addree
s book API represented in
Forward/Copy
entry address book
setting
MSG
MSG
MSG
E-mail server SM
sending Msg TP AMSOConne Co inte Save to Disk 7
MailBox
mai ct Hub mm rnal API
l
1 2 3 4 6
5 Attachme
nt
Hard Disk
Steps:
1. Mail is send from the world to AmosConnect to mail address [email protected]
2. The Mail with attachments is transported via mail networks to AmosConnect.
3. At AmosConnect the mail is received and the addressee translated to MB-A@PO-Vessel, and put
in the queue for the vessel.
4. During regular communication the messages including this one are transferred to the vessels
AmosConnect Client system.
5. At the vessels AmosConnect system the message for [email protected] is now
received in mailbox-A. The Mailbox is configured to send a Copy of all incoming mail to the API
Page 2 of 6
"Save to disk". For this purpose an address book entry is made where the internal address of
the API is linked to an address ALIAS.
6. At arrival of the new message in the mailbox the system directly copies the mail to the API as
well, which is then triggered.
7. The API is configured to unzip and export all the attachments in the message to the directory
specified, and thus to hard disk of the computer.
Configuration instructions Vessel side:
Pre-requisites:
1. The AMOSMail system is fully operational for standard use with AmosConnect.
2. The AmosConnect hub has a special mail address configured for this goal
3. The mail address on AmosConnect forwards the mail to a mailbox on board of the vessel.
4. The vessel AMOSMail is logged on with Admin rights to configure these settings.
Create Vessel mailbox with the same Mailbox ID as requested in the AmosConnect
registration.
MAILBOX-A would be the mailbox ID in this case.
The Mailbox management can be found in the top menu bar under
{SETUP}>{Mailbox Management}
Page 3 of 6
Create the API.
In the top menu go to {Setup}>{Application Definition} and press the [ADD] button.
Set the:
• API–ID (6 characters like SAVAPI)
• Specify the pc to run the API on
• Give the API a Name
• Set the directory to export the files to
• Check the settings ‘Export Attachments’, ‘Unzip Zipped files’
Create an address book entry
Use the menu option {Tools}>{Address Book} to access the address book. Press [NEW] to create a
new entry.
Page 4 of 6
• Select a directory (e.g. Everyone).
• Select the Application template
• Give the address a Name (Export API)
• Provide the internal Address (SAVAPI)
• Define an Alias(EXPAPI)
The Alias is needed to be able to link the copy/forward feature of the mailbox to the API.
Set the Mail forwarding of the MailBox to the API
The Mailbox management can be found in the top menu bar under
{SETUP}>{Mailbox Management}. Navigate to the /Forward/ tab.
Select the setting ‘COPY TO’ and press the [Address] button. Select from the list the entry with the
name ‘Export API’ and Alias ‘EXPAPI’
Page 5 of 6
Be sure that API processing is activated on the machine in AMOSMail
Go to the menu on the top and navigate to {Remote}>{Other Services} access the /System/ tab.
Check the ‘Process API’s on this computer’ checkmark.
Page 6 of 6
Done
Now every message to the mailbox will be forwarded to the API, which will export any attachments to
the directory specified.
The advantage of the mailbox in the middle is that exports to the API can easily be repeated if
required, and traced onboard.
This automatically creates an archive of these incoming export files, and eliminated the need to resend
the files via shore-ship communications if an export file gets lost because the application using the
exported files gets damaged.
About Stratos
Stratos (www.stratosglobal.com) is a publicly traded company (TSX: SGB) and leading international
telecommunications services provider offering customers operating in remote locations a variety of satellite and
microwave wireless technologies to provide Internet Protocol, data, and voice solutions through a range of newly
emerging and established technologies such as Inmarsat®, Intelsat®, Iridium®, Globalstar®, VSAT, and others.
Stratos serves an array of diverse markets including government, military, oil and gas, maritime, industrial,
aeronautical, media and recreational users anywhere in the world.
For more information please contact Stratos:
Within North America: 1 888 766 1313
International: +1 709 748 4233
Fax: +1 709 748 4305
E-mail:
[email protected]Website: www.stratosglobal.com
