The Emails endpoint allows you to configure the Fax to Email functionality. Fax to Email allows you to send an email and then receive a fax on your Sinch number or send a fax and have it sent to your email address. The service supports sending incoming faxes to multiple email addresses and having many numbers associated with one email address.
You can configure fax to email in two different places:
The following example shows how to configure Fax to Email using the API:
POST https://fax.api.sinch.com/v3/projects/{projectId}/services/{serviceId}/emails
{
"email": "user@domain.com",
"phoneNumbers": [
"+14155552222"
]
}
Now you can use your email client with the above email address to fax.
Make sure the email address you are sending from is added to your account. You can add it in the dashboard under Fax to email or via the API.
Send an email to {PhoneNumberToSendFaxTo}@sinchfax.com with the following:
Field | Description |
---|---|
Subject: | If you have multiple phone numbers associated with the email address, enter the number you want to use. If left blank, the first number that we find will be used. |
Body: | By default, the email body is not used. |
Attachments | Add any attachments you want to fax. If you want to specify the order of pages we recommend that you create one document with all pages in the correct order and attach that document. If you attach multiple documents we will merge them into one document in the order we receive them. |
When you receive a fax, we will send you an email with the following:
Field | Description |
---|---|
From: | The number the fax was sent from, e.g. +15612600684@sinchfax.com |
Subject: | Fax received on {your sinch number the fax was sent to} |
Body: | The body will contain data such as number of pages or other relevant metadata of the fax. |
There will be one PDF attachment with the fax content.
Make sure you allowlist sinchfax.com
and sinch.com
in your spam filter to ensure delivery to your inbox, both on client and server side.
Ensure your mail server is setup correctly and not on spam lists.
List any emails for a number.
{- "emails": [
- "user@example.com"
], - "page": 0,
- "totalPages": 0,
- "pageSize": 0,
- "totalItems": 0
}
{- "emails": [
- {
- "email": "user@domain.com",
- "phoneNumbers": [
- {
- "number": "+15551235656",
- "permissions": "both"
}
], - "projectId": "ae00f005-e392-44dc-b3f5-a657a2684dg3"
}
], - "page": 0,
- "totalPages": 0,
- "pageSize": 0,
- "totalItems": 0
}
Add an email to the specified service to be used for sending and receiving faxes. Default settings for permissions parameter is both
.
{- "email": "user@domain.com",
- "phoneNumbers": [
- {
- "number": "+14155552222",
- "permissions": "both"
}
]
}
{- "email": "user@domain.com",
- "phoneNumbers": [
- {
- "number": "+15551235656",
- "permissions": "both"
}
], - "projectId": "ae00f005-e392-44dc-b3f5-a657a2684dg3"
}
Set the numbers for an email.
required | Array of objects (Number) List of numbers | ||||||||||||
Array
|
{- "phoneNumbers": [
- {
- "number": "+14155552222",
- "permissions": "both"
}
]
}
{- "email": "user@domain.com",
- "phoneNumbers": [
- {
- "number": "+15551235656",
- "permissions": "both"
}
], - "projectId": "ae00f005-e392-44dc-b3f5-a657a2684dg3"
}
Get configured numbers for an email
{- "phoneNumbers": [
- {
- "phoneNumber": "+15551235656",
- "projectId": "ae00f005-e392-44dc-b3f5-a657a2684dg3",
- "serviceId": "01GVRB50KEQFFE1SGMPFRNBG6J"
}
], - "page": 0,
- "totalPages": 0,
- "pageSize": 0,
- "totalItems": 0
}