Class FaxHistory

Add a note (free text) to the fax

Arguments: fax_uuid -- uuid of the fax note -- text to add to the fax

Returns the number of faxes from users history with a specific state.

Arguments: type -- Possible values: history, inbox, inbox_unread, outbox or unpaid

Moves faxes to the trash.

If siblings_too is true will perform for the given faxes and all other recipients from the same fax jobs. siblings_too will only be evaluated for uuids beloging to an outgoing fax and will be ignored for incoming faxes uuids

Removes faxes from trash

This method is similar to EmptyTrash() which deletes all the faxes from trash

Arguments: uuids -- ids of faxes to be removed vom trash

Returns the details of a fax in progress.

Arguments: uuid -- UUID of the fax to show

Returns a fax groups details.

Arguments: uuid -- Uuid of one of the faxes in the group.

Returns the details of a fax in the inbox.

Arguments: uuid -- UUID of the fax to show mark_read -- If true marks the fax as read (default: false).

Get a .pdf-Version of a transmission report.

On the transmission report basic data of the fax and a preview of the first page is shown. Should always be called with API_MODE_PASSTHRU, as the result is the pdf as binary data

Arguments: uuid -- @attribute[RequestParam('uuid','string')]

Lists all faxes in a group (that are sent as on job).

Arguments: uuid -- Uuid of one of the faxes in the group.

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

Lists all notes for the given fax in reverse order (latest first)

Arguments: fax_uuid -- uuid of the fax to list notes for

List all faxes in the inbox of the current user.

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

Faxes in the outbox that are currently in the sending process

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

Returns a list of latest faxes for the user.

Does not contain deleted and delayed faxes (See ListTrash for deleted faxes).

Keyword arguments: count -- The count of items to return. Valid values are between 1 and 100 data_to_list -- Any message types you want this function to return. Allowed models are 'sent', 'inbox', 'outbox'. Leave empty to get faxes of any type.

List all sent faxes (successful or not)

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

List all faxes in trash

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

Lists all unpaid faxes that are waiting for a payment.

When this user makes a transaction to add credit, these faxes will be sent automatically if they are younger that 2 hours.

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

Restores a fax from the trash.

Arguments: uuid -- uuid of fax to restore

Sets a fax' read date to current time.

Fax needs to be a fax in the inbox.

Arguments: uuid -- uuid of fax to set as read

Sets the read date of all the faxes to the current time

Arguments: uuids -- array of uuids for faxes to set as read

Sets the spamscore for all the faxes depending on the flag "is_spam" Takes an array of faxes UUIDs and marks them a spam if the second argument (is_spam) is true. Removes the Spam state if is_spam is false. If 15 or more faxes of the same sender has been marked as spam, all incoming faxes are directly moved to the trash. This is user specific, so if user A reports 15 faxes of one sender, then only all incoming faxes from the sender to him are directly sent to the trash.