Class FaxJob

Adds a file to the current fax.

Requires the file to be uploaded as POST paramter named 'file' as a standard HTTP upload. This could be either Content-type: multipart/form-data with file content as base64-encoded data or as Content-type: application/octet-stream with just the binary data. See http://www.faqs.org/rfcs/rfc1867.html for documentation on file uploads.

Arguments: filename -- Name of the file. You can also use the same file name for each file (i.e "fax.pdf")

Keyword arguments: origin -- Optional file origin (ex: photo, scan,... - maximum length is 20 characters).

Add a file identified by an online storage identifier.

You'll have to use the OnlineStorageApi to identify a user for an online storage provider first and then get listings of his files. These will contain the file identifiers used by this method.

Arguments: provider -- Identifies the provider used (see OnlineStorageApi) uuid -- Identifies the file to be added (see OnlineStorageApi)

Adds recipients to the current fax. The given recipients will be added to current recipients.

Add a remote file to the fax. url may contain username:password for basic http auth, but this is the only supported authentication method. URL Examples: http://myusername:andpassord

Cancels fax sending for a fax recipient or a whole fax job. If siblings_too is true will cancel all faxes in the job the fax with uuid belongs to.

Clones an already sent fax in the API backend and returns it.

Arguments: uuid -- The uuid of the source fax

Keyword arguments: user_ip -- The IP address of the client (if available). Put your own IP address otherwise. user_agent -- User agent string of the client device. If not available, put something descriptive (like "iPhone OS 2.2")

Creates a new fax in the API backend and returns it.

If a fax job is currently in edit mode in this session, this fax job is returned instead. Note: This is not an error. It provides you with the possibility to continue with the fax.

Keyword arguments: user_ip -- The IP address of the client (if available). Put your own IP address otherwise. user_agent -- User agent string of the client device. If not available, put something descriptive (like "iPhone OS 2.2") origin -- From where was this fax started? i.e. "printer", "desktop", "home", ... For reporting and analysis purposes.

Returns a list of all coverpages the user may use. Result includes the "no cover" if the fax job already contains a file as in that case there's no need to add a cover.

Returns the recipients for the current fax.

Keyword arguments: current_page -- The page which should be shown items_per_page -- How many items are shown per page

Start the fax sending.

Only successful if all necessary data is set to the fax: at least 1 recipient and a cover page or a file uploaded. Will only work if user has enough credit to pay for the fax. You may pass in a datetime when the fax shall be sent. This must be a string formatted in the users chosen culture (so exactly as you would show it to him) and may not be in the past nor be greater than 'now + 14days'.

Send a previously delayed fax now.

Use this method if you want to send a fax right now that was initially delayed (by giving a send_at value into Send).

Put the fax in the unpaid faxes queue.

Only possible if user has NOT enough credit to send this fax directly. You may pass in a datetime when the fax shall be sent. This must be a string formatted in the users chosen culture (so exactly as you would show it to him) and may not be in the past nor be greater than 'now + 14days'.

Send unpaid faxes

Will work until credit reaches zero. Will return two lists: SentFaxes and UnpaidFaxes that contain the faxes that could or not be sent.

Sets the notification options for the current fax.

Notification options that are not in the array will not be changed/resetted. Note: defaults for notification settings will be taken from users account, so potentially not need to call this on every fax.

Keyword arguments: save_defaults -- Save Notification-Settings to user's Profile

Creates recipients for the current fax.

All recipients are replaced with the given ones!

Starts creating the preview for this fax.

Call after fax is ready (GetFaxState returns FAX_READY_TO_SEND)