Mailbox

Nom de la ressource mailbox
URL http://api.alwaysdata.com/v1/mailbox
Description BoƮtes emails
Operations create, read, update, delete, list

Fields

Name Details
id

readonly: YES

integer

Resource ID.

href

readonly: YES

string

Resource location.

domain integer (domain)

Domain

name string

Enter the part of the email address before the @ sign. For instance: john.smith. If you want to create a catch-all address, enter * (star).

password string

Password

antispam_enabled

default value: True

bool

Enable anti-spam

antispam_score

default value: 5

integer

The anti-spam computes a score for each message based on the probability of being a spam. Messages over this score will be stored in the folder below. Unless you know what you are doing, don't change the default value (5).

antispam_folder

default value: Trash

string

Spams will be moved to this folder.

antispam_score_delete

default value: 10

integer

Messages exceeding this score will be directly deleted, without even being stored in the spam folder. Unless you know what you are doing, don't change the default value (10).

antivirus_enabled

default value: True

bool

Enable antivirus

antivirus_folder

default value: Trash

string

Viruses will be moved to this folder.

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

string

List of folders to purge. To indicate multiple folders, separate them by spaces.

redirect_enabled

default value: False

bool

Enable redirect

redirect_to

default value: null

string

Enter addresses where emails will be redirected. Separate each address by a space.

redirect_local_copy

default value: False

bool

If you check that box, all redirected messages will also be copied in that mailbox. Otherwise, messages will not be stored in your account, only redirected.

autoresponder_enabled

default value: False

bool

Enable autoresponder

autoresponder_days

default value: 7

integer

Only one automatic message per address will be sent for the selected period of time (in days).

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

Sieve format script executed at the e-mails reception