Class Interfax

Interfax service for sending faxes

Package: blesta\components\delivery\interfax
Copyright: Copyright (c) 2011, Phillips Data, Inc.
License: The Blesta License Agreement
Link: Blesta
Located at components/delivery/interfax/interfax.php

Methods summary

`public`	# `__construct( )` Constructs a new Interfax component Constructs a new Interfax component
`public`	# `setAccount( string $username, string $password )` Sets the username and password for the Interfax account to send faxes from Sets the username and password for the Interfax account to send faxes from Parameters `$username` `string` $username The account username `$password` `string` $password The account password
`public`	# `setNumbers( mixed $fax_numbers )` Sets the fax numbers to use for this fax Sets the fax numbers to use for this fax Parameters `$fax_numbers` `mixed` $fax_numbers An array of fax numbers, or a single fax number
`public`	# `setContacts( mixed $contacts )` Sets the contact names associated with a fax number. Fax numbers and contact names must maintain order. Sets the contact names associated with a fax number. Fax numbers and contact names must maintain order. Parameters `$contacts` `mixed` $contacts An array of contact names, or a single contact name
`public`	# `setFile( array $files )` Sets the file and file type of the file to be faxed Sets the file and file type of the file to be faxed Parameters `$files` `array` $files A numerically-indexed array of files and their types -file The bitstream of the file to send in binary -type The type of file this is (i.e. HTML, DOC, or PDF), (optional, default PDF)
`public array`	# `getFileTypes( )` Retrieves a list of available file types accepted by Interfax Retrieves a list of available file types accepted by Interfax Returns `array` A numerically-indexed array of available file types
`public array`	# `getPageSizes( )` Retrieves a list of available page sizes accepted by Interfax Retrieves a list of available page sizes accepted by Interfax Returns `array` A numerically-indexed array of available page sizes
`public array`	# `getPageOrientations( )` Retrieves a list of available page orientations Retrieves a list of available page orientations Returns `array` A numerically-indexed array of available page orientations
`public`	# `setSubject( string $subject )` Sets the subject of this fax, viewable in the Interfax account under Outpbound Queue Sets the subject of this fax, viewable in the Interfax account under Outpbound Queue Parameters `$subject` `string` $subject The subject name
`public`	# `setResolution( integer $resolution )` Sets the resolution of this fax Sets the resolution of this fax Parameters `$resolution` `integer` $resolution The resolution quality of the fax. 1 for fine, 0 for standard
`public`	# `setCallerId( string $caller_id )` Sets the caller ID Sets the caller ID Parameters `$caller_id` `string` $caller_id The caller ID
`public`	# `setConfirmationEmail( string $email_address )` Sets an email address to send a confirmation to Sets an email address to send a confirmation to Parameters `$email_address` `string` $email An email address
`public`	# `setSendTime( string $time )` Sets the date and time at which Interfax should dispatch the fax. Dates in the past will be sent immediately Sets the date and time at which Interfax should dispatch the fax. Dates in the past will be sent immediately Parameters `$time` `string` $date_time A valid PHP date time stamp
`public`	# `setPageSize( string $page_size )` Sets the page size of documents sent to Interfax. This applies to all files Sets the page size of documents sent to Interfax. This applies to all files Parameters `$page_size` `string` $page_size The page size to set (i.e. A4, Letter, Legal, or B4)
`public`	# `setPageOrientation( string $orientation )` Sets the page orientation of documents sent to Interfax. This applies to all files Sets the page orientation of documents sent to Interfax. This applies to all files Parameters `$orientation` `string` $orientation The page orientation to set (i.e. Landscape or Portrait)
`public`	# `resetAll( )` Resets all settings back to default except for the account username and password Resets all settings back to default except for the account username and password
`private`	# `delimitValues( array $field, string $delimiter = ";" )` Creates a list of values separated by $delimiter Creates a list of values separated by $delimiter Parameters `$field` `array` $field A numerically-indexed array of values to delimit `$delimiter` `string` $delimiter The separator to use as the delimiter between values (optional, default ;)
`public`	# `send( )` Sends a fax to Interfax Sends a fax to Interfax
`private boolean`	# `parseResponse( string $response )` Parses the SOAP response from InterFax, sets any errors that may have been generated Parses the SOAP response from InterFax, sets any errors that may have been generated Parameters `$response` `string` $response The SOAP response from InterFax Returns `boolean` true on success, false on error
`public array`	# `errors( )` Returns all errors set in this object Returns all errors set in this object Returns `array` An array of error info

Magic methods summary

Properties summary

`private static string`	`$url`	# The URL to submit requests to The URL to submit requests to
`private string`	`$username`	# The account user name The account user name
`private string`	`$password`	# The account password The account password
`private array`	`$fax_numbers`	# The fax numbers to send to The fax numbers to send to
`private array`	`$contacts`	# The contact names to send to The contact names to send to
`private array`	`$files`	# An array of bitstream data, file types, and file sizes representing each file to send An array of bitstream data, file types, and file sizes representing each file to send
`private array`	`$available_file_types`	# An array of available file types accepted by Interfax An array of available file types accepted by Interfax
`private array`	`$available_page_sizes`	# An array of available page sizes accepted by Interfax An array of available page sizes accepted by Interfax
`private array`	`$available_page_orientations`	# An array of available page orientations An array of available page orientations
`private string`	`$subject`	# The subject displayed in the Outbound Queue in Interfax The subject displayed in the Outbound Queue in Interfax
`private string`	`$resolution`	# The quality of the resolution: 0 for standard, 1 for fine The quality of the resolution: 0 for standard, 1 for fine
`private string`	`$csid`	# The caller ID that is displayed The caller ID that is displayed
`private string`	`$email_confirmation`	# A single email address to send a confirmation to A single email address to send a confirmation to
`private string`	`$postpone_time`	# The atomic datetime to send the fax. A time in the past sends immediately The atomic datetime to send the fax. A time in the past sends immediately
`private string`	`$page_size`	# The page size of the documents sent The page size of the documents sent
`private string`	`$page_orientation`	# The page orientation of the documents The page orientation of the documents
`private DataStructureArray`	`$ArrayHelper`	# The data structure array helper object The data structure array helper object

Packages

Classes

Class Interfax

Methods summary

Parameters

Parameters

Parameters

Parameters

Returns

Returns

Returns

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Returns

Magic methods summary

Properties summary