Description
A function that allows for the sending of faxes from OpenInsight.
Syntax
jobID = RTI_SendFax(ReceiverFax, ReceiverName, Subject, Note, CoverPage, HostFile, ItemName, SenderName, SenderEmail, SenderFax, FaxServer, SendFax_Status)
Parameters
The function has the following parameters:
| Parameter | Description |
|---|---|
| ReceiverFax | The recipients fax number. For multiple recipients, this is an @VM delimited list. Notes: It’s best if this is in "standard" format: +<countrycode> (<areacode>) <number> (as in: +1 (480) 497-5847) By doing so, the fax server can apply the proper "dialing rules". Note that this format is very strict – it MUST contain +, the country code, the parenthesis, etc. If you don't have "use dialing rules" enabled on your fax modem connection, though, do NOT use the standard format. |
| ReceiverName | <Optional> The recipient name. For multiple recipients, this is an @VM delimited list corresponding to the ReceiverFax values. |
| Subject | <Optional> The subject of the fax. |
| Note | <Optional> The cover page text. If there are multiple fields (@VM delimited) they are converted into cr/lf. |
| CoverPage | <Optional> The full path to the specific cover page you want to use. Leave blank if you want to use the default "generic" cover page, which includes the subject, note, etc. |
| HostFile | <Optional> The OpenInsight table from which you want to get the attachment. |
| ItemName | The record name of the HostFile record you want to use as the attachment. or If no HostFile is specified, but ItemName is specified, then ItemName is the full path to an operating system file you want to use as the attachment. |
| SenderName, SenderEmail, SenderFax and FaxServer | <Optional> When specified and the "generic" cover page is used, these parameters will override the default information set in your fax software for the ‘sender’ |
| SendFax_Status | Set by the function. If the jobId is null, check the SendFax_Status for additional details as to why the fax failed. |
Returns
The fax job number. if the job is queued successfully to the fax software then the return value is non-null.
Example
Declare Function RTI_SendFax ReceiverFax = "+(555)555-5555" ReceiverName = "Warren Johnson" Subject = "A Fax from OpenInsight's RTI_SendFax" Note = "This is a test fax" : @vm : "from the" : @vm : "RTI_Sendfax command" CoverPage = "" HostFile = "" ItemName = "c:\revdotnet.txt" SenderName = "" SenderEmail = "sean@revelation.com" SenderFax = "201 722-9815" FaxServer = "" SendFax_Status = "" JobID = RTI_SendFax(ReceiverFax, ReceiverName, Subject, Note, CoverPage, | HostFile, ItemName, SenderName, SenderEmail, SenderFax, FaxServer, | SendFax_Status) If jobId Else * Error Handling end
