--- title: "Configure SMTP Gateway" slug: "smtp" updated: 2024-10-18T08:52:30Z published: 2024-10-18T08:52:30Z canonical: "help.symphonysummitai.com/smtp" --- > ## Documentation Index > Fetch the complete documentation index at: https://help.symphonysummitai.com/llms.txt > Use this file to discover all available pages before exploring further. # Configure SMTP Gateway An SMTP Gateway, also known as an SMTP relay, is a service or server that acts as an intermediary between email clients and email servers to facilitate the delivery of emails. When a user sends an email from their email client, the email is first sent to the SMTP Gateway. The SMTP Gateway then processes the email and forwards it to the recipient's email server. The recipient's email server then delivers the email to the recipient's inbox. SMTP API Gateway is a service that provides an API interface to interact with SMTP Gateway functionality. It allows developers to integrate SMTP Gateway functionality into their applications to send Email. **User Persona**: App Administrator ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/SMTP%20infographic.gif?sv=2026-02-06&spr=https&st=2026-11-22T15%3A22%3A17Z&se=2026-11-22T16%3A22%3A17Z&sr=b&sp=r&sig=rzeZmVzXVa8tq%2F4HmH6rrW5OIE6SYDbIQti0%2B8PHhCA%3D) On configuring SMTP the App Administrator can test if it can successfully send mail. Let’s explore more on SMTP configuration and testing. - [Configure](/summit-platform/docs/smtp#configure-smtp-gateway) - [Edit](/summit-platform/docs/smtp#edit-smtp-gateway) - [Send Test Mail](/summit-platform/docs/smtp#send-test-mail) - [View Test History](/summit-platform/docs/smtp#view-test-history) ## Configure SMTP Gateway The SMTP Gateways configured within the application are Primary and Secondary. The Types of SMTP used to send email are Relay and API. To configure SMTP Gateway, perform the following steps: 1. Log in as an App Administrator. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/image-1728284925841.png?sv=2026-02-06&spr=https&st=2026-11-22T15%3A22%3A17Z&se=2026-11-22T16%3A22%3A17Z&sr=b&sp=r&sig=JZTuVPJB%2BRMeN0A0oOHFgKWvTpc2PhN8Z5DWb%2FOo66Q%3D) Figure: App Portal 2. Click the Application Group tab and select an Application. Example: Application Groups will be configured as IT, HR, Finance, etc, and Applications are Asset Management, Service Management, etc. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/apps and app group(3).png?sv=2026-02-06&spr=https&st=2026-11-22T15%3A22%3A17Z&se=2026-11-22T16%3A22%3A17Z&sr=b&sp=r&sig=cFvWeyzXe1CxkbiL0JzzeR%2BXgREweYz25uCh0O9MG74%3D) Figure: Applications 3. Click the settings gear icon on the top panel, navigate to **Design Studio** > **Applications** > **Notification Type** > **SMTP**, and click **Add SMTP Gateway**. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/image-1728285018491.png?sv=2026-02-06&spr=https&st=2026-11-22T15%3A22%3A17Z&se=2026-11-22T16%3A22%3A17Z&sr=b&sp=r&sig=1qbHRn%2FuHmXwyBuUl%2FWxQhak8boL5XC0cRRUhfQRAqE%3D) Figure: SMTP Gateway 4. Select and Enter the appropriate details in the required fields. Refer to the following sections about the configuration details. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/Add SMTP gateway config(2)(1).png?sv=2026-02-06&spr=https&st=2026-11-22T15%3A22%3A17Z&se=2026-11-22T16%3A22%3A17Z&sr=b&sp=r&sig=9WKVnbY54OdEqDbv6uCwDzOu7eMGQw%2FGNxcA51VT3g4%3D) Figure: Add SMTP Gateway Configuration - [General](/summit-platform/docs/smtp#general) - [Primary and Secondary Gateways](/summit-platform/docs/smtp#primary-and-secondary-gateways) **Gateways and its Dependency on the Platform Components** The system provides two types of SMTP gateways namely: **Relay** **API** Multiple Primary and Secondary gateways can be configured for different Domains, OUs & Tenants, and also for the Global level. However, the following rules apply: - A **Global** level has only one Primary & Secondary gateway. - Each **Tenant** can have only one Primary and Secondary gateway. - Each **Sub Domain** can have one or more Primary and Secondary gateways. **Example**: Sub Domain with a combination of the following Tenants can have multiple primary and secondary gateways. HR and IT can have a Primary and Secondary gateway. IT and Finance can have a Primary & Secondary gateway. - Each **Domain** can have one or more Primary & Secondary gateways based on different combinations. - If any two combinations are similar, then the second similar combination becomes invalid. ### General This section allows to configuration of SMTP at the platform levels such as Global, Domain, Sub Domain, and Tenant. **Configure for Platform Components** SMTP is configured from the platform level, **Configure for*** provides the following options: - [Global](/summit-platform/docs/smtp#global) - [Domain](/summit-platform/docs/smtp#domain) - [Sub Domain](/summit-platform/docs/smtp#sub-domain) - [Tenant](/summit-platform/docs/smtp#tenant) #### **Global** A Global gateway will cater to the entire Domains, Sub Domains, and Tenants that are under the Global configuration. So, whenever a Global option is selected then the notification email will be sent to the entire organization. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/global(2).png?sv=2026-02-06&spr=https&st=2026-11-22T15%3A22%3A17Z&se=2026-11-22T16%3A22%3A17Z&sr=b&sp=r&sig=4offnsbW4B3RygWHBeBPxv7y2axhMGU8xEqpJr7pttw%3D) Figure: Global SMTP #### **Domain** If a Domain is selected from the dropdown, a new field appears titled as Domain. This is a dropdown with the list of available Domains. This is a multichip selection-based option, multiple or a single Domain can be selected. When a Domain is selected then all the Sub Domains and Tenants within the selected Domain will be applicable to receive mails through the gateway. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/Domain(1).png?sv=2026-02-06&spr=https&st=2026-11-22T15%3A22%3A17Z&se=2026-11-22T16%3A22%3A17Z&sr=b&sp=r&sig=yqy2s%2FeQPlVu%2BbmAJ2tSmA4KXClWBwOwIuMnY2BEsjs%3D) Figure: Domain SMTP #### **Sub Domain** If a Sub Domain is selected, a new field appears titled as Sub Domain along with the Domain field. The Sub Domain field is a dropdown displaying a list of all Sub Domains within the selected Domain. Multiple or single Sub Domains can be selected using the multichip-based selection option. When a Sub Domain is selected then all the Tenants within the Sub Domain will also be able to receive mail from the gateway. - A Domain must be selected first. - Only the Sub Domains under the selected Domain are displayed within the Sub Domain dropdown. If two Domains are selected, then Sub Domains under the selected Domains will be displayed in the dropdown. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/sub domain(1).png?sv=2026-02-06&spr=https&st=2026-11-22T15%3A22%3A17Z&se=2026-11-22T16%3A22%3A17Z&sr=b&sp=r&sig=KsqC6vdlCEfdJ22toNKoKfQlSsAKJzIVq0BxETNhYyA%3D) Figure: Sub Domain SMTP #### **Tenant** If a Tenant is selected, a new field appears titled as Tenant along with the Domain and the Sub Domain field. The Tenant field is a dropdown that displays a list of all Tenants. Multiple or single Tenants can be selected using the multichip-based selection option. When a Tenant is selected only the selected Tenant will receive mails from the gateway. To select any Tenant, the Domain and the Sub Domain must be selected. - A Domain needs to be selected first. - Only the Sub Domains under the selected Domain are displayed within the Sub Domain dropdown. - Only the Tenants listed under the selected Sub Domains and Domains are displayed in the Tenant dropdown. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/Tenant.png?sv=2026-02-06&spr=https&st=2026-11-22T15%3A22%3A17Z&se=2026-11-22T16%3A22%3A17Z&sr=b&sp=r&sig=qFlKPXERHzy49QzyKSyaVjCkDFyz82b47kspAIVTD3s%3D) Figure: Tenant ### Primary and Secondary Gateways The SMTP Type field will be shown in both Primary and Secondary gateways. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/smtp types.png?sv=2026-02-06&spr=https&st=2026-11-22T15%3A22%3A17Z&se=2026-11-22T16%3A22%3A17Z&sr=b&sp=r&sig=zzfdWyAfz5Wo4ymiTcCkRqDhEcAKGC%2FHyXWz%2FBwLZBA%3D) Figure: SMTP Types on Primary and Secondary Gateways > [!NOTE] > Note > > The primary gateway is a mandatory configuration for any level of gateway settings. Based on the selected SMTP type the configuration screen is displayed. The following SMTP types are available in the dropdown list. - [Relay](/summit-platform/docs/smtp#relay) - [API](/summit-platform/docs/smtp#api) The maximum number of SMTP scenarios are as follows: | Type | Scenario 1 | Scenario 2 | Scenario 3 | Scenario 4 | | --- | --- | --- | --- | --- | | Primary | Relay | API | Relay | API | | Secondary | API | Relay | Relay | API | **Configuration Precedence and Fallback Scenarios** **Configuration Precedence** The system should consider the triggering of mails based on Primary and Secondary gateways and also based on the levels it represents. The workflow displayed below is the configuration precedence: ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/send email precedence(2).png?sv=2026-02-06&spr=https&st=2026-11-22T15%3A22%3A17Z&se=2026-11-22T16%3A22%3A17Z&sr=b&sp=r&sig=%2BM59MtERy6HPQx2RDkxzpFmD5LncCUuA6RjXi8T5Ydc%3D) **Fallback Scenarios** The system will trigger mails according to the configured Primary and Secondary gateways. Whenever a mail gets triggered for any level, the system will first check the availability of configurations for the level, and based on that the mails get triggered from the Primary or Secondary gateway. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/Fallback Scenarios(1).png?sv=2026-02-06&spr=https&st=2026-11-22T15%3A22%3A17Z&se=2026-11-22T16%3A22%3A17Z&sr=b&sp=r&sig=iJB5Ts9JT%2By1gAcDFLrlDNxEIgJL%2FAGL00UJvPJhp2c%3D) #### Relay SMTP Relay is a process of sending emails through a SMTP server. SMTP servers are often used as relays because they can handle large volumes of emails, and ensure that emails are delivered to their intended recipients. To configure Relay Type, perform the following steps: 1. Select **Relay** as SMTP Type to send email through the SMTP Server. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/relay config screen.png?sv=2026-02-06&spr=https&st=2026-11-22T15%3A22%3A17Z&se=2026-11-22T16%3A22%3A17Z&sr=b&sp=r&sig=w%2F8InOeRG7FOIIlfNx14Y65S7TC5C8ZCwYxjkIXh%2Byg%3D) Figure: Relay SMTP 2. Enter appropriate details in the required fields. The following table provides details regarding Field Description. | Field | Description | | --- | --- | | SMTP Type | Specify the Type of SMTP, as Relay is selected from the previous action, all the Relay configuration fields are displayed. | | From Name | Enter **From Name**, this is the name recipients will see as part of the From or Sender value when they receive the message. | | From Email ID | Enter **From Email ID**, this is the Email Address that will be used to send emails to the recipients. | | Host | Enter SMTP **Host**, this is your outgoing mail server (example: smtp.office365.com) | | Port | Enter the **Port** number, this is the Port that will be used to relay outbound mail to your mail server. Example: 587 | | Encryption | Select any one Encryption type, from the following options: - None - SSL - TLS | | Authentication | Select Authentication. - Yes: Email through the SMTP Relay server will have an authentication. Selecting **Yes** will enable **Username** and **Password** fields. By default, this is always selected for Relay emails. - No: Email through the SMTP Relay server will not have an authentication and Username and Password fields will not be displayed. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/No Authencation.png?sv=2026-02-06&spr=https&st=2026-11-22T15%3A22%3A17Z&se=2026-11-22T16%3A22%3A17Z&sr=b&sp=r&sig=dEzgktGv2qye8JIlNmi%2FVABQAHU8JXFrTTJnCqa1wWI%3D) | | Username | Enter the Username, the Username created here will be used to login to the SMTP mail server. | | Password | Enter Password, a password for the mail server is set here. This password will be used to login to the SMTP mail server. | | Active | Enable Active control to configure SMTP Type as Active and disable to configure SMTP Type as Inactive. If enabled, SMTP Type for Primary or Secondary configuration will be triggered. If disabled, SMTP Type for Primary or Secondary configuration will not be triggered. | | Submit | Click **Submit**, to save the SMTP configuration and view it on the List page. | | Cancel | Click **Cancel**, to exit from the configuration. | #### API API (Application Programming Interface) is a set of protocols, tools, and standards for building software applications. An API allows different software applications to communicate with each other. When the SMTP Type selected is API, then the configuration fields related to the API type are displayed. To configure API Type, perform the following steps: 1. Select **API** as SMTP Type, to send email through the application interface. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/api gateway.png?sv=2026-02-06&spr=https&st=2026-11-22T15%3A22%3A17Z&se=2026-11-22T16%3A22%3A17Z&sr=b&sp=r&sig=fIfEFYaJMNwwozIpInZ8LoiM7zzJPT0k%2BKIdkU3iPWQ%3D) Figure: API SMTP Gateway 2. Enter appropriate details in the required fields. The following table provides details regarding Field Description. | Field | Description | | --- | --- | | SMTP Type | Specify the Type of SMTP, as **API** is selected from the previous action, all the API configuration fields are displayed. | | From Name | Enter **From Name**, this is the name recipients will see as part of the From or Sender value when they receive the message. | | From Email ID | Enter **From Email ID**, this is the Email Address that is used to send emails to the recipients. | | API | Select **API**, the dropdown will display all the configured APIs. To configure a new API, refer to [API Configuration](https://help.symphonysummitai.com/summit-platform/docs/overview-api-configuration). | | Submit | Click **Submit**, to save the SMTP configuration and view it on the List page. | | Cancel | Click **Cancel**, to exit from the configuration. | ## Edit SMTP Gateway To Edit an SMTP Gateway, perform the following steps: 1. Select the required ID on the SMTP list page. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/smtp.png?sv=2026-02-06&spr=https&st=2026-11-22T15%3A22%3A17Z&se=2026-11-22T16%3A22%3A17Z&sr=b&sp=r&sig=%2FhRja6RFpEnEAq0lWXnL8HtfzsGH0qAG1Qf6u3Sx1go%3D) Figure: SMTP Gateway 2. Make the required changes and click **Update**. Upon updating, you will be navigated to the List page. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/update smtp.png?sv=2026-02-06&spr=https&st=2026-11-22T15%3A22%3A17Z&se=2026-11-22T16%3A22%3A17Z&sr=b&sp=r&sig=SLm0lOp%2BuUrXPu81OAFwroHj%2FuGahxqtEO7teyltP4o%3D) Figure: Update SMTP ## Send Test Mail The SMTP Gateway configuration page will have the option to test the configured SMTP gateways by sending a test email. Once all the configurations are completed, go back to the configured SMTP from the List page, on the configuration screen just below the Primary and Secondary gateways there will be an option available to send Test Mail. To send a test mail, perform the following: 1. Click SMTP ID on the SMPT list page. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/list page smtp.png?sv=2026-02-06&spr=https&st=2026-11-22T15%3A22%3A17Z&se=2026-11-22T16%3A22%3A17Z&sr=b&sp=r&sig=bTEBjZibsTI6YjIQxVG8W1t1FalThcTpMrdYhJF7zp8%3D) Figure: SMTP List 2. SMTP configuration screen is displayed, click **Send Test Mail** to check the SMTP configuration. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/send test mail.png?sv=2026-02-06&spr=https&st=2026-11-22T15%3A22%3A17Z&se=2026-11-22T16%3A22%3A17Z&sr=b&sp=r&sig=hNTKVSXpW6KokqZeBV2SRffnCYugZAqkwQBF2WJJon8%3D) Figure: SMTP Send Test Mail 3. The Test Mail screen is displayed. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/Test Mail Configuration screen.png?sv=2026-02-06&spr=https&st=2026-11-22T15%3A22%3A17Z&se=2026-11-22T16%3A22%3A17Z&sr=b&sp=r&sig=BMeFSwx1Ym1f3UZYJ3rTqjYQyEvWwfanFA0hDYsa6xI%3D) Figure: Test Mail 4. Select and enter appropriate details in the Test Mail configuration. Click **Send** to test SMTP or click **Cancel** to exit from the configuration screen. The following table provides details about the Field Description. | Field | Description | | --- | --- | | Test For | For the configured Global/Domain/Sub Domain/Tenant level there is an option to test the gateway configuration to see if it's working as expected. This **Test For** dropdown provides two options as follows: - **Primary Gateway**: When Primary is selected, the system sends the test mail from Primary Gateway. - **Secondary Gateway**: When Secondary is selected, the system sends the test mail from the Secondary Gateway. Either Primary or Secondary can be selected at a time. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/Test For.png?sv=2026-02-06&spr=https&st=2026-11-22T15%3A22%3A17Z&se=2026-11-22T16%3A22%3A17Z&sr=b&sp=r&sig=uHyrxGvpDZw%2Bc4AF9ci1QCSvvB6RCuCvE27VWgJPqq0%3D) Figure: Test For | | To | By default, the login person’s Email ID will be auto-captured in the **To** field. However, the login person cannot edit the field to change the email id. > [!NOTE] > Note > > Sending Emails from here is only for testing purposes and no official communication is to be done from here. | | Subject | To avoid any misuse of this function the system will pre-populate a message in the Subject textbox with a message as **Test Email.** | | Body | To avoid any misuse of this function the system will pre-populate a message in the Subject textbox with a message **This is an email for testing the SMTP Gateway. Please ignore**. > [!NOTE] > Note > > The name and email ID of the sender will be captured in the message. | | **Response** | | Status | Click **Send** to check the configuration. \| Response \| Description \| \| --- \| --- \| \| Success \| If the selected Gateway is configured as expected, then a Success message is displayed as **Test Mail sent Successfully.** ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/primary Test For.png?sv=2026-02-06&spr=https&st=2026-11-22T15%3A22%3A17Z&se=2026-11-22T16%3A22%3A17Z&sr=b&sp=r&sig=PRYo78EQOcu5Ua7S2SWtTyfM82gZt0l4jWkb%2BRqUyYE%3D) Figure: Success Response \| \| Failed \| If the selected Gateway is configured incorrectly, then a Failed message is displayed as **Test mail failed!** ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/failed message.png?sv=2026-02-06&spr=https&st=2026-11-22T15%3A22%3A17Z&se=2026-11-22T16%3A22%3A17Z&sr=b&sp=r&sig=eUKOLxgoNo0BiCJ8La7lAfcSjnq9Kq8QKKGo%2BmL%2FoIc%3D) Figure: Failed Response \| | | Response | Description | | Success | If the selected Gateway is configured as expected, then a Success message is displayed as **Test Mail sent Successfully.** ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/primary Test For.png?sv=2026-02-06&spr=https&st=2026-11-22T15%3A22%3A17Z&se=2026-11-22T16%3A22%3A17Z&sr=b&sp=r&sig=PRYo78EQOcu5Ua7S2SWtTyfM82gZt0l4jWkb%2BRqUyYE%3D) Figure: Success Response | | Failed | If the selected Gateway is configured incorrectly, then a Failed message is displayed as **Test mail failed!** ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/failed message.png?sv=2026-02-06&spr=https&st=2026-11-22T15%3A22%3A17Z&se=2026-11-22T16%3A22%3A17Z&sr=b&sp=r&sig=eUKOLxgoNo0BiCJ8La7lAfcSjnq9Kq8QKKGo%2BmL%2FoIc%3D) Figure: Failed Response | | Display Type | Select **Display Type** from the dropdown, following options are displayed: - Text: Selecting **Text** will display content in the Description field in Text format. - JSON: Selecting **JSON** will display content in the Description field in JSON format. | | Description | The description contains the details that are configured in the selected API configuration, for more information, refer [API Body](https://help.symphonysummitai.com/summit-platform/docs/overview-api-configuration#body). | ## View Test History Upon testing SMTP, the Success or Failed responses are saved under Test History on the List page of SMTP Configuration. The History details are captured and presented in a list format where simple filters can be applied to view the required results. To view the Test History, perform the following steps: 1. Navigate to the List page and select the configured SMTP ID. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/select ID.png?sv=2026-02-06&spr=https&st=2026-11-22T15%3A22%3A17Z&se=2026-11-22T16%3A22%3A17Z&sr=b&sp=r&sig=9MY3%2Fgu2CzwOja1QqxblzqPgcCvT8Up%2FEQYjjDJzTsk%3D) Figure: SMTP List 2. Click the **Test History** icon on the Top Panel. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/Test history.png?sv=2026-02-06&spr=https&st=2026-11-22T15%3A22%3A17Z&se=2026-11-22T16%3A22%3A17Z&sr=b&sp=r&sig=mDsC4K%2BvGyZZRvuAi2VreBopdxqsP7svvbRrDGb9kNU%3D) Figure: SMTP Gateway Details 3. Test Mail History details are displayed. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/Mail history.png?sv=2026-02-06&spr=https&st=2026-11-22T15%3A22%3A17Z&se=2026-11-22T16%3A22%3A17Z&sr=b&sp=r&sig=Ix2MiIYLoHtzQzgpD%2FutgyswI4LBtysp%2B3Zng14vFtg%3D) Figure: Test Mail History