Skip to main content

Retarus API Docs
Retarus Website
Services Status

Main

Retarus API Docs
Retarus Website
Services Status

Main

Cloud Fax Product Sheet

Cloud Fax Description
Product Features Cloud Fax

Enterprise Fax Portal

Getting started with the Enterprise Fax Portal

Retarus Fax Portal Overview
Sign in to the Enterprise Fax Portal
Sign out of the Enterprise Fax Portal
View and configure user preferences
View About Retarus information
About the refresh icon and option

Configuring System Settings

General Settings
User Management
Faxbox configuration

Integrations

Adding an S3 output channel
Updating an S3 output channel
Deleting an S3 output channel

Preferences
Advanced settings
Document Library

Cover page templates

Preparing a cover page template
Creating a cover page template
Managing cover page templates

Managing faxboxes

Create a new faxbox
Update a faxbox
Delete a faxbox

Managing folders

Add folders/subfolders to an existing faxbox
Delete folders
Delete subfolders

Managing fax numbers

Add fax numbers to a faxbox
Update and delete fax numbers

Managing users and permissions

User permissions matrix
Create groups and users
Assign users and groups to an existing faxbox
Update groups and users
Delete groups and users

Managing the address book

Create address book contacts
Update address book contacts
Delete address book contacts

Managing faxes

Preview faxes
Fax in use by another user
Search, sort and filter faxes
Drop faxes in a different faxbox
Move faxes to a different folder
Mark faxes as read/unread
Delete faxes
Restore/Undelete faxes
Forward a fax
Send a fax
View status of sent faxes in the Outbound folder
Send a fax via email
Store faxes via S3
Export faxes to a local computer

Edit faxes

Fax editing tools
Supported fax actions with editing
Merging multiple faxes

FAQs - Enterprise Fax Portal

FAQs - Getting started with the Enterprise Fax Portal
FAQs - Managing faxboxes
FAQs - Handling inbound and outbound faxes

Getting Help

Open the Help documentation
Copy support information
Copy About Retarus information for support

Email-to-Fax

Customer-level settings
Fax rules & distribution lists

User settings

User upload file structure

Cover pages

Creating cover page templates
Configuring cover pages in EAS
Uploading personalization data automatically

DirSync settings for Email-to-Fax
Import file format and components

User Guide for Email-to-Fax

Addressing an Email-to-Fax
Configuring fax transmissions
Reporting in Email-to-Fax
Sending faxes with Email-to-Fax

Fax-to-Email

User Guide for Fax-to-Email
DirSync settings for Fax-to-Email

Fax-for-Applications API

REST API

SOAP API

Method getVersionInfo
Method sendFaxJob
Method getFaxReports
Method getListOfAvailableFaxReports
Method deleteFaxReport
Method deleteFaxReports

Additional Information - REST & SOAP

Headers
Supported document formats
Supported character sets
HTTP status push
Cover page personalization
Configuration in the EAS portal vs. via a job
Using cover pages
Supported number formats for Fax-for-Applications

FTP API

Fax-to-Applications API

Polling API Manual
Fax-to-Webservice: Push API
Fax-to-FTP: Metadata file

Faxolution for Windows

Getting started with Faxolution for Windows
General questions about Faxolution for Windows
FAQs about documents
FAQs about distribution lists
FAQs about ODBC
FAQs about sending faxes
FAQs about reporting
FAQs about settings
FAQs about commands and the Mail merge function
FAQs about the cover sheet function
FAQs about the blocklist function
Windows registry settings

Fax Inbound

Inbound Settings

Customer settings

Profile settings

Exploring profile options
Configuring a Fax-to-Email profile
Configuring a Fax-to-FTP profile
Configuring a Fax-to-Applications profile

Number settings
Telephone numbers for profiles

Retarus Fax-over-IP (FoIP) Connectivity

Reporting in Cloud Fax

Reporting in myEAS

Cloud Fax Dashboard
View fax reports
Configure timezones and date ranges
Export fax reports

Work with reporting views

Basic View
Advanced View
Custom View
Managing reporting views

Outbound Fax In-Flight Monitoring

Reporting in Classic EAS

Fax Inbound Reporting - EAS Classic
Fax Outbound Reporting - EAS Classic

Reporting GraphQL API ↗

Connectors & Add-Ins

ActFax: Setting up ActFax Server to Send Faxes via Retarus Cloud Fax
ActFax: Setting up ActFax Server to Receive Faxes via Retarus Cloud Fax
Epic: Setting up the Retarus Cloud Fax Connector
LRS: Retarus Cloud Fax for MFDs and mobile phones
Microsoft: Configuring the Send connector in Exchange 2013
Microsoft: Receiving faxes in a Teams Channel
Microsoft: Receiving fax status notifications in a Teams channel
Microsoft: Remote Fax Service for Windows
Microsoft: Setting Up the Retarus Fax for Outlook Add-In
Microsoft: User Guide for Retarus Fax for Outlook Add-In
PaperCut: Setting up PaperCut MF™ for Retarus Cloud Fax
SAP: Cloud Fax connector on BTP Integration Suite

SAP: Fax Connector for S/4HANA

Configuring SAP Connector (BC-SMTP)
Configuring SAP Connector (RFC)
User Guide for Sending faxes from SAP Business Workplace S/4HANA onprem
Admin Manual: SAP Business Communication Monitor Set S/4HANA onprem

SAP: Integration Flows with Open Connectors on BTP Integration Suite
Salesforce: Enable Fax API via Mulesoft Anypoint Studio
Salesforce: Receiving faxes in Sales Cloud with automated processing via barcode positioning

Salesforce: Cloud Fax App for Salesforce

Setting Up Retarus Cloud Fax App for Salesforce
Sending Fax Campaigns

Hyland: Integrating Retarus Cloud Fax with OnBase

Synchronization with Azure Functions & Graph API

Capabilities of the sample code in Azure
Prerequisites and setup steps
Configuring a Graph API connection
Setting up a connection to the Azure Resource Group and Retarus

Sync modes

SYNC_MODE = 1: Consider all AD mailboxes for synchronization
SYNC_MODE = 2
SYNC_MODE = 3: Custom code / dynamic group building at runtime

Setting up Visual Studio Code
Graph API dictionary table and definitions

Annex

Supported barcode types
Transmission status codes - Inbound Fax
Transmission status codes - Outbound Fax
Cloud Fax Functionalities
A detailed look into your Cloud Fax invoice

Breadcrumbs

Home
Cloud Fax
Enterprise Fax Portal

On this Page

Managing the address book

Create address book contacts
Update address book contacts
Delete address book contacts

Imprint
Legal Disclaimer
Privacy Policy

Copyright retarus GmbH
Powered by Scroll Sites & Atlassian Confluence