Retrieve Email Settings

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://apidocs.zerionsoftware.com/doc/iformbuilder-v80/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "iFormBuilder V80 MCP server": {
    "url": "https://apidocs.zerionsoftware.com/doc/iformbuilder-v80/mcp"
  }
}

Close
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.

Headers

  • Authorization string

    e.g. Bearer {access_token}

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • custom boolean Required

      true when the server has its own SMTP settings; false when alerts use the server default

    • host string | null Required

      the SMTP host; null when not set

    • from_address string | null Required

      the sender address of alert email; null when not set

    • username string | null Required

      the SMTP user name; null when not set

    • password_set boolean Required

      true when a non-empty SMTP password is stored

    • subject string Required

      the subject of an alert whose form sets none

    • footer2 string Required

      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).

GET /email_settings
curl \
 --request GET 'https://api.iformbuilder.com/exzact/api/v80/[servername]/email_settings' \
 --header "Authorization: Bearer {access_token}"
Response examples (200)
{
  "custom": true,
  "host": "smtp.example.com",
  "from_address": "alerts@example.com",
  "username": "mailer",
  "password_set": true,
  "subject": "New Record",
  "footer": "",
  "footer2": ""
}