Skip to main content

email-settings

Method gets or sets email settings for an account

Parameters

No additional parameters for this request

Possible values

ParamValues
typedefault, custom. Default - use idibu mail server. Custom - define your own mail server settings
nameName, which will be used in From header
hostHost address of your server
portPort address of smtp service, should be numeric
smtp-authyes, no. Yes - if server requires authentification, no otherwise
usernameUser name
passwordPassword
smtp-secureno, tls, ssl
email > typeprofile, custom. Profile - From address will be taken from profile. Custom - will be used static email address for all profiles, custom email address should be provided in email > email
email > emailStatic email address used for type custom

Example of getting settings

Request

https://ws.idibu.com/ws/rest/v1/settings/email?hash=[your_hash]

Response

<?xml version="1.0" encoding="utf8"?>
<idibu generator="idibu" version="1.0">
<response>
<type>custom</type>
<name></name>
<host></host>
<port></port>
<smtp-auth>no</smtp-auth>
<username></username>
<password></password>
<smtp-secure></smtp-secure>
<email>
<type>custom</type>
<email>vitaly@idibu.com</email></email>
</response>
<status>success</status>
</idibu>

Example of setting settings

Request

POST https://ws.idibu.com/ws/rest/v1/settings/email?hash=[your_hash]
<?xml version="1.0"?>
<idibu>
<type>custom</type>
<email>
<type>custom</type>
<email>vitaly@idibu.com</email>
</email>
</idibu>

Response

<?xml version="1.0" encoding="utf8"?>
<idibu generator="idibu" version="1.0">
<response>
<message>Settings updated</message>
</response>
<status>success</status>
</idibu>