@marxlnfcs/wildduck-api
Version:
Provides a client to interact with the wildduck api
1,362 lines (1,361 loc) • 50.7 kB
TypeScript
export type IWildduckApiAddressLimits = components["schemas"]["AddressLimits"];
export type IWildduckApiAutoreplyInfo = components["schemas"]["AutoreplyInfo"];
export type IWildduckApiAutoreply = components["schemas"]["Autoreply"];
export type IWildduckApiLastUse = components["schemas"]["LastUse"];
export type IWildduckApiContentType = components["schemas"]["ContentType"];
export type IWildduckApiDnsTxt = components["schemas"]["DnsTxt"];
export type IWildduckApiQuery = components["schemas"]["Query"];
export type IWildduckApiAction = components["schemas"]["Action"];
export type IWildduckApiSpecialUse = components["schemas"]["SpecialUse"];
export type IWildduckApiEnvelope = components["schemas"]["Envelope"];
export type IWildduckApiRcpt = components["schemas"]["Rcpt"];
export type IWildduckApiAddress = components["schemas"]["Address"];
export type IWildduckApiAddressOptionalName = components["schemas"]["AddressOptionalName"];
export type IWildduckApiList = components["schemas"]["List"];
export type IWildduckApiOutbound = components["schemas"]["Outbound"];
export type IWildduckApiOutboundQueueEntry = components["schemas"]["OutboundQueueEntry"];
export type IWildduckApiAttachments = components["schemas"]["Attachments"];
export type IWildduckApiVerificationResults = components["schemas"]["VerificationResults"];
export type IWildduckApiTls = components["schemas"]["Tls"];
export type IWildduckApiFiles = components["schemas"]["Files"];
export type IWildduckApiHeader = components["schemas"]["Header"];
export type IWildduckApiAttachmentsUpload = components["schemas"]["AttachmentsUpload"];
export type IWildduckApiReferenceWithAttachments = components["schemas"]["ReferenceWithAttachments"];
export type IWildduckApiMessage = components["schemas"]["Message"];
export type IWildduckApiForwarded = components["schemas"]["Forwarded"];
export type IWildduckApiReference = components["schemas"]["Reference"];
export type IWildduckApiEnvelopeUpload = components["schemas"]["EnvelopeUpload"];
export type IWildduckApiMessageWithQueueId = components["schemas"]["MessageWithQueueId"];
export type IWildduckApiKeyInfo = components["schemas"]["KeyInfo"];
export type IWildduckApiUserLimits = components["schemas"]["UserLimits"];
export type IWildduckApiQuota = components["schemas"]["Quota"];
export type IWildduckApiRecipients = components["schemas"]["Recipients"];
export type IWildduckApiFilters = components["schemas"]["Filters"];
export type IWildduckApiForwards = components["schemas"]["Forwards"];
export type IWildduckApiReceived = components["schemas"]["Received"];
export type IWildduckApiImapUpload = components["schemas"]["ImapUpload"];
export type IWildduckApiImapDownload = components["schemas"]["ImapDownload"];
export type IWildduckApiPop3Download = components["schemas"]["Pop3Download"];
export type IWildduckApiImapMaxConnections = components["schemas"]["ImapMaxConnections"];
export type IWildduckApiMailboxes = components["schemas"]["Mailboxes"];
export type IWildduckApiSuccessResponse = components["schemas"]["SuccessResponse"];
export type IWildduckApiUploadMessageRequest = components["schemas"]["UploadMessageRequest"];
export type IWildduckApiForwardStoredMessageRequest = components["schemas"]["ForwardStoredMessageRequest"];
export type IWildduckApiUploadMessageResponse = components["schemas"]["UploadMessageResponse"];
export type IWildduckApiForwardStoredMessageResponse = components["schemas"]["ForwardStoredMessageResponse"];
export type IWildduckApiUploadFileResponse = components["schemas"]["UploadFileResponse"];
export type IWildduckApiGetForwardedAddressResponse = components["schemas"]["GetForwardedAddressResponse"];
export type IWildduckApiGetUserAddressResponse = components["schemas"]["GetUserAddressResponse"];
export type IWildduckApiResolveAddressResponse = components["schemas"]["ResolveAddressResponse"];
export type IWildduckApiGetAddressesResponse = components["schemas"]["GetAddressesResponse"];
export type IWildduckApiGetUserAddressesResponse = components["schemas"]["GetUserAddressesResponse"];
export type IWildduckApiCreateUserAddressResponse = components["schemas"]["CreateUserAddressResponse"];
export type IWildduckApiGetUserAddressesregisterResponse = components["schemas"]["GetUserAddressesregisterResponse"];
export type IWildduckApiCreateForwardedAddressResponse = components["schemas"]["CreateForwardedAddressResponse"];
export type IWildduckApiGetASPResponse = components["schemas"]["GetASPResponse"];
export type IWildduckApiGetASPsResponse = components["schemas"]["GetASPsResponse"];
export type IWildduckApiCreateASPResponse = components["schemas"]["CreateASPResponse"];
export type IWildduckApiGetArchivedMessagesResponse = components["schemas"]["GetArchivedMessagesResponse"];
export type IWildduckApiRestoreMessageResponse = components["schemas"]["RestoreMessageResponse"];
export type IWildduckApiGetAuditResponse = components["schemas"]["GetAuditResponse"];
export type IWildduckApiCreateAuditResponse = components["schemas"]["CreateAuditResponse"];
export type IWildduckApiAuthenticateResponse = components["schemas"]["AuthenticateResponse"];
export type IWildduckApiGetAuthlogResponse = components["schemas"]["GetAuthlogResponse"];
export type IWildduckApiGetAuthlogEventResponse = components["schemas"]["GetAuthlogEventResponse"];
export type IWildduckApiGetAutoreplyResponse = components["schemas"]["GetAutoreplyResponse"];
export type IWildduckApiGetDkimKeyResponse = components["schemas"]["GetDkimKeyResponse"];
export type IWildduckApiGetDkimKeysResponse = components["schemas"]["GetDkimKeysResponse"];
export type IWildduckApiGetTLSCertsResponse = components["schemas"]["GetTLSCertsResponse"];
export type IWildduckApiUpdateDkimKeyResponse = components["schemas"]["UpdateDkimKeyResponse"];
export type IWildduckApiUpdateTLSCertResponse = components["schemas"]["UpdateTLSCertResponse"];
export type IWildduckApiResolveIdResponse = components["schemas"]["ResolveIdResponse"];
export type IWildduckApiRecoverInfoResponse = components["schemas"]["RecoverInfoResponse"];
export type IWildduckApiGetAllowedDomainResponse = components["schemas"]["GetAllowedDomainResponse"];
export type IWildduckApiCreateAllowedDomainResponse = components["schemas"]["CreateAllowedDomainResponse"];
export type IWildduckApiGetBlockedDomainResponse = components["schemas"]["GetBlockedDomainResponse"];
export type IWildduckApiCreateBlockedDomainResponse = components["schemas"]["CreateBlockedDomainResponse"];
export type IWildduckApiGetDomainAliasResponse = components["schemas"]["GetDomainAliasResponse"];
export type IWildduckApiGetDomainAliasesResponse = components["schemas"]["GetDomainAliasesResponse"];
export type IWildduckApiCreateDomainAliasResponse = components["schemas"]["CreateDomainAliasResponse"];
export type IWildduckApiGetFilterResponse = components["schemas"]["GetFilterResponse"];
export type IWildduckApiUpdateFilterResponse = components["schemas"]["UpdateFilterResponse"];
export type IWildduckApiGetAllFiltersResponse = components["schemas"]["GetAllFiltersResponse"];
export type IWildduckApiGetFiltersResponse = components["schemas"]["GetFiltersResponse"];
export type IWildduckApiGetMailboxResponse = components["schemas"]["GetMailboxResponse"];
export type IWildduckApiGetMailboxesResponse = components["schemas"]["GetMailboxesResponse"];
export type IWildduckApiCreateMailboxResponse = components["schemas"]["CreateMailboxResponse"];
export type IWildduckApiGetMessageResponse = components["schemas"]["GetMessageResponse"];
export type IWildduckApiDeleteMessagesInMailboxResponse = components["schemas"]["DeleteMessagesInMailboxResponse"];
export type IWildduckApiGetMessagesResponse = components["schemas"]["GetMessagesResponse"];
export type IWildduckApiUpdateMessageResponse = components["schemas"]["UpdateMessageResponse"];
export type IWildduckApiSearchMessagesResponse = components["schemas"]["SearchMessagesResponse"];
export type IWildduckApiSubmitStoredMessageResponse = components["schemas"]["SubmitStoredMessageResponse"];
export type IWildduckApiGetFilesResponse = components["schemas"]["GetFilesResponse"];
export type IWildduckApiSubmitMessageResponse = components["schemas"]["SubmitMessageResponse"];
export type IWildduckApiSetupTotp2FAResponse = components["schemas"]["SetupTotp2FAResponse"];
export type IWildduckApiGetUserResponse = components["schemas"]["GetUserResponse"];
export type IWildduckApiGetUsersResponse = components["schemas"]["GetUsersResponse"];
export type IWildduckApiCreateUserResponse = components["schemas"]["CreateUserResponse"];
export type IWildduckApiRecalculateQuotaResponse = components["schemas"]["RecalculateQuotaResponse"];
export type IWildduckApiResetUserPasswordResponse = components["schemas"]["ResetUserPasswordResponse"];
export type IWildduckApiGetWebhooksResponse = components["schemas"]["GetWebhooksResponse"];
export type IWildduckApiCreateWebhookResponse = components["schemas"]["CreateWebhookResponse"];
export type IWildduckApiGetSettingResponse = components["schemas"]["GetSettingResponse"];
export type IWildduckApiGetSettingsResponse = components["schemas"]["GetSettingsResponse"];
export type IWildduckApiCreateSettingResponse = components["schemas"]["CreateSettingResponse"];
export type IWildduckApiUpdateForwardedAddressRequest = components["schemas"]["UpdateForwardedAddressRequest"];
export type IWildduckApiUpdateUserAddressRequest = components["schemas"]["UpdateUserAddressRequest"];
export type IWildduckApiCreateUserAddressRequest = components["schemas"]["CreateUserAddressRequest"];
export type IWildduckApiCreateForwardedAddressRequest = components["schemas"]["CreateForwardedAddressRequest"];
export type IWildduckApiRenameDomainRequest = components["schemas"]["RenameDomainRequest"];
export type IWildduckApiCreateASPRequest = components["schemas"]["CreateASPRequest"];
export type IWildduckApiRestoreMessageRequest = components["schemas"]["RestoreMessageRequest"];
export type IWildduckApiRestoreMessagesRequest = components["schemas"]["RestoreMessagesRequest"];
export type IWildduckApiCreateAuditRequest = components["schemas"]["CreateAuditRequest"];
export type IWildduckApiAuthenticateRequest = components["schemas"]["AuthenticateRequest"];
export type IWildduckApiUpdateAutoreplyRequest = components["schemas"]["UpdateAutoreplyRequest"];
export type IWildduckApiUpdateDkimKeyRequest = components["schemas"]["UpdateDkimKeyRequest"];
export type IWildduckApiUpdateTLSCertRequest = components["schemas"]["UpdateTLSCertRequest"];
export type IWildduckApiCreateAllowedDomainRequest = components["schemas"]["CreateAllowedDomainRequest"];
export type IWildduckApiCreateBlockedDomainRequest = components["schemas"]["CreateBlockedDomainRequest"];
export type IWildduckApiCreateDomainAliasRequest = components["schemas"]["CreateDomainAliasRequest"];
export type IWildduckApiUpdateFilterRequest = components["schemas"]["UpdateFilterRequest"];
export type IWildduckApiCreateFilterRequest = components["schemas"]["CreateFilterRequest"];
export type IWildduckApiUpdateMailboxRequest = components["schemas"]["UpdateMailboxRequest"];
export type IWildduckApiCreateMailboxRequest = components["schemas"]["CreateMailboxRequest"];
export type IWildduckApiUpdateMessageRequest = components["schemas"]["UpdateMessageRequest"];
export type IWildduckApiSubmitStoredMessageRequest = components["schemas"]["SubmitStoredMessageRequest"];
export type IWildduckApiSubmitMessageRequest = components["schemas"]["SubmitMessageRequest"];
export type IWildduckApiCheckTotp2FARequest = components["schemas"]["CheckTotp2FARequest"];
export type IWildduckApiEnableCustom2FARequest = components["schemas"]["EnableCustom2FARequest"];
export type IWildduckApiEnableTotp2FARequest = components["schemas"]["EnableTotp2FARequest"];
export type IWildduckApiSetupTotp2FARequest = components["schemas"]["SetupTotp2FARequest"];
export type IWildduckApiUpdateUserRequest = components["schemas"]["UpdateUserRequest"];
export type IWildduckApiCreateUserRequest = components["schemas"]["CreateUserRequest"];
export type IWildduckApiLogoutUserRequest = components["schemas"]["LogoutUserRequest"];
export type IWildduckApiUserRestoreRequest = components["schemas"]["UserRestoreRequest"];
export type IWildduckApiResetUserPasswordRequest = components["schemas"]["ResetUserPasswordRequest"];
export type IWildduckApiCreateWebhookRequest = components["schemas"]["CreateWebhookRequest"];
export type IWildduckApiCreateSettingRequest = components["schemas"]["CreateSettingRequest"];
export type IWildduckApiGetAddressesResult = components["schemas"]["GetAddressesResult"];
export type IWildduckApiGetUserAddressesResult = components["schemas"]["GetUserAddressesResult"];
export type IWildduckApiGetUserAddressesregisterResult = components["schemas"]["GetUserAddressesregisterResult"];
export type IWildduckApiGetASPsResult = components["schemas"]["GetASPsResult"];
export type IWildduckApiGetArchivedMessagesResult = components["schemas"]["GetArchivedMessagesResult"];
export type IWildduckApiGetAuthlogResult = components["schemas"]["GetAuthlogResult"];
export type IWildduckApiGetDkimKeysResult = components["schemas"]["GetDkimKeysResult"];
export type IWildduckApiGetTLSCertResult = components["schemas"]["GetTLSCertResult"];
export type IWildduckApiGetAllowedDomainResult = components["schemas"]["GetAllowedDomainResult"];
export type IWildduckApiGetBlockedDomainResult = components["schemas"]["GetBlockedDomainResult"];
export type IWildduckApiGetDomainAliasesResult = components["schemas"]["GetDomainAliasesResult"];
export type IWildduckApiGetAllFiltersResult = components["schemas"]["GetAllFiltersResult"];
export type IWildduckApiGetFiltersResult = components["schemas"]["GetFiltersResult"];
export type IWildduckApiGetMailboxesResult = components["schemas"]["GetMailboxesResult"];
export type IWildduckApiGetMessagesResult = components["schemas"]["GetMessagesResult"];
export type IWildduckApiGetFilesResult = components["schemas"]["GetFilesResult"];
export type IWildduckApiGetUsersResult = components["schemas"]["GetUsersResult"];
export type IWildduckApiGetWebhooksResult = components["schemas"]["GetWebhooksResult"];
export type IWildduckApiAspScopes = components["schemas"]["AspScopes"];
export type IWildduckApiDisabledScopes = components["schemas"]["DisabledScopes"];
export type IWildduckApiOrder = components["schemas"]["Order"];
export type IWildduckApiGetSettingsResult = components["schemas"]["GetSettingsResult"];
interface components {
schemas: {
AddressLimits: {
forwards: components["schemas"]["Forwards"];
};
AutoreplyInfo: {
status: boolean;
name: string;
subject: string;
text: string;
html: string;
};
Autoreply: {
status?: boolean;
start?: string;
end?: string;
name?: string;
subject?: string;
text?: string;
html?: string;
};
LastUse: {
time: string;
event: string;
};
ContentType: {
value: string;
params: {
[key: string]: unknown;
};
};
DnsTxt: {
name: string;
value: string;
};
Query: {
from?: string;
to?: string;
subject?: string;
listId?: string;
text?: string;
ha?: boolean;
size?: number;
};
Action: {
seen?: boolean;
flag?: boolean;
delete?: boolean;
spam?: boolean;
mailbox?: string;
targets?: string[];
};
SpecialUse: "Drafts" | "Junk" | "Sent" | "Trash";
Envelope: {
from: string;
rcpt: components["schemas"]["Rcpt"];
};
Rcpt: {
value: string;
formatted: string;
};
Address: {
name: string;
address: string;
};
AddressOptionalName: {
name?: string;
address: string;
};
List: {
id: string;
unsubscribe: string;
};
Outbound: {
queueId: string;
entries: components["schemas"]["OutboundQueueEntry"][];
};
OutboundQueueEntry: {
seq: string;
recipient: string;
sendingZone?: string;
queued?: string;
};
Attachments: {
id: string;
hash?: string;
filename: string;
contentType: string;
disposition: string;
transferEncoding: string;
related: boolean;
sizeKb: number;
};
VerificationResults: {
tls: components["schemas"]["Tls"];
spf: {
[key: string]: unknown;
};
dkim: {
[key: string]: unknown;
};
};
Tls: {
name: {
[key: string]: unknown;
};
version: {
[key: string]: unknown;
};
};
Files: {
id: string;
filename: string;
contentType: string;
size: number;
};
Header: {
key: string;
value: string;
};
AttachmentsUpload: {
content: string;
filename?: string;
contentType?: string;
cid?: string;
};
ReferenceWithAttachments: {
mailbox: string;
id: number;
action: string;
attachments: string[];
};
Message: {
id: number;
mailbox: string;
size?: number;
};
Forwarded: {
seq: string;
type: string;
value: string;
};
Reference: {
mailbox: string;
id: number;
action: string;
};
EnvelopeUpload: {
from?: components["schemas"]["AddressOptionalName"];
to?: components["schemas"]["AddressOptionalName"][];
};
MessageWithQueueId: {
mailbox: string;
id: number;
queueId: string;
};
KeyInfo: {
name: string;
address: string;
fingerprint: string;
};
UserLimits: {
quota: components["schemas"]["Quota"];
recipients: components["schemas"]["Recipients"];
filters?: components["schemas"]["Filters"];
forwards: components["schemas"]["Forwards"];
received: components["schemas"]["Received"];
imapUpload: components["schemas"]["ImapUpload"];
imapDownload: components["schemas"]["ImapDownload"];
pop3Download: components["schemas"]["Pop3Download"];
imapMaxConnections?: components["schemas"]["ImapMaxConnections"];
};
Quota: {
allowed: number;
used: number;
};
Recipients: {
allowed: number;
used: number;
ttl: number;
};
Filters: {
allowed: number;
used: number;
};
Forwards: {
allowed: number;
used: number;
ttl: number;
};
Received: {
allowed: number;
used: number;
ttl: number;
};
ImapUpload: {
allowed: number;
used: number;
ttl: number;
};
ImapDownload: {
allowed: number;
used: number;
ttl: number;
};
Pop3Download: {
allowed: number;
used: number;
ttl: number;
};
ImapMaxConnections: {
allowed: number;
used: number;
};
Mailboxes: {
sent?: string;
junk?: string;
drafts?: string;
trash?: string;
};
SuccessResponse: {
success: boolean;
};
UploadMessageRequest: {
unseen?: boolean;
draft?: boolean;
flagged?: boolean;
raw?: string;
from?: components["schemas"]["Address"];
to?: components["schemas"]["AddressOptionalName"][];
cc?: components["schemas"]["AddressOptionalName"][];
bcc?: components["schemas"]["AddressOptionalName"][];
subject?: string;
text?: string;
html?: string;
headers?: components["schemas"]["Header"][];
files?: string[];
attachments?: components["schemas"]["AttachmentsUpload"][];
metaData?: {
[key: string]: unknown;
} | string;
reference?: components["schemas"]["ReferenceWithAttachments"];
bimi?: {
domain: string;
selector?: string;
};
replacePrevious?: {
mailbox?: string;
id: number;
};
sess?: string;
ip?: string;
};
ForwardStoredMessageRequest: {
target?: number;
addresses?: string[];
};
UploadMessageResponse: {
success: boolean;
message: components["schemas"]["Message"];
previousDeleted?: boolean;
};
ForwardStoredMessageResponse: {
success: boolean;
queueId: string;
forwarded: components["schemas"]["Forwarded"][];
};
UploadFileResponse: {
success: boolean;
id: {
[key: string]: unknown;
};
};
GetForwardedAddressResponse: {
success: boolean;
id: string;
address: string;
name: string;
targets: string[];
limits: components["schemas"]["AddressLimits"];
autoreply: components["schemas"]["AutoreplyInfo"];
created: string;
tags: string[];
forwardedDisabled: boolean;
};
GetUserAddressResponse: {
success: boolean;
id: string;
name: string;
address: string;
tags: string[];
metaData?: {
[key: string]: unknown;
};
internalData?: {
[key: string]: unknown;
};
main: boolean;
created: string;
};
ResolveAddressResponse: {
success: boolean;
id: string;
address: string;
name: string;
user: string;
targets: string[];
limits: components["schemas"]["AddressLimits"];
autoreply: components["schemas"]["AutoreplyInfo"];
tags: string[];
created: string;
};
GetAddressesResponse: {
success: boolean;
total: number;
page: number;
previousCursor: string;
nextCursor: string;
results: components["schemas"]["GetAddressesResult"][];
};
GetUserAddressesResponse: {
success: boolean;
results: components["schemas"]["GetUserAddressesResult"][];
};
CreateUserAddressResponse: {
success: boolean;
id: string;
};
GetUserAddressesregisterResponse: {
success: boolean;
results: components["schemas"]["GetUserAddressesregisterResult"][];
};
CreateForwardedAddressResponse: {
success: boolean;
id: string;
};
GetASPResponse: {
success: boolean;
id: string;
description: string;
scopes: components["schemas"]["AspScopes"][];
lastUse: components["schemas"]["LastUse"];
created: string;
};
GetASPsResponse: {
success: boolean;
results: components["schemas"]["GetASPsResult"][];
};
CreateASPResponse: {
success: boolean;
id: string;
password: string;
mobileconfig: string;
};
GetArchivedMessagesResponse: {
success: boolean;
total: number;
page: number;
previousCursor: string;
nextCursor: string;
results: components["schemas"]["GetArchivedMessagesResult"][];
};
RestoreMessageResponse: {
success: boolean;
mailbox: string;
id: number;
};
GetAuditResponse: {
success: boolean;
user: string;
start?: string;
end?: string;
expires: string;
};
CreateAuditResponse: {
success: boolean;
id: string;
};
AuthenticateResponse: {
success: boolean;
id: string;
username: string;
scope: string;
require2fa: string[];
requirePasswordChange: boolean;
token?: string;
};
GetAuthlogResponse: {
success: boolean;
total: number;
page: number;
previousCursor: string;
nextCursor: string;
results: components["schemas"]["GetAuthlogResult"][];
};
GetAuthlogEventResponse: {
success: boolean;
id: string;
action: string;
result: string;
sess?: string;
ip?: string;
created: string;
};
GetAutoreplyResponse: {
success: boolean;
status: boolean;
name: string;
subject: string;
html: string;
text: string;
start: string;
end: string;
};
GetDkimKeyResponse: {
success: boolean;
id: string;
domain: string;
selector: string;
description: string;
fingerprint: string;
publicKey: string;
dnsTxt: components["schemas"]["DnsTxt"];
created: string;
};
GetDkimKeysResponse: {
success: boolean;
total: number;
page: number;
previousCursor: string;
nextCursor: string;
results: components["schemas"]["GetDkimKeysResult"][];
};
GetTLSCertsResponse: {
success: boolean;
total: number;
page: number;
previousCursor: string;
nextCursor: string;
results: components["schemas"]["GetTLSCertResult"][];
};
UpdateDkimKeyResponse: {
success: boolean;
id: string;
domain: string;
selector: string;
description: string;
fingerprint: string;
publicKey: string;
dnsTxt: components["schemas"]["DnsTxt"];
};
UpdateTLSCertResponse: {
success: boolean;
id: string;
servername: string;
description?: string;
fingerprint: string;
expires?: string;
altNames?: string[];
};
ResolveIdResponse: {
success: boolean;
id: string;
};
RecoverInfoResponse: {
success: boolean;
user: string;
username: string;
storageUsed: number;
tags: string[];
deleted: string;
recoverableAddresses: string[];
};
GetAllowedDomainResponse: {
success: boolean;
results: components["schemas"]["GetAllowedDomainResult"][];
};
CreateAllowedDomainResponse: {
success: boolean;
id: string;
};
GetBlockedDomainResponse: {
success: boolean;
results: components["schemas"]["GetBlockedDomainResult"][];
};
CreateBlockedDomainResponse: {
success: boolean;
id: string;
};
GetDomainAliasResponse: {
success: boolean;
id: string;
alias: string;
domain: string;
created: string;
};
GetDomainAliasesResponse: {
success: boolean;
total: number;
page: number;
previousCursor: string;
nextCursor: string;
results: components["schemas"]["GetDomainAliasesResult"][];
};
CreateDomainAliasResponse: {
success: boolean;
id: string;
};
GetFilterResponse: {
success: boolean;
id: string;
name: string;
query: components["schemas"]["Query"];
action: components["schemas"]["Action"];
disabled: boolean;
};
UpdateFilterResponse: {
success: boolean;
id: string;
};
GetAllFiltersResponse: {
success: boolean;
total: number;
page: number;
previousCursor: string;
nextCursor: string;
results: components["schemas"]["GetAllFiltersResult"][];
};
GetFiltersResponse: {
success: boolean;
limits: {
allowed?: number;
used?: number;
};
results: components["schemas"]["GetFiltersResult"][];
};
GetMailboxResponse: {
success: boolean;
id: string;
name: string;
path: string;
specialUse: components["schemas"]["SpecialUse"];
modifyIndex: number;
subscribed: boolean;
hidden: boolean;
total: number;
unseen: number;
};
GetMailboxesResponse: {
success: boolean;
results: components["schemas"]["GetMailboxesResult"][];
};
CreateMailboxResponse: {
success: boolean;
id: string;
};
GetMessageResponse: {
success: boolean;
id: number;
mailbox: string;
user: string;
envelope: components["schemas"]["Envelope"];
thread: string;
from: components["schemas"]["Address"];
to?: components["schemas"]["Address"];
cc?: components["schemas"]["Address"];
bcc?: components["schemas"]["Address"];
subject: string;
messageId: string;
date: string;
idate?: string;
list?: components["schemas"]["List"];
expires?: string;
seen: boolean;
deleted: boolean;
flagged: boolean;
draft: boolean;
html?: string[];
text?: string;
attachments?: components["schemas"]["Attachments"][];
verificationResults?: components["schemas"]["VerificationResults"];
bimi?: {
certified?: boolean;
url?: string;
image?: string;
};
contentType: components["schemas"]["ContentType"];
metaData: {
[key: string]: unknown;
};
reference?: {
[key: string]: unknown;
};
files?: components["schemas"]["Files"];
outbound?: components["schemas"]["Outbound"][];
};
DeleteMessagesInMailboxResponse: {
success: boolean;
deleted: number;
};
GetMessagesResponse: {
success: boolean;
total: number;
page: number;
previousCursor: string;
nextCursor: string;
results: components["schemas"]["GetMessagesResult"][];
};
UpdateMessageResponse: {
success: boolean;
id: {
[key: string]: unknown;
}[];
updated: number;
};
SearchMessagesResponse: {
success: boolean;
total: number;
page: number;
previousCursor: string;
nextCursor: string;
results: components["schemas"]["GetMessagesResult"][];
};
SubmitStoredMessageResponse: {
success: boolean;
queueId: string;
message?: components["schemas"]["Message"];
};
GetFilesResponse: {
success: boolean;
total: number;
page: number;
previousCursor: string;
nextCursor: string;
results: components["schemas"]["GetFilesResult"][];
};
SubmitMessageResponse: {
success: boolean;
message: components["schemas"]["MessageWithQueueId"];
};
SetupTotp2FAResponse: {
success: boolean;
seed: string;
qrcode: string;
};
GetUserResponse: {
success: boolean;
id: string;
username: string;
name: string;
address: string;
retention: number;
enabled2fa: string[];
autoreply: boolean;
encryptMessages: boolean;
encryptForwarded: boolean;
pubKey: string;
keyInfo: components["schemas"]["KeyInfo"];
metaData: {
[key: string]: unknown;
};
internalData: {
[key: string]: unknown;
};
targets: string[];
spamLevel: number;
limits: components["schemas"]["UserLimits"];
tags: string[];
fromWhitelist?: string[];
disabledScopes: components["schemas"]["DisabledScopes"][];
hasPasswordSet: boolean;
activated: boolean;
disabled: boolean;
suspended: boolean;
};
GetUsersResponse: {
success: boolean;
total: number;
page: number;
previousCursor: string;
nextCursor: string;
results: components["schemas"]["GetUsersResult"][];
};
CreateUserResponse: {
success: boolean;
id: string;
};
RecalculateQuotaResponse: {
success: boolean;
storageUsed: number;
};
ResetUserPasswordResponse: {
success: boolean;
password: string;
};
GetWebhooksResponse: {
success: boolean;
total: number;
page: number;
previousCursor: string;
nextCursor: string;
results: components["schemas"]["GetWebhooksResult"][];
};
CreateWebhookResponse: {
success: boolean;
id: string;
};
GetSettingResponse: {
success: boolean;
key?: string;
value?: string | number;
} & {
id: unknown;
};
GetSettingsResponse: {
success: boolean;
filter?: string;
settings: components["schemas"]["GetSettingsResult"][];
};
CreateSettingResponse: {
success: boolean;
key?: string;
} & {
id: unknown;
};
UpdateForwardedAddressRequest: {
address?: string;
name?: string;
targets?: string[];
forwards?: number;
tags?: string[];
metaData?: {
[key: string]: unknown;
} | string;
internalData?: {
[key: string]: unknown;
} | string;
forwardedDisabled?: boolean;
autoreply?: components["schemas"]["Autoreply"];
};
UpdateUserAddressRequest: {
name?: string;
address?: string;
main: boolean;
metaData?: {
[key: string]: unknown;
} | string;
internalData?: {
[key: string]: unknown;
} | string;
tags?: string[];
};
CreateUserAddressRequest: {
address: string;
name?: string;
tags?: string[];
main?: boolean;
allowWildcard?: boolean;
metaData?: {
[key: string]: unknown;
} | string;
internalData?: {
[key: string]: unknown;
} | string;
};
CreateForwardedAddressRequest: {
address: string;
name?: string;
targets?: string[];
forwards?: number;
allowWildcard?: boolean;
tags?: string[];
metaData?: {
[key: string]: unknown;
} | string;
internalData?: {
[key: string]: unknown;
} | string;
autoreply?: components["schemas"]["Autoreply"];
};
RenameDomainRequest: {
oldDomain: string;
newDomain: string;
};
CreateASPRequest: {
description: string;
scopes: components["schemas"]["AspScopes"][];
generateMobileconfig?: boolean;
address?: string;
password?: string;
ttl?: number;
sess?: string;
ip?: string;
};
RestoreMessageRequest: {
mailbox?: string;
};
RestoreMessagesRequest: {
start: string;
end: string;
};
CreateAuditRequest: {
user: string;
start?: string;
end?: string;
expires: string;
};
AuthenticateRequest: {
username: string;
password: string;
protocol?: string;
scope?: string;
token?: boolean;
sess?: string;
ip?: string;
};
UpdateAutoreplyRequest: {
status?: boolean;
name?: string;
subject?: string;
html?: string;
text?: string;
start?: string;
end?: string;
};
UpdateDkimKeyRequest: {
domain: string;
selector: string;
description?: string;
privateKey?: string;
};
UpdateTLSCertRequest: {
servername: string;
acme?: boolean;
privateKey?: string;
cert?: string;
ca?: string[];
description?: string;
};
CreateAllowedDomainRequest: {
domain: string;
};
CreateBlockedDomainRequest: {
domain: string;
};
CreateDomainAliasRequest: {
alias: string;
domain: string;
};
UpdateFilterRequest: {
name?: string;
query?: components["schemas"]["Query"];
action?: components["schemas"]["Action"];
disabled?: boolean;
};
CreateFilterRequest: {
name?: string;
query: components["schemas"]["Query"];
action: components["schemas"]["Action"];
disabled?: boolean;
};
UpdateMailboxRequest: {
path?: string;
hidden?: boolean;
retention?: number;
subscribed?: boolean;
};
CreateMailboxRequest: {
path: string;
hidden?: boolean;
retention?: number;
};
UpdateMessageRequest: {
message?: string;
moveTo?: string;
seen?: boolean;
flagged?: boolean;
draft?: boolean;
expires?: string;
metaData?: {
[key: string]: unknown;
} | string;
};
SubmitStoredMessageRequest: {
deleteFiles?: boolean;
sendTime?: string;
};
SubmitMessageRequest: {
reference?: components["schemas"]["Reference"];
mailbox?: string;
uploadOnly?: boolean;
isDraft?: boolean;
sendTime?: string;
envelope?: components["schemas"]["EnvelopeUpload"];
from?: components["schemas"]["Address"];
to?: components["schemas"]["AddressOptionalName"][];
cc?: components["schemas"]["AddressOptionalName"][];
bcc?: components["schemas"]["AddressOptionalName"][];
subject: string;
text: string;
html: string;
headers?: components["schemas"]["Header"][];
attachments?: components["schemas"]["AttachmentsUpload"][];
meta?: {
[key: string]: unknown;
};
sess?: string;
ip?: string;
};
CheckTotp2FARequest: {
token: string;
sess?: string;
ip?: string;
};
EnableCustom2FARequest: {
sess?: string;
ip?: string;
};
EnableTotp2FARequest: {
token: string;
sess?: string;
ip?: string;
};
SetupTotp2FARequest: {
label?: string;
issuer?: string;
sess?: string;
ip?: string;
};
UpdateUserRequest: {
name?: string;
existingPassword?: string;
password?: string;
hashedPassword?: boolean;
allowUnsafe?: boolean;
tags?: string[];
retention?: number;
uploadSentMessages?: boolean;
encryptMessages?: boolean;
encryptForwarded?: boolean;
pubKey?: string;
metaData?: {
[key: string]: unknown;
} | string;
internalData?: {
[key: string]: unknown;
};
language?: string;
targets?: string[];
spamLevel?: number;
quota?: number;
recipients?: number;
forwards?: number;
filters?: number;
imapMaxUpload?: number;
imapMaxDownload?: number;
pop3MaxDownload?: number;
pop3MaxMessages?: number;
imapMaxConnections?: number;
receivedMax?: number;
disable2fa?: boolean;
disabledScopes?: components["schemas"]["DisabledScopes"][];
disabled?: boolean;
fromWhitelist?: string[];
suspended?: boolean;
sess?: string;
ip?: string;
};
CreateUserRequest: {
username: string;
name?: string;
password: string;
hashedPassword?: boolean;
allowUnsafe?: boolean;
address?: string;
emptyAddress?: boolean;
requirePasswordChange?: boolean;
tags?: string[];
addTagsToAddress?: boolean;
retention?: number;
uploadSentMessages?: boolean;
encryptMessages?: boolean;
encryptForwarded?: boolean;
pubKey?: string;
metaData?: {
[key: string]: unknown;
} | string;
internalData?: {
[key: string]: unknown;
} | string;
language?: string;
targets?: string[];
spamLevel?: number;
quota?: number;
recipients?: number;
forwards?: number;
filters?: number;
imapMaxUpload?: number;
imapMaxDownload?: number;
pop3MaxDownload?: number;
pop3MaxMessages?: number;
imapMaxConnections?: number;
receivedMax?: number;
mailboxes?: components["schemas"]["Mailboxes"];
disabledScopes?: components["schemas"]["DisabledScopes"][];
fromWhitelist?: string[];
sess?: string;
ip?: string;
};
LogoutUserRequest: {
reason?: string;
};
UserRestoreRequest: {
sess?: string;
ip?: string;
};
ResetUserPasswordRequest: {
validAfter?: string;
sess?: string;
ip?: string;
};
CreateWebhookRequest: {
type: string[];
user?: string;
url: string;
};
CreateSettingRequest: {
value: string | number;
sess?: string;
ip?: string;
};
GetAddressesResult: {
id: string;
name: string;
address: string;
user: string;
forwarded: boolean;
forwardedDisabled: boolean;
target?: string[];
};
GetUserAddressesResult: {
id: string;
name: string;
address: string;
main: boolean;
created: string;
tags: string[];
metaData?: {
[key: string]: unknown;
};
internalData?: {
[key: string]: unknown;
};
};
GetUserAddressesregisterResult: {
id: string;
name?: string;
address: string;
};
GetASPsResult: {
id: string;
description: string;
scopes: components["schemas"]["AspScopes"][];
lastUse: components["schemas"]["LastUse"];
created: string;
};
GetArchivedMessagesResult: {
id: string;
mailbox: string;
thread: string;
from: components["schemas"]["Address"];
to: components["schemas"]["Address"][];
cc: components["schemas"]["Address"][];
bcc: components["schemas"]["Address"][];
subject: string;
date: string;
idate?: string;
intro: string;
attachments: boolean;
seen: boolean;
deleted: boolean;
flagged: boolean;
contentType: components["schemas"]["ContentType"];
};
GetAuthlogResult: {
id: string;
action: string;
result: string;
sess?: string;
ip?: string;
created: string;
};
GetDkimKeysResult: {
id: string;
domain: string;
selector: string;
description: string;
fingerprint: string;
created: string;
};
GetTLSCertResult: {
id: string;
servername: string;
acme?: boolean;
description: string;
fingerprint: string;
created: string;
expires?: string;
altNames?: string[];
};
GetAllowedDomainResult: {
id: string;
domain: string;
};
GetBlockedDomainResult: {
id: string;
domain: string;
};
GetDomainAliasesResult: {
id: string;
alias: string;
domain: string;
};
GetAllFiltersResult: {
id: string;
user: string;
name: string;
created: string;
query: string[][];
action: string[][];
disabled: boolean;
targets?: string[];
};
GetFiltersResult: {
id: string;
name: string;
created: string;
query: string[][];
action: string[][];
disabled: boolean;
};
GetMailboxesResult: {
id: string;
name: string;
path: string;
specialUse: string;
modifyIndex: number;
subscribed: boolean;
retention?: number;
hidden: boolean;
total: number;
unseen: number;
};
GetMessagesResult: {
id: number;
mailbox: string;
thread: string;
threadMessageCount?: number;
from: components["schemas"]["Address"];
to: components["schemas"]["Address"][];
cc: components["schemas"]["Address"][];
bcc: components["schemas"]["Address"][];
subject: string;
date: string;
idate?: string;
size: number;
intro: string;
attachments: boolean;
seen: boolean;
deleted: boolean;
flagged: boolean;
answered: boolean;
forwarded: boolean;
contentType: components["schemas"]["ContentType"];
metaData?: {
[key: string]: unknown;
};
};
GetFilesResult: {
id: string;
filename: string;
contentType: string;
size: number;
};
GetUsersResult: {
id: string;
username: string;
name: string;
address: string;
tags: string[];
targets: string[];
enabled2fa: string[];
autoreply: boolean;
encryptMessages: boolean;
encryptForwarded: boolean;
quota: components["schemas"]["Quota"];
metaData?: {
[key: string]: unknown;
};
internalData?: {