# idaas-email

Part of **IDAAS**

# IDaaS Notifications Console Guide

## Operations Overview

| Operation | Console Entrance | Prerequisites | Description |
|------|-----------|---------|------|
| Configure Mail Gateway | IDaaS console > CIAM > Manage > Branding > Gateway Service > Mail Gateway | A mail gateway service that is activated and ready to accept inbound connections; An IDaaS CIAM service that is activated | Set up enterprise mail gateway integration for IDaaS-generated emails like verification codes and password resets. |
| Email Templates | Branding > Email Templates | Activate an email gateway service such as Alibaba Cloud Direct Mail; Create an email domain and sender address in advance; Use an instance of Trial Edition or Enterprise Edition | Configure custom SMTP email gateways and manage multi-language email templates for branded notifications. |
| Configure SMS Template | CIAM User Identity Service > Branding > Gateway Service | Alibaba Cloud Short Message Service activated; IDP4 administrator account | Configure Alibaba Cloud SMS signatures and templates for OTP and notification messages, including RAM user setup. |
| SMS Templates | Console > Identity as a Service (IDaaS) > Branding > SMS Templates | User must have access to the IDaaS console; User notification features must be enabled in the system | View default SMS and email notification content sent to users upon trigger events. |

## Operation Steps

### Configure Mail Gateway

**Navigation**: IDaaS console > CIAM > Manage > Branding > Gateway Service > Mail Gateway

**Prerequisites**:
- A mail gateway service that is activated and ready to accept inbound connections
- An IDaaS CIAM service that is activated

1. Log on to the **IDaaS console** (link) — top navigation bar
   - Notes: Navigate to https://yundun.console.aliyun.com/?p=idaas

2. Select the corresponding IDaaS instance and click **Manage** (button) — Operation column

3. Click on **Branding** (menu) — left navigation panel
   - Notes: Then select Gateway Service > Mail Gateway from the submenu

4. Click **Create a gateway instance** (button) — main content area
   - Notes: The form shows example values. Complete each field according to the format shown.

5. Enter a receiving mailbox address in the test field and click **Send** (button) — test section

### Email Templates

**Navigation**: Branding > Email Templates

**Prerequisites**:
- Activate an email gateway service such as Alibaba Cloud Direct Mail
- Create an email domain and sender address in advance
- Use an instance of Trial Edition or Enterprise Edition

1. Navigate to **Branding > Email Templates** (link) — left navigation panel

2. Click **Add Custom Email Gateway** (button) — main content area

3. In the Add Custom Email Gateway panel, set **Gateway Service Provider** (dropdown) to SMTP — main content area
   - Notes: Other fields include SMTP Endpoint, Port Number, Enable SSL Encryption, SMTP Account, SMTP Password, Sender Email Address, and Sender Name.

4. Click **Test Send** (button) — bottom of the panel
   - Notes: Enter a recipient's email address and confirm to send the test email.

5. Click **Confirm** (button) — bottom of the panel
   - Notes: After confirming the settings, click this button to finalize the addition.

6. Click **Manage** (link) — Actions column
   - Notes: This opens the management page for the selected custom email gateway.

7. Click the **Gateway Configuration** (tab) — top of the management page

8. Click the **Email Template** (tab) — top of the management page
   - Notes: Currently supports Chinese and English only.

9. Check **Select as default** (checkbox) — row actions
   - Notes: If the custom gateway becomes unavailable, IDaaS automatically switches to the initial email gateway.

10. Click **Remove** (link) — Actions column
    - Notes: After removal, configurations cannot be restored.

| Parameter | Type | Required | Options/Values | Description |
|-----------|------|----------|----------------|-------------|
| Gateway Service Provider | dropdown | Yes | SMTP | The email protocol used for sending emails. Set to SMTP. |
| Display Name | text_input | Yes | — | The name of the email gateway displayed only in the IDaaS EIAM console. |
| SMTP Endpoint | text_input | Yes | — | The endpoint of the SMTP service obtained from your email gateway provider. |
| Port Number | number_input | Yes | — | The port number of the SMTP service. Common values: 25, 80, 465. |
| Enable SSL Encryption | checkbox | No | — | Specifies whether to enable SSL encryption for secure communication. |
| SMTP Account | text_input | Yes | — | The account used to access the SMTP email gateway. Usually the email address prefix. |
| SMTP Password | text_input | Yes | — | The password for the SMTP account. |
| Sender Email Address | text_input | Yes | — | The email address of the sender, e.g., xxxx@example.com. |
| Sender Name | text_input | No | — | The name of the sender, such as enterprise or brand name. Optional; defaults to sender email prefix if not set. |

### Configure SMS Template

**Navigation**: CIAM User Identity Service > Branding > Gateway Service

**Prerequisites**:
- Alibaba Cloud Short Message Service activated
- IDP4 administrator account

1. Log on to the **Short Message Service console** (link) — top navigation bar

2. Select **Messages in Chinese mainland** (menu) — left navigation panel
   - Notes: Then choose Signature Management

3. Click **Add Signature** (button) — main content area
   - Notes: Include signature name, applicable scenarios, signature purpose, qualification information, signature source, app store link, scenario description, and more materials.

4. Click **Submit** (button) — bottom of form
   - Notes: Status changes to In review after submission.

5. Log on to the **Short Message Service console** (link) — top navigation bar

6. Select **Messages in Chinese mainland** (menu) — left navigation panel
   - Notes: Then choose Template Management

7. Click **Add Template** (button) — main content area
   - Notes: Choose from Verification Code, Notification, or Promotional Message.

8. Fill in template details including associated signature, template name, content with variables, scenario description, and upload materials, then click **Add** (button) — bottom of form
   - Notes: Template content must include ${variableName} format. Verification code templates must contain specific keywords. Promotional messages must include opt-out text.

9. Click **Add** (button) — bottom of form
   - Notes: Status changes to In review after submission.

10. Log on to the **Resource Access Management** (link) — top navigation bar

11. Click **Create an AccessKey pair** (button) — main content area
    - Notes: Can be done via Method 1 (existing user) or Method 2 (new user).

12. Click **Add Permissions** (button) — main content area
    - Notes: Search for and select 'SMS' policy in system policy list.

13. Log on to the **IDaaS Console** (link) — top navigation bar

14. Navigate to **Branding** (menu) — left navigation panel
    - Notes: Path is CIAM User Identity Service > Branding > Gateway Service

15. Select **Alibaba Cloud SMS gateway** (radio) — main content area
    - Notes: Enter credentials obtained from RAM user setup.

| Parameter | Type | Required | Options/Values | Description |
|-----------|------|----------|----------------|-------------|
| Signature | text_input | Yes | — | Enter the signature name. Do not enter 【】. The system automatically adds 【】 at the beginning of the message content. |
| Applicable Scenarios | dropdown | Yes | General | Select the applicable use case for the signature. |
| Signature Purpose | radio | Yes | For Own Use, For Other's Use | Indicate whether the qualification matches the logged-in Alibaba Cloud account. |
| Qualification Information | dropdown | Yes | — | Select the qualification associated with the signature. Pre-approved qualifications are recommended. |
| Signature Source | dropdown | Yes | — | Select the source of the signature (e.g., live app, website). Must be related to the signature name. |
| App Store Link | text_input | No | — | If the signature source is a published app, enter its app store URL starting with http:// or https://. |
| Scenario Description | text_input | Yes | — | Provide information about your use case. A clear description helps reviewers understand your business scenario. |
| More Materials | text_input | No | — | Upload supplementary materials such as screenshots, software copyright certificates, or agreements. |
| Associated Signature | dropdown | Yes | — | Select an approved message signature to associate with this template. |
| Template Name | text_input | Yes | — | Enter a name for the template. |
| Template Content | text_input | Yes | — | Enter the content of your SMS message using ${variableName} format for variables. Must follow specific rules based on template type. |
| Scenario Description | text_input | Yes | — | Describe the business scenario for the SMS messages or provide a link to your online business. Must include a complete message example with sample variable values. |
| More Materials | text_input | No | — | Upload business verification documents or business screenshots to help reviewers understand your business details. |

### SMS Templates

**Navigation**: Console > Identity as a Service (IDaaS) > Branding > SMS Templates

**Prerequisites**:
- User must have access to the IDaaS console
- User notification features must be enabled in the system

1. Navigate to **Branding** (link) — left navigation panel
   - Notes: Console URL is https://idaas.console.aliyun.com

2. Review the SMS and email content displayed under the **SMS templates** (tab) — main content area
   - Notes: The page shows default notification messages that will be sent to users when triggers are met.

## FAQ

Q: Where do I configure my company's SMTP server for sending IDaaS emails?
A: Go to Branding > Email Templates and click "Add Custom Email Gateway". You can enter your SMTP endpoint, port, credentials, and sender details there.

Q: What happens if my custom email gateway fails?
A: If you have selected a custom gateway as default and it becomes unavailable, IDaaS automatically falls back to the initial (built-in) email gateway to ensure delivery continuity.

Q: Can I edit SMS templates directly in the IDaaS console?
A: No. SMS templates must first be created and approved in the Alibaba Cloud Short Message Service console. IDaaS uses those approved templates but does not allow direct editing of template content.

Q: Are there language options for email templates?
A: Yes, email templates currently support Chinese and English. You can configure separate subject and content for each language on the Email Template tab.

Q: Do I need to create a RAM user for Alibaba Cloud SMS integration?
A: Yes. You must create a RAM user, generate an AccessKey pair, and grant the SMS permission policy to that user before entering the credentials in the IDaaS Gateway Service page.

## Pricing & Billing

### Billing Model
free

### Free Tier
Included in Trial Edition and Enterprise Edition instances. Current version sends SMS messages and emails at no charge.

### Billing Notes
Custom email gateways are only available in Trial Edition and Enterprise Edition instances. For SMS, while the IDaaS integration itself is free, actual SMS sending through Alibaba Cloud Short Message Service is billed separately at 0.05 / with a monthly free quota of 1000 .