Capabilities of the sample code in Azure

The provided sample code supports multiple business scenarios.

Scenario 1: User with a single fax number

This is the most common use case where a mailbox or user has one fax number. The mailbox/user can send and receive faxes using this number.

This setup is compatible with:

SIP trunk numbers
Retarus-assigned numbers
Ported number blocks transferred to Retarus
Numbers purchased by Retarus on behalf of the customer

Scenario 2: User with an Alphanumeric Sender ID and a Fax Number

In this case, the mailbox or user wants to use an alphanumeric sender ID (e.g., TestCompanyCSID) along with a fax number.

The sample code detects the alphanumeric sender ID and applies it as the CSID, while the fax number is used for receiving faxes.

This configuration is supported for:

SIP trunk numbers
Retarus-assigned numbers
Ported number blocks transferred to Retarus
Numbers purchased by Retarus on behalf of the customer

All entries must be comma-separated.

Scenario 3a: User with a forwarding setup

In this scenario, a mailbox or user has a forwarding configuration. If the system detects a forwarding marker (e.g., RF:) after the first number, the first number is identified as the B-number, while the number following the marker is recognized as the C-number. If the user is enabled for Email-to-Fax, the B-number will be used as the senderID (CSID) since it serves as the intended receiver-facing fax number.

All entries must be comma-separated.

Scenario 3b: User with a forwarding setup and an alphanumeric CSID

This scenario extends the forwarding setup by including an alphanumeric sender ID. If a forwarding marker (e.g., RF:) appears after the first number, the first number is treated as the B-number, and the number following the marker is the C-number.

All entries must be comma-separated.

If the first entry is alphanumeric, it is treated as the sender ID for Email-to-Fax and is not considered for Fax-to-Email.

Scenario 4: Mixed scenarios with multiRecipients=false

In mixed scenarios, an alphanumeric CSID must always be the first entry (before the first comma). After that, a combination of forwarding setups and direct fax numbers can be listed. The order of forwarding numbers and single numbers does not matter. All entries must be comma-separated.

A typical use case could be a mailbox or user connected via their headquarter SIP trunk while also receiving faxes at another company site that is not connected to Retarus via SIP trunk but through forwarding.

If no alphanumeric CSID is specified, the first number will be used as the Email-to-Fax sender ID. This ensures that the fax number displayed to recipients remains familiar and does not change to a new or unknown Retarus forwarding number (C-number).

If multiRecipients=false and the same fax number is assigned to multiple users, only the last synchronized user will receive faxes for that number via Fax-to-Email, while the other mailboxes will not. To allow faxes to be delivered to multiple mailboxes—whether individual user mailboxes or shared mailboxes—multiRecipients=true must be set in the configuration.

Depending on the mode, more details can be found in:

Scenario 5: Mixed scenarios with multiRecipients=true

In mixed scenarios, an alphanumeric CSID must always be the first entry (before the first comma). After that, a combination of forwarding setups and direct fax numbers can be listed. The order of forwarding numbers and single numbers does not matter. All entries must be comma-separated.

A typical use case could be a mailbox or user connected via their headquarter SIP trunk while also receiving faxes at another company site that is not connected to Retarus via SIP trunk but through forwarding.

If no alphanumeric CSID is specified, the first number will be used as the Email-to-Fax sender ID. This ensures that the fax number displayed to recipients remains familiar and does not change to a new or unknown Retarus forwarding number (C-number).

If multiRecipients=false and the same fax number is assigned to multiple users, only the last synchronized user will receive faxes for that number via Fax-to-Email, while the other mailboxes will not. To allow faxes to be delivered to multiple mailboxes—whether individual user mailboxes or shared mailboxes—multiRecipients=true must be set in the configuration.

Depending on the mode, more details can be found in:

Scenario 6: Mailbox/user without a fax number

If a user does not have a fax number but should still be enabled for faxing, set the following parameters:

For mode 1: M2F_sync_just_users_with_faxnumber = false
For mode 2 (in the applicable group): syncM2F_wFN = false

Since the user does not have a fax number, Fax-to-Email synchronization is not possible.

Scenario 7: Fax number based on a telephone number

In some cases, a user's fax number may be derived from their office phone number.

Example

Telephone Number: +49 12345678-1234
Fax Number should be: +49 12345678-5-1234

To configure this, set the following parameters (for both mode 1 and 2):
faxNumberField = “businessPhones”, extension_prefix = "5", extension_length = 4

Scenario 8: Fax number without a country prefix

In some Active Directory setups, the country prefix is not included in the fax number field. To ensure fax numbers are formatted correctly, the following settings can be applied:
add_countrycode = true AND countrycode = "1" (for US numbers)

With these settings:

In mode 1, +1 will be added to every fax number.
In mode 2, +1 will be added to every fax number within the configured group.

In forwarding scenarios, the forwarding number provided by Retarus (C-number) must already include the country code. Only the B-number will be modified accordingly.