Domain administrator log field descriptions

更新时间:
复制 MD 格式

Describes the fields in Alibaba Mail domain administrator log entries, covering both the legacy format and the upgraded format.

Log format overview

Domain administrator logs are currently being upgraded. Depending on when the operation was recorded, a log entry uses one of two formats:

  • Legacy format: structured as a request field and a response field.

  • Upgraded format: structured with named fields that provide richer operational detail.

Log details are in English. You can understand the meaning of most fields based on their names and the context. Field names follow a key-value pair format. The upgraded format provides more operational information than the legacy format. Alibaba Mail continues to expand coverage in the upgraded format.

---

1. Legacy logs

Legacy log entries have two top-level fields: request and response. These correspond to the operation request body and response body.

Note: For batch operations, legacy log entries may be truncated.

request

The request field identifies who performed the operation (operatorEmail), what objects were targeted, and what changed.

response

The response field records the operation result. The respStatus object contains the return value and error code.

For batch operations, response also includes the success field (objects processed successfully) and the fail field (objects that failed).

The following sections describe operation-specific fields in the request body, organized by entity type.

Users

Create a user

The accounts field contains a list of accounts. Each account includes:

email: Email address
name: Username
displayName: User display name
owner: Account owner
activeStatus: Account status
passwd: Password, which is desensitized
departmentId: Department ID
companyName: Company name
ldapLoginName: LDAP logon name
allowedLogin: Logon restrictions
jobTitle: Job title
workPhone: Work phone
mobilePhone: Mobile phone number
saveToSendFolder: Setting to save sent items
smtpSaveToSendFolder: SMTP setting to save sent items
userRole: User type
extend: Extension information

Delete a user

Field

Description

emails

List of users to delete

disableRecycle

Whether the user recycle bin is disabled

User updates

The following enumerated values appear in user update requests:

status

Value

Meaning

Effect in request

0

Normal

Restores the user to Normal status

1

Frozen

Freezes the user account

sendRestriction

Value

Meaning

0

Email sending is not restricted

1

Email sending is restricted

receiveRestriction

Value

Meaning

0

Email receiving is not restricted

1

Email receiving is restricted

Update a user password

The accounts field contains a list of accounts. Each account includes desensitized password information.

Create or delete a user alias

Field

Description

aliases

List of user aliases

account

The user account

alias

The user alias

asDisplayAlias

Whether the alias is used as the display name

User recycle bin

Recover a user

Field

Description

key

Identity of the deletion record

Transfer email

Field

Description

sourceKey

Identity of the deletion record

sourceEmailAddr

Source account for the email transfer

destEmailAddr

Destination account for the email transfer

Domains

Create or delete a domain alias

Field

Description

alias

The domain alias

Mail groups

Create or update a mail group

address: Address
name: Name
description: Description
type: Type. 0: regular mail group, 1: department mail group, 2: dynamic mail group, 4: audience group.
status: Status. 0: Normal.
admin: Administrator
maxAccountNum: Maximum number of accounts
needApprove: Specifies whether approval is required
contactShare: Specifies whether to display this mail group in the address book
newMemberNotice: Specifies whether to send a notification to new members after they are added to the group

The type field uses the following values:

Value

Mail group type

0

Regular mail group

1

Department mail group

2

Dynamic mail group

4

Audience group

Delete a mail group

Field

Description

addresses

List of mail groups to delete

Add or delete mail group members

Field

Description

address

The mail group address

members

List of members to add or remove

Domain administration

Set security questions

No additional fields.

Attach a secure phone

Field

Description

securityMobile

The mobile phone number to attach

Detach a secure phone

No additional fields.

Change a mail transport domain rule

Field

Description

item

Rule details, including monitoring, forward, review, and filtering settings

Third-party applications

Field

Description

newApp

Adds an application

deleteApp

Deletes an application

appName

Application name

appCode

Application code

NewAppRequest

Contains information for adding an application

DeleteAppRequest

Deletes an application

GrantAppPermissionsRequest

Application authorization information

Mailbox migration

The MigrateStatus field uses the following values:

Value

Status

1

In progress

4

Migration or deletion has not started

5

Not started

6

Paused

---

2. Upgraded logs

Log export or account export

Field

Description

attachmentname

Name of the exported log file (the attachment name in the email)

Receivers

Recipients of the exported log

Email recall

Field

Description

mailFrom

Sender's email address

subject

Email subject

totalRcptCount

Total number of recipients

successRecalledRcptCount

Number of accounts for which the recall succeeded

failRecalledRcptCount

Number of accounts for which the recall failed