| Nom de la ressource | mailbox |
| URL | https://api.alwaysdata.com/v1/mailbox |
| Description | Boîtes emails |
| Operations | create, read, update, delete, list |
| Name | Details |
|---|---|
|
id
readonly: YES |
integer
Resource ID. |
|
href
readonly: YES |
string
Resource location. |
| domain |
domain
Nom de domaine de l'adresse. |
| name |
string
Enter the part of the email address before the @ sign. For instance: john.smith. Wildcard * can be used. |
|
password
default value: null |
string
Password |
|
antispam_enabled
default value: True |
bool
Enable anti-spam |
|
antispam_score
default value: 5 |
integer
The anti-spam computes a score to each incoming message based on the probability of being a spam. Messages exceeding this score will be stored in the folder specified below. Unless you know what you are doing, leave the default value (5). |
|
antispam_folder
default value: Spam |
string
Folder in which spam messages will be moved to. |
|
antispam_score_delete
default value: 15 |
integer
Messages exceeding this score will be directly deleted, without being stored in the spam folder. Unless you know what you are doing, leave the default value (15). |
|
purge_enabled
default value: True |
bool
Enable purge |
|
purge_days
default value: 30 |
integer
Messages will be deleted after that period. |
|
purge_folders
default value: Trash Spam |
string
List of folders to purge. Specify multiple folders separated by a space. For the main folder, specify INBOX. For folders that contain a space in their name, enclose them in quotes. |
|
redirect_enabled
default value: False |
bool
Enable redirect |
|
redirect_to
default value: null |
string
Enter the addresses to which emails will be redirected. Separate each address by a space or a line break. If you want to enter a large number of addresses, consider using mailing lists. |
|
redirect_local_copy
default value: False |
bool
By checking this box, all redirected emails will also be copied to this mailbox. Otherwise, emails will not be stored in your account, only redirected. |
|
redirect_srs
default value: True |
bool
By checking this box, all redirected emails will use SRS. This can help ensure the proper delivery of these redirects (avoiding spam classification) but it depends on the hosting providers of the target addresses. |
|
autoresponder_enabled
default value: False |
bool
Enable autoresponder |
|
autoresponder_days
default value: 7 |
integer
Only one automated message per email address will be sent for the specified duration (in days). Enter 0 to send a message every time. |
|
autoresponder_subject
default value: null |
string
Subject |
|
autoresponder_message
default value: null |
string
Message |
|
quota_enabled
default value: False |
bool
Enable quota |
|
quota_storage
default value: null |
integer
Maximum size (in MB) |
|
sieve_enabled
default value: False |
bool
If the Sieve script is enabled, it will be executed after the operations above (antispam, redirect, etc.) |
|
sieve_filter
default value: null |
string
Script executed upon email reception in Sieve format. |
| annotation |
string
L'annotation est facultative et apparaitra dans le listing. |