FreeMED.Fax

This is the FreeMED fax transmission API, and is used to send faxes using the HylaFax fax system.

Summary
This is the FreeMED fax transmission API, and is used to send faxes using the HylaFax fax system.
Creates a fax object.
Determines whether Mac OS X’s efax client is properly installed on the server.
Determines whether HylaFax’s sendfax client is properly installed on the server.
Retrieve the number to which a fax was sent from its job id number
Transmit a fax.
Get state of job by job ID
Internal method to provide a command-line set of arguments to be passed to the faxing application.

Functions

Fax

function Fax ($attachment,  
$_options =  NULL)

Creates a fax object.

Parameters

$attachmentFile name of PS/PDF/etc file to fax.  This is an absolute filename.  It can also be an array of seperate files to fax.
$_options(optional) Associative array of options to pass to the fax cover page.
  • subject
  • size - defaults to ‘letter’
  • sender
  • recipient
  • comments

eFaxInstalled

function eFaxInstalled ( )

Determines whether Mac OS X’s efax client is properly installed on the server.

Returns

Boolean, whether or not ‘efax’ executable is found.

HylaFaxInstalled

function HylaFaxInstalled ( )

Determines whether HylaFax’s sendfax client is properly installed on the server.

Returns

Boolean, whether or not ‘sendfax’ executable is found.

GetNumberFromId

function GetNumberFromId ($jid)

Retrieve the number to which a fax was sent from its job id number

Parameters

$jidJob id

Returns

Fax number

Send

function Send ($destination_number)

Transmit a fax.

Parameters

$destination_numberNumber to which the fax is to be sent.

Returns

Output of sendfax executable.

State

function State ($jid)

Get state of job by job ID

Parameters

$jidFax job id

Returns

1 = finished, array (-1, string) = error, string = comment

_attachments

function _attachments ( )

Internal method to provide a command-line set of arguments to be passed to the faxing application.

Returns

Command line arguments as string.

function Fax ($attachment,  
$_options =  NULL)
Creates a fax object.
function eFaxInstalled ( )
Determines whether Mac OS X’s efax client is properly installed on the server.
function HylaFaxInstalled ( )
Determines whether HylaFax’s sendfax client is properly installed on the server.
function GetNumberFromId ($jid)
Retrieve the number to which a fax was sent from its job id number
function Send ($destination_number)
Transmit a fax.
function State ($jid)
Get state of job by job ID
function _attachments ( )
Internal method to provide a command-line set of arguments to be passed to the faxing application.