管理API-功能参考
作者:ycms,发布时间:2020-05-14 15:05:51
AttachStore
附加现有的档案存储。
参数
名称 | 类型 | 描述 |
---|---|---|
name | string | 存档存储的有意义的名称。 |
type | string | 存档存储的类型。 |
databaseName | string(可选) | Microsoft SQL Server或PostgreSQL服务器上的数据库名称。 |
databasePath | string(可选) | 存储数据库文件夹信息和电子邮件元数据的目录的路径。 |
contentPath | string(可选) | 存储电子邮件标题和内容的目录的路径。 |
indexPath | string(可选) | 全文搜索索引存储目录的路径。 |
serverName | string(可选) | Microsoft SQL Server或PostgreSQL服务器的名称。 |
userName | string(可选) | 用于访问Microsoft SQL Server或PostgreSQL服务器的用户名。 |
password | string(可选) | 访问Microsoft SQL Server或PostgreSQL服务器的密码。 |
requestedState | string(可选) | 附加后档案存储的状态。 |
参数值
type
名称 | 描述 |
---|---|
FileSystemInternal | 基于高级文件系统的存档存储。 |
SQLServer | 基于Microsoft SQL Server的存档存储。 |
PostgreSQL | 基于PostgreSQL服务器的存档存储。 |
requestState
名称 | 描述 |
---|---|
current | 与“普通”相同,但新消息将存储在设置为“当前”的存档存储中。 |
normal | 归档存储的内容对用户可用,如果用户具有适当的权限,则可以对其进行修改。 |
writeProtected | 用户可以使用受写保护的存档存储的内容,但不能对其进行修改(例如,删除或移动邮件,重命名或移动文件夹) |
disabled | 禁用的归档存储未使用,但实例仍然知道它们的存在。因此,该内容对用户不可用。 |
CancelJobAsync
异步取消正在运行的作业。
参数
名称 | 类型 | 描述 |
---|---|---|
id | number | 要取消的作业的唯一标识符。 |
ClearUserPrivilegesOnFolders
删除用户在所有存档文件夹上的所有特权。
参数
名称 | 类型 | 描述 |
---|---|---|
userName | string | MailStore用户的用户名。 |
CompactMasterDatabase
压缩主数据库。
CompactStore
压缩档案存储。
参数
名称 | 类型 | 描述 |
---|---|---|
id | number | 归档存储的唯一标识 |
CreateBackup
创建整个存档的备份。
参数
名称 | 类型 | 描述 |
---|---|---|
path | string | 备份应写入的目录路径。 |
excludeSearchIndexes | bool(可选) | 指示是否应从备份中排除搜索索引文件。 |
CreateJob
创建一个新作业以执行Management API命令。
参数
名称 | 类型 | 描述 |
---|---|---|
name | string(可选) | 这项工作的有意义的名称。示例:每日备份。 |
action | string(可选) | 要执行的管理API命令。 |
owner | string(可选) | 作业所有者的用户名;必须是管理员。 |
timeZoneId | string(可选) | 日期应转换为的时区的id,例如$ Local,它表示操作系统的时区。 |
date | string(可选) | 日期时间字符串(YYYY-MM-DDThh:mm:ss),用于一次运行作业。 |
interval | string(可选) | 运行作业的间隔。 |
time | string(可选) | 运行作业的时间。如果没有其他参数,则意味着每天执行。 |
dayOfWeek | string(可选) | 每周的工作日。还需要参数“时间”。 |
dayOfMonth | string(可选) | 一个月中的某天去工作。还需要参数“时间”。dayOfWeek可以选择用于进一步定义。 |
使用API命令GetTimeZones检索所有可用时区及其ID的列表。
参数值
dayOfWeek
名称 | 描述 |
---|---|
Sunday | 星期日 |
Monday | 星期一 |
Tuesday | 星期二 |
Wednesday | 星期三 |
Thursday | 星期四 |
Friday | 星期五 |
Saturday | 星期六 |
dayOfMonth
名称 | 描述 |
---|---|
1 to 31 | 月份的数字表示形式。 |
Last | 一个月的最后一天。 |
interval
名称 | 描述 |
---|---|
5 | 每5分钟一次。 |
10 | 每10分钟一次。 |
15 | 每15分钟一次。 |
20 | 每20分钟一次。 |
30 | 每30分钟一次。 |
60 | 每隔一小时。 |
120 | 每2小时。 |
180 | 每3小时。 |
240 | 每4小时。 |
360 | 每6小时。 |
720 | 每12小时。 |
CreateProfile
创建一个新的归档或导出配置文件。
参数
名称 | 类型 | 描述 |
---|---|---|
properties | json | 配置文件属性。 |
raw | bool | 目前仅支持“true”。 |
参数值
properties
要接收可用的配置文件属性,请通过MailStore Client创建所需类型的配置文件,然后使用GetProfiles方法接收支持的值。必须省略属性ID和版本,必须正确填写密码字段。
CreateStore
创建并附加一个新的存档存储。
参数
名称 | 类型 | 描述 |
---|---|---|
name | string | 存档存储的有意义的名称。 |
type | string(可选) | 存档存储的类型。 |
databaseName | string(可选) | Microsoft SQL Server或PostgreSQL服务器上的数据库名称。 |
databasePath | string(可选) | 存储数据库文件夹信息和电子邮件元数据的目录的路径。 |
contentPath | string(可选) | 存储电子邮件标题和内容的目录的路径。 |
indexPath | string(可选) | 全文搜索索引存储目录的路径。 |
serverName | string(可选) | Microsoft SQL Server或PostgreSQL服务器的名称。 |
userName | string(可选) | 用于访问Microsoft SQL Server或PostgreSQL服务器的用户名。 |
password | string(可选) | 访问Microsoft SQL Server或PostgreSQL服务器的密码。 |
requestState | string(可选) | 附加后档案存储的状态。 |
参数值
type
名称 | 描述 |
---|---|
FileSystemInternal | 标准档案存储。 |
SQLServer | 基于Microsoft SQL Server的存档存储。 |
PostgreSQL | 基于PostgreSQL服务器的存档存储。 |
requestState
名称 | 描述 |
---|---|
current | 与“普通”相同,但新消息将存储在设置为“当前”的存档存储中。 |
normal | 归档存储的内容对用户可用,如果用户具有适当的权限,则可以对其进行修改。 |
writeProtected | 用户可以使用受写保护的存档存储的内容,但不能对其进行修改(例如,删除或移动邮件,重命名或移动文件夹) |
disabled | 禁用的归档存储未使用,但实例仍然知道它们的存在。因此,该内容对用户不可用。 |
CreateUser
创建新的MailStore用户。使用SetUserPrivilegesOnFolder授予该用户对用户自己的存档的特权。
参数
名称 | 类型 | 描述 |
---|---|---|
userName | string | 新MailStore用户的用户名。 |
privileges | string | 以逗号分隔的特权列表。 |
fullName | string(可选) | 用户的全名。 |
distinguishedName | string(可选) | LDAP DN字符串。 |
authentication | string(可选) | 用户的身份验证设置:“集成”或“目录服务”。 |
password | string(可选) | 新用户密码。 |
参数值
privileges
名称 | 描述 |
---|---|
none | 没有授予用户全局特权。如果指定,则此值必须是列表中的唯一值。 |
admin | 授予用户管理员权限。如果指定,则此值必须是列表中的唯一值。 |
login | 用户可以登录到MailStore服务器。 |
changePassword | 用户可以更改自己的MailStore服务器密码。仅当身份验证设置为Integrated时,这才有意义。 |
archive | 用户可以运行归档配置文件。 |
modifyArchiveProfiles | 用户可以创建,修改和删除归档配置文件。 |
export | 用户可以运行导出配置文件。 |
modifyExportProfiles | 用户可以创建,修改和删除导出配置文件。 |
delete | 用户可以删除消息。请注意,非管理员用户只能删除已被授予删除访问权限的文件夹中的邮件。此外,合规性设置可能会生效,即使已被授予权限,管理员和用户也无法删除消息。 |
DeleteEmptyFolders
从文件夹树中删除不包含电子邮件的文件夹。
参数
名称 | 类型 | 描述 |
---|---|---|
folder | string(可选) | 文件夹树中的入口点。 |
DeleteJob
删除作业。
参数
名称 | 类型 | 描述 |
---|---|---|
id | string | 要删除的作业的唯一标识符。 |
DeleteMessage
删除一条消息
争论
名称 | 类型 | 描述 |
---|---|---|
id | string | 消息的唯一ID。格式:<store_id>:<message_num> |
reason | string | 该消息必须删除的原因将被写入审核日志。 |
DeleteProfile
删除存档或导出配置文件。
争论
名称 | 类型 | 描述 |
---|---|---|
id | number | 配置文件的唯一ID。 |
DeleteUser
删除MailStore用户。删除用户时,不会删除用户的存档或用户的存档电子邮件。
参数
名称 | 类型 | 描述 |
---|---|---|
id | string | MailStore用户的用户名。 |
DetachStore
分离档案存储。
参数
名称 | 类型 | 描述 |
---|---|---|
id | number | 归档存储的唯一标识。 |
GetActiveSessions
获取当前用户会话的列表。
GetChildFolders
获取子文件夹。根据合规性设置,此方法可能仅返回第一个文件夹层次结构级别。
参数
名称 | 类型 | 描述 |
---|---|---|
folder | string(可选) | 父文件夹应返回其子文件夹。如果省略,将返回所有档案和文件夹。 |
maxLevels | number(可选) | 子文件夹的深度。 |
GetComplianceConfiguration
获取当前的合规性配置设置。
GetDirectoryServicesConfiguration
获取当前的目录服务配置设置。
GetFolderStatistics
获取文件夹统计信息。
GetJobResults
检索完成的作业执行的列表。
参数
名称 | 类型 | 描述 |
---|---|---|
fromIncluding | string | 要获取的时间范围的开始。 |
toExcluding | string | 提取的时间范围结束。 |
timeZoneId | string | 日期应转换为的时区的ID,例如$ Local,它表示操作系统的时区。 |
jobId | number(可选) | 要检索结果的作业ID。 |
交互式Management Shell示例:GetJobResults –fromIninclude =“2016-12-01T00:00:00” –toExclusion =“2016-12-31T23:59:59” –timeZoneId =“$ Local” –jobId = 1
使用API命令GetTimeZones检索所有可用时区及其ID的列表。
GetJobs
检索工作清单
GetMessages
从文件夹获取消息列表。
争论
名称 | 类型 | 描述 |
---|---|---|
folder | string(可选) | 要列出其内容的文件夹。 |
GetProfiles
获取存档和导出配置文件的列表。
争论
名称 | 类型 | 描述 |
---|---|---|
raw | bool | 目前仅支持“ true”。 |
GetRetentionPolicies
获取保留策略。
保留策略对象示例:
[ { "name": "Keep All Mails for 10 Years", "order": 1, "enabled": true, "searchCriteria": null, "period": 10, "periodInterval": "year", "delete": false } ]
GetServerInfo
获取MailStore Server版本和计算机名称。
GetServiceConfiguration
获取MailStore Server服务配置。这包括主数据库的路径,审核日志的位置,是否启用了不同的调试日志以及端点配置。
GetSmtpSettings
获取当前的SMTP配置。
GetStoreIndexes
获取全文索引列表。
参数
名称 | 类型 | 描述 |
---|---|---|
id | number(可选) | 归档存储的唯一标识。 |
GetStores
获取档案库列表。
参数
名称 | 类型 | 描述 |
---|---|---|
includeSize | bool(可选) | 包括档案存储的大小。默认值:true。在速度较慢的硬件上运行时可能会变慢。 |
GetTimeZones
获取可用时区列表。
ID输出的可以用作timeZoneId在CreateJob,GetJobResults,SetJobSchedule和SendStatusReport和timeZoneID(用大写ID中)GetJobResults。
GetUserInfo
获取有关用户的详细信息。
争论
名称 | 类型 | 描述 |
---|---|---|
userName | string | MailStore用户的用户名 |
GetUsers
获取用户列表。
GetWorkerResults
获取配置文件执行的结果。
参数
名称 | 类型 | 描述 |
---|---|---|
fromIncluding | string | 要获取的时间范围的开始。 |
toExcluding | string | 提取的时间范围结束。 |
timeZoneID | string | 日期应转换为的时区的ID,例如$ Local,它表示操作系统的时区。 |
profileID | numbser(可选) | 按给定的配置文件ID过滤结果。 |
userName | string(可选) | 按给定的用户名过滤结果。 |
交互式命令行管理程序示例:GetWorkerResults –fromIninclude =“ 2016-01-01T00:00:00” –toExclusion =“ 2016-12-31T23:59:59” –timeZoneID =“ $ Local” –profileID = 1- -userName =“ admin”
使用API命令GetTimeZones检索所有可用时区及其ID的列表。
要知道,timeZoneID必须用资本来写ID,其中用其他所有的命令timeZoneId期待标识。
MaintenanceFileSystemDatabases
在基于文件系统的归档存储的所有数据库上运行数据库维护。
MergeStore
合并两个档案存储。
参数
名称 | 类型 | 描述 |
---|---|---|
id | number | 目标归档存储的唯一标识。 |
sourceId | number | 源归档存储的唯一标识。 |
MoveFolder
移动文件夹。
参数
名称 | 类型 | 描述 |
---|---|---|
fromFolder | string | 旧文件夹名称。 |
toFolder | string | 新文件夹名称。 |
ProcessRetentionPolicies
处理配置的保留策略。
RebuildSelectedStoreIndexes
重建所有用于重建的全文索引。
RebuildStoreIndex
重建给定存档文件夹的搜索索引。
参数
名称 | 类型 | 描述 |
---|---|---|
id | number | 归档存储的唯一标识。 |
folder | string | 文件夹名称的名称。 |
RecoverStore
根据恢复记录重新创建损坏的Firebird数据库。存档存储必须已升级到最新版本,并且恢复记录一定不能损坏。存档存储必须处于“已禁用”或“ 错误”状态。
参数
名称 | 类型 | 描述 |
---|---|---|
id | number | 归档存储的唯一标识。 |
recoverDeletedMessages | bool(可选) | 定义是否恢复已删除的消息。 |
当recoveryDeletedMessages参数设置为true时,仅可以恢复恢复记录中仍然有剩余的已删除消息。当存档存储已使用CompactStore压缩或恢复记录文件已增长到其自动压缩大小8 MiB时,这些剩余物可能已被删除,删除的消息也无法恢复。
RecreateRecoveryRecords
重新创建存档存储的损坏的恢复记录。使用VerifyStore来验证恢复记录的状态。不能用于将其内容存储在数据库中的外部存档存储。
参数
名称 | 类型 | 描述 |
---|---|---|
id | number | 归档存储的唯一标识。 |
RefreshAllStoreStatistics
刷新所有档案存储的统计信息。
RenameJob
重命名作业。
参数
名称 | 类型 | 描述 |
---|---|---|
id | number(可选) | 要重命名的作业的唯一标识符。 |
name | string(可选) | 新工作名称。 |
RenameStore
重命名档案存储
参数
名称 | 类型 | 描述 |
---|---|---|
id | number | 归档存储的唯一标识。 |
name | string | 归档存储的新名称。 |
RenameUser
重命名MailStore用户。
参数
名称 | 类型 | 描述 |
---|---|---|
oldUserName | string | 旧用户名。 |
newUserName | string | 新用户名。 |
RenewMasterKey
更新用于加密加密密钥的主密钥。
RepairStoreDatabase
尝试解决存档存储数据库的某些问题(例如,缺少数据库索引)。
参数
名称 | 类型 | 描述 |
---|---|---|
id | number | 归档存储的唯一标识。 |
RetryOpenStores
重试打开以前失败的商店。
RunJobAsync
运行现有作业。
参数
名称 | 类型 | 描述 |
---|---|---|
id | number | 要运行的作业的标识符。 |
RunProfile
运行现有的归档或导出配置文件。此命令只能启动在服务器端执行的配置文件。这些都是在MailStore客户端的“电子邮件服务器”下列出的配置文件。可以使用MailStoreCmd以及命令import-execute和export-execute来启动客户端概要文件。
参数
名称 | 类型 | 描述 |
---|---|---|
id | number | 唯一的个人资料ID。 |
RunTemporaryProfile
运行一个临时/不存在的配置文件。此命令只能启动在服务器端执行的配置文件。这些都是在MailStore客户端的“电子邮件服务器”下列出的配置文件。
参数
名称 | 类型 | 描述 |
---|---|---|
properties | json | 配置文件属性。 |
raw | bool | 目前仅支持“ true”。 |
参数值
properties
若要接收可用的配置文件属性,请通过MailStore客户端创建所需类型的配置文件,并使用GetProfiles方法接收支持的值。
SelectAllStoreIndexesForRebuild
选择所有全文索引进行重建。
SendStatusReport
将状态报告发送给给定的收件人。
参数
名称 | 类型 | 描述 |
---|---|---|
timespan | string | 状态报告涵盖的时间跨度。 |
timeZoneId | string | 日期应转换为的时区的ID,例如$ Local,它表示操作系统的时区。 |
recipients | string | 逗号分隔的将接收状态报告的收件人列表。 |
使用API命令GetTimeZones检索所有可用时区及其ID的列表。
参数值
时间跨度
名称 | 描述 |
---|---|
today | 状态报告发送的日期。 |
yesterday | 状态报告发送的前一天。 |
thisweek | 状态报告发送的星期。 |
lastweek | 状态报告发送的前一周。 |
thismonth | 状态报告发送的月份。 |
lastmonth | 状态报告发送前的一个月。 |
SetComplianceConfiguration
设置合规性配置设置。
参数
名称 | 类型 | 描述 |
---|---|---|
config | json | 合规性配置。 |
参数值
配置
使用GetComplianceConfiguration接收支持的值。
设置对象示例:
{
"adminEmailPreviewEnabled": true,
"legalHoldEnabled": false,
"passwordPolicyEnabled": true,
"logSuccessfulUserActivities": [
"AdminRestored",
"ComplianceChangeSettings",
"FileGroupAttach",
"FileGroupCreate",
"FileGroupDetach",
"FileGroupRename",
"FileGroupSetProperties",
"FileGroupSetRequestedState",
"ProfileChangeUserName",
"UserAdd",
"UserDelete",
"UserRename",
"UserSetFolderAccess",
"UserSetMappings",
"UserUpdate"
]
}
SetDirectoryServicesConfiguration
设置目录服务配置设置。
参数
名称 | 类型 | 描述 |
---|---|---|
config | json | 目录服务配置。 |
参数值
config
使用GetDirectoryServicesConfiguration接收支持的值。
SetJobEnabled
设置作业的启用状态。
参数
名称 | 类型 | 描述 |
---|---|---|
id | number(可选) | 要修改的作业的唯一标识符。 |
enabled | bool(可选) | 启用属性的布尔值。 |
SetJobSchedule
修改作业计划。
参数
名称 | 类型 | 描述 |
---|---|---|
id | number | 要修改的作业的唯一标识符。 |
timeZoneId | string | 日期应转换为的时区的ID,例如$ Local,它表示操作系统的时区。 |
date | string(可选) | 日期时间字符串(YYYY-MM-DDThh:mm:ss),用于一次运行作业。 |
interval | number(可选) | 运行作业的间隔。 |
time | string(可选) | 运行作业的时间。如果没有其他参数,则意味着每天执行。 |
dayOfWeek | string(可选) | 每周的工作日。还需要参数“时间”。 |
dayOfMonth | string(可选) | 一个月中的某天去工作。还需要参数“时间”。dayOfWeek可以选择用于进一步定义。 |
使用API命令GetTimeZones检索所有可用时区及其ID的列表。
参数值
dayOfWeek
名称 | 描述 |
---|---|
Sunday | 星期日 |
Monday | 星期一 |
Tuesday | 星期二 |
Wednesday | 星期三 |
Thursday | 星期四 |
Friday | 星期五 |
Saturday | 星期六 |
dayOfMonth
名称 | 描述 |
---|---|
1 to 31 | 月份的数字表示形式。 |
Last | 一个月的最后一天。 |
间隔
名称 | 描述 |
---|---|
5 | 每5分钟一次。 |
10 | 每10分钟一次。 |
15 | 每15分钟一次。 |
20 | 每20分钟一次。 |
30 | 每30分钟一次。 |
60 | 每隔一小时。 |
120 | 每2小时。 |
180 | 每3小时。 |
260 | 每4小时。 |
360 | 每6小时。 |
720 | 每12小时。 |
SetRetentionPolicies
设置保留政策。
参数
名称 | 类型 | 描述 |
---|---|---|
config | json | 保留策略配置。 |
要获取示例策略,请使用客户端手动创建保留策略。然后使用API命令GetRetentionPolicies检索json值。
SetSmtpSettings
设置SMTP配置。
参数
名称 | 类型 | 描述 |
---|---|---|
settings | json | SMTP配置。 |
参数值
settings
设置对象示例:
{
"hostname": "mail.example.com",
"port": 587,
"protocol": "SMTP-TLS",
"ignoreSslPolicyErrors": false,
"authenticationRequired": true,
"username": "sending.user@example.com",
"password": "userpassword",
"fromDisplayName": "Sending User",
"fromEmailAddress": "sending.user@example.com",
"recipientEmailAddress": "administrator@example.com"
}
SetStoreProperties
设置档案存储的属性。
参数
名称 | 类型 | 描述 |
---|---|---|
id | number | 设置档案存储的属性。 |
type | string(可选) | |
databaseName | string(可选) | Microsoft SQL Server或PostgreSQL服务器上的数据库名称。 |
databasePath | string(可选) | 存储数据库文件夹信息和电子邮件元数据的目录的路径。 |
contentPath | string(可选) | 存储电子邮件标题和内容的目录的路径。 |
indexPath | string(可选) | 全文搜索索引存储目录的路径。 |
serverName | string(可选) | Microsoft SQL Server或PostgreSQL服务器的名称。 |
userName | string(可选) | 用于访问Microsoft SQL Server或PostgreSQL服务器的用户名。 |
password | string(可选) | 访问Microsoft SQL Server或PostgreSQL服务器的密码。 |
参数值
type
名称 | 描述 |
---|---|
FileSystemInternal | 基于高级文件系统的存档存储。 |
SQLServer | 基于Microsoft SQL Server的存档存储。 |
PostgreSQL | 基于PostgreSQL服务器的存档存储。 |
SetStoreRequestedState
设置档案存储的状态。
参数
名称 | 类型 | 描述 |
---|---|---|
id | number | 归档存储的唯一标识。 |
requestedState | string(可选) | 附加后档案存储的状态。 |
参数值
requestState
名称 | 描述 |
---|---|
current | 与“普通”相同,但新消息将存储在设置为“当前”的存档存储中。 |
normal | 归档存储的内容对用户可用,如果用户具有适当的权限,则可以对其进行修改。 |
writeProtected | 用户可以使用受写保护的存档存储的内容,但不能对其进行修改(例如,删除或移动邮件,重命名或移动文件夹) |
disabled | 禁用的归档存储未使用,但实例仍然知道它们的存在。因此,该内容对用户不可用。 |
SetUserAuthentication
设置MailStore用户的身份验证设置。
参数
名称 | 类型 | 描述 |
---|---|---|
userName | string | MailStore用户的用户名。 |
authentication | string | 身份验证方法。“集成”或“ directoryServices”。 |
SetUserDistinguishedName
设置MailStore用户的LDAP专有名称。
参数
名称 | 类型 | 描述 |
---|---|---|
userName | string | MailStore用户的用户名。 |
distinguishedName | string(可选) | LDAP DN字符串。 |
SetUserEmailAddresses
设置MailStore用户的电子邮件地址。
参数
名称 | 类型 | 描述 |
---|---|---|
userName | string | MailStore用户的用户名。 |
emailAddresses | string(可选) | 电子邮件地址列表。 |
SetUserFullName
设置MailStore用户的全名。
参数
名称 | 类型 | 描述 |
---|---|---|
userName | string | MailStore用户的用户名。 |
fullName | string(可选) | MailStore用户的全名。 |
SetUserPassword
设置MailStore用户密码。
参数
名称 | 类型 | 描述 |
---|---|---|
userName | string | MailStore用户的用户名。 |
password | string | MailStore用户的密码。 |
SetUserPop3UserNames
设置MailStore用户的POP3用户名。
参数
名称 | 类型 | 描述 |
---|---|---|
userName | string | MailStore用户的用户名。 |
pop3UserNames | string(可选) | 逗号分隔的POP3用户名列表。 |
SetUserPrivileges
设置MailStore用户的权限。
参数
名称 | 类型 | 描述 |
---|---|---|
userName | string | MailStore用户的用户名。 |
privileges | string | 以逗号分隔的特权列表。 |
参数值
privileges
名称 | 描述 |
---|---|
none | 没有授予用户全局特权。如果指定,则此值必须是列表中的唯一值。 |
admin | 授予用户管理员权限。如果指定,则此值必须是列表中的唯一值。 |
changePassword | 用户可以登录到MailStore服务器。 |
archive | 用户可以更改自己的MailStore服务器密码。仅当身份验证设置为Integrated时,这才有意义。 |
modifyArchiveProfiles | 用户可以运行归档配置文件。 |
modifyArchiveProfiles | 用户可以创建,修改和删除归档配置文件。 |
export | 用户可以运行导出配置文件。 |
modifyExportProfiles | 用户可以创建,修改和删除导出配置文件。 |
delete | 用户可以删除消息。请注意,非管理员用户只能删除已被授予删除访问权限的文件夹中的邮件。此外,合规性设置可能会生效,即使已被授予权限,管理员和用户也无法删除消息。 |
SetUserPrivilegesOnFolder
为MailStore用户设置文件夹权限。
参数
名称 | 类型 | 描述 |
---|---|---|
userName | 串 | MailStore用户的用户名。 |
folder | 串 | 文件夹名称。 |
privileges | 串 | 以逗号分隔的文件夹特权列表。 |
参数值
privileges
名称 | 描述 |
---|---|
none | 拒绝用户访问指定的文件夹。如果指定,则此值必须是列表中的唯一值。这将有效删除指定文件夹上的所有特权。 |
read | 授予用户对指定文件夹的读取访问权限。 |
write | 授予用户对指定文件夹的写访问权。可以在归档中移动消息。 |
delete | 授予用户对指定文件夹的删除访问权限。 |
SyncUsersWithDirectoryServices
将MailStore实例的用户与目录服务同步。
参数
名称 | 类型 | 描述 |
---|---|---|
dryRun | 布尔值(可选) | 仅模拟同步。 |
TestSmtpSettings
测试当前的SMTP配置。
UnlockStore
解锁外部档案存储。如果从外部MailStore安装附加了档案存储,则可以使用此方法来解锁该档案存储。
参数
名称 | 类型 | 描述 |
---|---|---|
id | number | 要解锁的档案存储的唯一ID。 |
passphrase | string | 外部MailStore安装的产品密钥或恢复密钥。 |
UpgradeStore
将存档存储从MailStore Server 5或更早版本升级到当前格式。
参数
名称 | 类型 | 描述 |
---|---|---|
id | number | 归档存储的唯一标识。 |
VerifyStore
验证存档存储的一致性。
参数
名称 | 类型 | 描述 |
---|---|---|
id | number | 要验证的档案存储的唯一标识符。 |
includeIndexes | bool | 定义是否也验证搜索索引。 |
VerifyStores
验证所有归档存储的一致性。
参数
名称 | 类型 | 描述 |
---|---|---|
includeIndexes | bool | 定义是否也验证搜索索引。 |