Specification  
Previous  Top  Next

efax  

OSMOSiS eFax Specification  

The 'Inbox' directory contains all of the files to send emails, faxes and SMS.  
 
To send a email, fax or SMS message via eFax, you must send two files to the Inbox, one contains the actual text to be sent (xxx.txt file) and the other as a properties file (xxx_prop).  
 
Properties file  
 
The properties file contains what is to be sent and to whom. The format of this file must contain the following:  
 
Send an SMS:  
 
SMS
This must be 'SMS'.
Mobile number
This is the number of the person to send to.
Message
The text message to be sent.
 
 
Send an Email:  
 
Company Name
Send the company name as all history of emails sent are stored by 'company name'.
Email address
Must be a valid email address, you can also send multiple items using ';' as the delimiter.
Subject
This will be incorporated in the email to be sent.
Template code
If there's a template for the text file to be placed upon, send the code here.
 
 
Send a Fax:  
 
Company Name
Send the company name as all history of Fax sent are stored by 'company name'.
Fax number
This is the fax number of the person to send to.
Subject
The subject that will be displayed on the header of the fax (if it's in the header string).
Template code
If there's a template for the text file to be placed upon, send the code here.
 
 
Text file  
 
The text file contains the text to be printed. If there is a Template code within the properties file, the text sent will be placed onto the top of the picture.  
 
To seperate the document into seperate pages, you must place ' <new page' or a single '.' in with the text. The system, when it reads the file in generates multiple pages out of one text file. If a template is used in the _prop file, each page will be printed on top of the blank template and sent as page 1, 2, 3 etc.