Saves mail configuration
An entity with data required to connect to the server. OAuth2 authentication method requires browser initiated 'Authorize' action to be completed successfully. OAuth2 configuration id and mail server id should be included in the request.
string
string
string
string
string
boolean
array<string>
string
string
integer
returned if saving was success
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
curl --request POST \
--url 'http://{baseurl}/rest/rest/admin/1.0/mail/configuration' \
--header 'Content-Type: application/json' \
--data '{
"addressToTest": "<string>",
"from": "<string>",
"host": "<string>",
"id": "<string>",
"jndiLocation": "<string>",
"jndiMailActive": true,
"notificationEmails": [
"<string>"
],
"oauth2ConfigurationId": "<string>",
"password": "<string>",
"port": 2154,
"prefix": "<string>",
"startTLS": "<string>",
"timeout": 2154,
"useSSL": "<string>",
"username": "<string>"
}'Tests connection to the specified SMTP server
An entity with data required to connect to the server. OAuth2 authentication method requires browser initiated 'Authorize' action to be completed successfully. OAuth2 configuration id and mail server id should be included in the request.
string
string
string
string
string
boolean
array<string>
string
string
integer
returned if the test was completed
any
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
curl --request POST \
--url 'http://{baseurl}/rest/rest/admin/1.0/mail/configuration/test' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"addressToTest": "<string>",
"from": "<string>",
"host": "<string>",
"id": "<string>",
"jndiLocation": "<string>",
"jndiMailActive": true,
"notificationEmails": [
"<string>"
],
"oauth2ConfigurationId": "<string>",
"password": "<string>",
"port": 2154,
"prefix": "<string>",
"startTLS": "<string>",
"timeout": 2154,
"useSSL": "<string>",
"username": "<string>"
}'1
2
3
4
{
"logs": "Cannot connect to host `host.com`",
"success": false
}Validates fields required in test connection for mail server
An entity with data required to connect to the server. OAuth2 authentication method requires browser initiated 'Authorize' action to be completed successfully. OAuth2 configuration id and mail server id should be included in the request.
string
string
string
string
string
boolean
array<string>
string
string
integer
returned if validation was success
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
curl --request POST \
--url 'http://{baseurl}/rest/rest/admin/1.0/mail/configuration/validate' \
--header 'Content-Type: application/json' \
--data '{
"addressToTest": "<string>",
"from": "<string>",
"host": "<string>",
"id": "<string>",
"jndiLocation": "<string>",
"jndiMailActive": true,
"notificationEmails": [
"<string>"
],
"oauth2ConfigurationId": "<string>",
"password": "<string>",
"port": 2154,
"prefix": "<string>",
"startTLS": "<string>",
"timeout": 2154,
"useSSL": "<string>",
"username": "<string>"
}'Rate this page: