Email Account

An Email Account is an SMTP sender you register in a Space. It is a resource that bundles together the server address to send mail through, the login credentials, and the sending address. When a Script's EmailSend statement runs, the actual mail goes out through this Email Account. For example, if a clothing-shop online store wants to send a confirmation email whenever an order comes in, you first register an Email Account to use for sending and have the Script reference it.

An Email Account is a Space-level resource managed in CMA, based on the path /spaces/{spaceId}/email-accounts. It has no publish concept. With no status value or publish step, once you create it you can use it for sending right away. Instead, note that creating one is not a harmless read-only action but an action that actually sends one email to validate the settings, and that the connection information (endpoint, username, password) cannot be changed once created; both points are covered below.

Resource structure

The following is the response when you create an Email Account. sys (system properties) holds the identifier and version, and the body holds the sender settings (name, endpoint, username, fromAddress, fromName). The password (password) does not appear anywhere in the response.

{
  "sys": {
    "id": "3trmXRMdKpLc7GfNbyVQeR2WsT9LnU",
    "type": "EmailAccount",
    "space": { "sys": { "id": "HnQ32YiH", "type": "Refer", "targetType": "Space" } },
    "createdBy": { "sys": { "id": "9dLmQ2pVnRb8sTfWcXd3LhJ7gK", "type": "Refer", "targetType": "User" } },
    "createdAt": "2026-08-04T05:12:44.108Z",
    "updatedBy": { "sys": { "id": "9dLmQ2pVnRb8sTfWcXd3LhJ7gK", "type": "Refer", "targetType": "User" } },
    "updatedAt": "2026-08-04T05:12:44.108Z",
    "version": 1
  },
  "name": "Order Notifications",
  "endpoint": {
    "host": "smtp.gmail.com",
    "port": 587,
    "security": "StartTls"
  },
  "username": "orders@example-shop.com",
  "fromAddress": "orders@example-shop.com",
  "fromName": "Clothing Shop Orders"
}

Main keys:

• sys.id: The unique identifier of the Email Account. It goes into {emailAccountId} in the single-read, update, and delete paths.
• sys.version: The resource version. It starts at 1 and increases each time you make a change. You send this value in the update request via the X-Weegloo-Version header (see Status and constraints below).
• name: The label shown in the console (for example, Order Notifications). It is not used for sending, and it is not the From display name. It is only a name to tell multiple senders apart.
• endpoint: The SMTP server to connect to. It consists of three values: host, port, and security.
• username: The SMTP login username. It differs by provider. It may be the email address itself, a fixed string the sending service defines, or a domain-level login.
• fromAddress: The sending address. It is used as both the envelope return path (MAIL FROM) and the From address the recipient sees.
• fromName: The display name shown in the From header (optional). Without it, only the address appears.

The password (password) is a write-only value that you send only in the create request body, so it does not come back in the response above, nor in any later read or list. The username comes back in the read response exactly as you entered it.

System properties (sys)

Every Email Account carries common system properties in the sys object. space, createdBy, and updatedBy come in the Refer shape ({ "sys": { "id", "type": "Refer", "targetType" } }).

Body properties:

Create-request-body-only input:

Sender info and connection info

An Email Account's values fall into two kinds. This distinction determines what you can change.

• Connection info: endpoint, username, password. These cannot be changed after creation. To move the sending server or rotate the login credentials, create a new Email Account and delete the old one. As explained above, the password cannot be read back, so if you lose it, handle it by re-creating rather than resetting.
• Sender info: name, fromAddress, fromName. These can still be changed after creation with an update (PUT). Use it to tidy up the label or change the sending address or display name; the connection info stays intact.

An actual email is sent on creation

Creating an Email Account is not merely an action that stores settings. Before saving, the server actually connects with the endpoint, username, and password you entered and sends one test email. The send target is fromAddress, and if username is a different address, that address may be included as well.

• The resource is saved only if the send succeeds.
• If the server rejects it at any stage of connecting, authenticating, or sending, it fails with nothing created, and the response includes the failure reason the server returned.

So note that repeating creation with wrong values attempts an actual send each time.

Status and constraints

The value constraints enforced on create and update.

Rules on behavior and permissions:

• Connection info is immutable. The only things Update (PUT) can change are name, fromAddress, and fromName. To change endpoint, username, or password, create a new one and delete the old.
• An update needs the version. Send the current sys.version value in the Update request via the X-Weegloo-Version header. If the value is not current, it is rejected as a version conflict. In that case, read the resource again and retry with the latest sys.version.
• The password cannot be read back. It appears in no read or list, so if you lose it, handle it by re-creating rather than resetting.
• The SMTP servers you can use differ by plan. The preset provider hosts (Gmail, Naver, Resend, Brevo) can be registered even on lower plans. An arbitrary (self-hosted) host that is not in the presets requires a registered payment method to use. For per-plan policy, see Pricing.

API

The base URL for all the endpoints below is https://cma.weegloo.com/v1, and the Authorization header requires a Bearer token that authenticates to CMA. An update (PUT) additionally requires the X-Weegloo-Version header.

Related documents

• Script: Send mail through this Email Account with the EmailSend statement.
• SpaceRole: The role that defines resource-access permissions for this Space.
• Pricing: The usage policy for preset provider hosts and arbitrary (self-hosted) SMTP hosts.