> For the complete documentation index, see [llms.txt](https://apidocs.zerionsoftware.com/doc/iformbuilder-v80/llms.txt)

# Retrieve Email Settings

> GET /email_settings
> 
> Returns the SMTP server and the subject and footers that this server's email alerts use. The SMTP password is never returned: `password_set` only says whether a non-empty one is stored.
> 
> `custom` is `true` when the server has its own SMTP settings. When it is `false`, `host`, `from_address` and `username` are `null` and alerts go out through the server default. A subject or footer that was never set reads as the default in effect.
> 
> ### Authorization
> 
> Internal API clients only. On a ZWS-integrated server, COMPANY and SERVER users are allowed; on any other server, SERVER users only.



## Servers
- https://api.iformbuilder.com/exzact/api/v80/[servername]: https://api.iformbuilder.com/exzact/api/v80/[servername]


## Authentication methods
- Oauth2


## Parameters
### Headers

- **Authorization** (string)
  e.g. Bearer {access_token}





## Responses
### 200
OK

#### Body: application/json (object)
- **custom** (boolean)
  `true` when the server has its own SMTP settings; `false` when alerts use the server default

- **host** (string | null)
  the SMTP host; `null` when not set

- **from_address** (string | null)
  the sender address of alert email; `null` when not set

- **username** (string | null)
  the SMTP user name; `null` when not set

- **password_set** (boolean)
  `true` when a non-empty SMTP password is stored

- **subject** (string)
  the subject of an alert whose form sets none

- **footer** (string)
  the first footer of alert email

- **footer2** (string)
  the second footer of alert email


### 401
Unauthorized - missing or invalid bearer token.

### 403
Forbidden - the client is not internal, or the user's role is not allowed (see Authorization).


[Powered by Bump.sh](https://bump.sh)
