Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

WorkMail

import { WorkMail } from "https://aws-api.deno.dev/v0.3/services/workmail.ts?docs=full";
class WorkMail {
constructor(apiFactory: client.ApiFactory);
async associateDelegateToResource(params: AssociateDelegateToResourceRequest, opts?: client.RequestOptions): Promise<void>;
async associateMemberToGroup(params: AssociateMemberToGroupRequest, opts?: client.RequestOptions): Promise<void>;
async cancelMailboxExportJob(params: CancelMailboxExportJobRequest, opts?: client.RequestOptions): Promise<void>;
async createAlias(params: CreateAliasRequest, opts?: client.RequestOptions): Promise<void>;
async createGroup(params: CreateGroupRequest, opts?: client.RequestOptions): Promise<CreateGroupResponse>;
async createMobileDeviceAccessRule(params: CreateMobileDeviceAccessRuleRequest, opts?: client.RequestOptions): Promise<CreateMobileDeviceAccessRuleResponse>;
async createOrganization(params: CreateOrganizationRequest, opts?: client.RequestOptions): Promise<CreateOrganizationResponse>;
async createResource(params: CreateResourceRequest, opts?: client.RequestOptions): Promise<CreateResourceResponse>;
async createUser(params: CreateUserRequest, opts?: client.RequestOptions): Promise<CreateUserResponse>;
async deleteAccessControlRule(params: DeleteAccessControlRuleRequest, opts?: client.RequestOptions): Promise<void>;
async deleteAlias(params: DeleteAliasRequest, opts?: client.RequestOptions): Promise<void>;
async deleteEmailMonitoringConfiguration(params: DeleteEmailMonitoringConfigurationRequest, opts?: client.RequestOptions): Promise<void>;
async deleteGroup(params: DeleteGroupRequest, opts?: client.RequestOptions): Promise<void>;
async deleteMailboxPermissions(params: DeleteMailboxPermissionsRequest, opts?: client.RequestOptions): Promise<void>;
async deleteMobileDeviceAccessOverride(params: DeleteMobileDeviceAccessOverrideRequest, opts?: client.RequestOptions): Promise<void>;
async deleteMobileDeviceAccessRule(params: DeleteMobileDeviceAccessRuleRequest, opts?: client.RequestOptions): Promise<void>;
async deleteOrganization(params: DeleteOrganizationRequest, opts?: client.RequestOptions): Promise<DeleteOrganizationResponse>;
async deleteResource(params: DeleteResourceRequest, opts?: client.RequestOptions): Promise<void>;
async deleteRetentionPolicy(params: DeleteRetentionPolicyRequest, opts?: client.RequestOptions): Promise<void>;
async deleteUser(params: DeleteUserRequest, opts?: client.RequestOptions): Promise<void>;
async deregisterFromWorkMail(params: DeregisterFromWorkMailRequest, opts?: client.RequestOptions): Promise<void>;
async deregisterMailDomain(params: DeregisterMailDomainRequest, opts?: client.RequestOptions): Promise<void>;
async describeEmailMonitoringConfiguration(params: DescribeEmailMonitoringConfigurationRequest, opts?: client.RequestOptions): Promise<DescribeEmailMonitoringConfigurationResponse>;
async describeGroup(params: DescribeGroupRequest, opts?: client.RequestOptions): Promise<DescribeGroupResponse>;
async describeInboundDmarcSettings(params: DescribeInboundDmarcSettingsRequest, opts?: client.RequestOptions): Promise<DescribeInboundDmarcSettingsResponse>;
async describeMailboxExportJob(params: DescribeMailboxExportJobRequest, opts?: client.RequestOptions): Promise<DescribeMailboxExportJobResponse>;
async describeOrganization(params: DescribeOrganizationRequest, opts?: client.RequestOptions): Promise<DescribeOrganizationResponse>;
async describeResource(params: DescribeResourceRequest, opts?: client.RequestOptions): Promise<DescribeResourceResponse>;
async describeUser(params: DescribeUserRequest, opts?: client.RequestOptions): Promise<DescribeUserResponse>;
async disassociateDelegateFromResource(params: DisassociateDelegateFromResourceRequest, opts?: client.RequestOptions): Promise<void>;
async disassociateMemberFromGroup(params: DisassociateMemberFromGroupRequest, opts?: client.RequestOptions): Promise<void>;
async getAccessControlEffect(params: GetAccessControlEffectRequest, opts?: client.RequestOptions): Promise<GetAccessControlEffectResponse>;
async getDefaultRetentionPolicy(params: GetDefaultRetentionPolicyRequest, opts?: client.RequestOptions): Promise<GetDefaultRetentionPolicyResponse>;
async getMailboxDetails(params: GetMailboxDetailsRequest, opts?: client.RequestOptions): Promise<GetMailboxDetailsResponse>;
async getMailDomain(params: GetMailDomainRequest, opts?: client.RequestOptions): Promise<GetMailDomainResponse>;
async getMobileDeviceAccessEffect(params: GetMobileDeviceAccessEffectRequest, opts?: client.RequestOptions): Promise<GetMobileDeviceAccessEffectResponse>;
async getMobileDeviceAccessOverride(params: GetMobileDeviceAccessOverrideRequest, opts?: client.RequestOptions): Promise<GetMobileDeviceAccessOverrideResponse>;
async listAccessControlRules(params: ListAccessControlRulesRequest, opts?: client.RequestOptions): Promise<ListAccessControlRulesResponse>;
async listAliases(params: ListAliasesRequest, opts?: client.RequestOptions): Promise<ListAliasesResponse>;
async listGroupMembers(params: ListGroupMembersRequest, opts?: client.RequestOptions): Promise<ListGroupMembersResponse>;
async listGroups(params: ListGroupsRequest, opts?: client.RequestOptions): Promise<ListGroupsResponse>;
async listMailboxExportJobs(params: ListMailboxExportJobsRequest, opts?: client.RequestOptions): Promise<ListMailboxExportJobsResponse>;
async listMailboxPermissions(params: ListMailboxPermissionsRequest, opts?: client.RequestOptions): Promise<ListMailboxPermissionsResponse>;
async listMailDomains(params: ListMailDomainsRequest, opts?: client.RequestOptions): Promise<ListMailDomainsResponse>;
async listMobileDeviceAccessOverrides(params: ListMobileDeviceAccessOverridesRequest, opts?: client.RequestOptions): Promise<ListMobileDeviceAccessOverridesResponse>;
async listMobileDeviceAccessRules(params: ListMobileDeviceAccessRulesRequest, opts?: client.RequestOptions): Promise<ListMobileDeviceAccessRulesResponse>;
async listOrganizations(params?: ListOrganizationsRequest, opts?: client.RequestOptions): Promise<ListOrganizationsResponse>;
async listResourceDelegates(params: ListResourceDelegatesRequest, opts?: client.RequestOptions): Promise<ListResourceDelegatesResponse>;
async listResources(params: ListResourcesRequest, opts?: client.RequestOptions): Promise<ListResourcesResponse>;
async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;
async listUsers(params: ListUsersRequest, opts?: client.RequestOptions): Promise<ListUsersResponse>;
async putAccessControlRule(params: PutAccessControlRuleRequest, opts?: client.RequestOptions): Promise<void>;
async putEmailMonitoringConfiguration(params: PutEmailMonitoringConfigurationRequest, opts?: client.RequestOptions): Promise<void>;
async putInboundDmarcSettings(params: PutInboundDmarcSettingsRequest, opts?: client.RequestOptions): Promise<void>;
async putMailboxPermissions(params: PutMailboxPermissionsRequest, opts?: client.RequestOptions): Promise<void>;
async putMobileDeviceAccessOverride(params: PutMobileDeviceAccessOverrideRequest, opts?: client.RequestOptions): Promise<void>;
async putRetentionPolicy(params: PutRetentionPolicyRequest, opts?: client.RequestOptions): Promise<void>;
async registerMailDomain(params: RegisterMailDomainRequest, opts?: client.RequestOptions): Promise<void>;
async registerToWorkMail(params: RegisterToWorkMailRequest, opts?: client.RequestOptions): Promise<void>;
async resetPassword(params: ResetPasswordRequest, opts?: client.RequestOptions): Promise<void>;
async startMailboxExportJob(params: StartMailboxExportJobRequest, opts?: client.RequestOptions): Promise<StartMailboxExportJobResponse>;
async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async updateDefaultMailDomain(params: UpdateDefaultMailDomainRequest, opts?: client.RequestOptions): Promise<void>;
async updateMailboxQuota(params: UpdateMailboxQuotaRequest, opts?: client.RequestOptions): Promise<void>;
async updateMobileDeviceAccessRule(params: UpdateMobileDeviceAccessRuleRequest, opts?: client.RequestOptions): Promise<void>;
async updatePrimaryEmailAddress(params: UpdatePrimaryEmailAddressRequest, opts?: client.RequestOptions): Promise<void>;
async updateResource(params: UpdateResourceRequest, opts?: client.RequestOptions): Promise<void>;
 
static ApiMetadata: client.ApiMetadata;
}

§Constructors

§
new WorkMail(apiFactory: client.ApiFactory)
[src]

§Methods

§
associateDelegateToResource(params: AssociateDelegateToResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

Adds a member (user or group) to the resource's set of delegates.

§
associateMemberToGroup(params: AssociateMemberToGroupRequest, opts?: client.RequestOptions): Promise<void>
[src]

Adds a member (user or group) to the group's set.

§
cancelMailboxExportJob(params: CancelMailboxExportJobRequest, opts?: client.RequestOptions): Promise<void>
[src]

Cancels a mailbox export job.

Note: If the mailbox export job is near completion, it might not be possible to cancel it.

§
createAlias(params: CreateAliasRequest, opts?: client.RequestOptions): Promise<void>
[src]

Adds an alias to the set of a given member (user or group) of Amazon WorkMail.

§

Creates a group that can be used in Amazon WorkMail by calling the "RegisterToWorkMail" operation.

§

Creates a new mobile device access rule for the specified Amazon WorkMail organization.

§

Creates a new Amazon WorkMail organization. Optionally, you can choose to associate an existing AWS Directory Service directory with your organization. If an AWS Directory Service directory ID is specified, the organization alias must match the directory alias. If you choose not to associate an existing directory with your organization, then we create a new Amazon WorkMail directory for you. For more information, see Adding an organization in the Amazon WorkMail Administrator Guide.

You can associate multiple email domains with an organization, then set your default email domain from the Amazon WorkMail console. You can also associate a domain that is managed in an Amazon Route 53 public hosted zone. For more information, see Adding a domain and Choosing the default domain in the Amazon WorkMail Administrator Guide.

Optionally, you can use a customer managed master key from AWS Key Management Service (AWS KMS) to encrypt email for your organization. If you don't associate an AWS KMS key, Amazon WorkMail creates a default AWS managed master key for you.

§

Creates a new Amazon WorkMail resource.

§

Creates a user who can be used in Amazon WorkMail by calling the "RegisterToWorkMail" operation.

§
deleteAccessControlRule(params: DeleteAccessControlRuleRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes an access control rule for the specified WorkMail organization.

Note: Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.

§
deleteAlias(params: DeleteAliasRequest, opts?: client.RequestOptions): Promise<void>
[src]

Remove one or more specified aliases from a set of aliases for a given user.

§
deleteEmailMonitoringConfiguration(params: DeleteEmailMonitoringConfigurationRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes the email monitoring configuration for a specified organization.

§
deleteGroup(params: DeleteGroupRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes a group from Amazon WorkMail.

§
deleteMailboxPermissions(params: DeleteMailboxPermissionsRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes permissions granted to a member (user or group).

§
deleteMobileDeviceAccessOverride(params: DeleteMobileDeviceAccessOverrideRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes the mobile device access override for the given WorkMail organization, user, and device.

Note: Deleting already deleted and non-existing overrides does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.

§
deleteMobileDeviceAccessRule(params: DeleteMobileDeviceAccessRuleRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes a mobile device access rule for the specified Amazon WorkMail organization.

Note: Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.

§

Deletes an Amazon WorkMail organization and all underlying AWS resources managed by Amazon WorkMail as part of the organization. You can choose whether to delete the associated directory. For more information, see Removing an organization in the Amazon WorkMail Administrator Guide.

§
deleteResource(params: DeleteResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes the specified resource.

§
deleteRetentionPolicy(params: DeleteRetentionPolicyRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes the specified retention policy from the specified organization.

§
deleteUser(params: DeleteUserRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes a user from Amazon WorkMail and all subsequent systems. Before you can delete a user, the user state must be DISABLED. Use the "DescribeUser" action to confirm the user state.

Deleting a user is permanent and cannot be undone. WorkMail archives user mailboxes for 30 days before they are permanently removed.

§
deregisterFromWorkMail(params: DeregisterFromWorkMailRequest, opts?: client.RequestOptions): Promise<void>
[src]

Mark a user, group, or resource as no longer used in Amazon WorkMail. This action disassociates the mailbox and schedules it for clean-up. WorkMail keeps mailboxes for 30 days before they are permanently removed. The functionality in the console is Disable.

§
deregisterMailDomain(params: DeregisterMailDomainRequest, opts?: client.RequestOptions): Promise<void>
[src]

Removes a domain from Amazon WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail use. SES keeps the domain because other applications may use it. You must first remove any email address used by WorkMail entities before you remove the domain.

§

Describes the current email monitoring configuration for a specified organization.

§

Returns the data available for the group.

§

Lists the settings in a DMARC policy for a specified organization.

§

Describes the current status of a mailbox export job.

§

Provides more information regarding a given organization based on its identifier.

§

Returns the data available for the resource.

§

Provides information regarding the user.

§
disassociateDelegateFromResource(params: DisassociateDelegateFromResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

Removes a member from the resource's set of delegates.

§
disassociateMemberFromGroup(params: DisassociateMemberFromGroupRequest, opts?: client.RequestOptions): Promise<void>
[src]

Removes a member from a group.

§

Gets the effects of an organization's access control rules as they apply to a specified IPv4 address, access protocol action, or user ID.

§

Gets the default retention policy details for the specified organization.

§

Requests a user's mailbox details for a specified organization and user.

§

Gets details for a mail domain, including domain records required to configure your domain with recommended security.

§

Simulates the effect of the mobile device access rules for the given attributes of a sample access event. Use this method to test the effects of the current set of mobile device access rules for the Amazon WorkMail organization for a particular user's attributes.

§

Gets the mobile device access override for the given WorkMail organization, user, and device.

§

Lists the access control rules for the specified organization.

§

Creates a paginated call to list the aliases associated with a given entity.

§

Returns an overview of the members of a group. Users and groups can be members of a group.

§

Returns summaries of the organization's groups.

§

Lists the mailbox export jobs started for the specified organization within the last seven days.

§

Lists the mailbox permissions associated with a user, group, or resource mailbox.

§

Lists the mail domains in a given Amazon WorkMail organization.

§

Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.

§

Lists the mobile device access rules for the specified Amazon WorkMail organization.

§

Returns summaries of the customer's organizations.

§

Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.

§

Returns summaries of the organization's resources.

§

Lists the tags applied to an Amazon WorkMail organization resource.

§

Returns summaries of the organization's users.

§
putAccessControlRule(params: PutAccessControlRuleRequest, opts?: client.RequestOptions): Promise<void>
[src]

Adds a new access control rule for the specified organization. The rule allows or denies access to the organization for the specified IPv4 addresses, access protocol actions, and user IDs. Adding a new rule with the same name as an existing rule replaces the older rule.

§
putEmailMonitoringConfiguration(params: PutEmailMonitoringConfigurationRequest, opts?: client.RequestOptions): Promise<void>
[src]

Creates or updates the email monitoring configuration for a specified organization.

§
putInboundDmarcSettings(params: PutInboundDmarcSettingsRequest, opts?: client.RequestOptions): Promise<void>
[src]

Enables or disables a DMARC policy for a given organization.

§
putMailboxPermissions(params: PutMailboxPermissionsRequest, opts?: client.RequestOptions): Promise<void>
[src]

Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.

§
putMobileDeviceAccessOverride(params: PutMobileDeviceAccessOverrideRequest, opts?: client.RequestOptions): Promise<void>
[src]

Creates or updates a mobile device access override for the given WorkMail organization, user, and device.

§
putRetentionPolicy(params: PutRetentionPolicyRequest, opts?: client.RequestOptions): Promise<void>
[src]

Puts a retention policy to the specified organization.

§
registerMailDomain(params: RegisterMailDomainRequest, opts?: client.RequestOptions): Promise<void>
[src]

Registers a new domain in Amazon WorkMail and SES, and configures it for use by WorkMail. Emails received by SES for this domain are routed to the specified WorkMail organization, and WorkMail has permanent permission to use the specified domain for sending your users' emails.

§
registerToWorkMail(params: RegisterToWorkMailRequest, opts?: client.RequestOptions): Promise<void>
[src]

Registers an existing and disabled user, group, or resource for Amazon WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the user, group, or resource is enabled and fails if the user, group, or resource is deleted. This operation results in the accumulation of costs. For more information, see Pricing. The equivalent console functionality for this operation is Enable.

Users can either be created by calling the "CreateUser" API operation or they can be synchronized from your directory. For more information, see "DeregisterFromWorkMail".

§
resetPassword(params: ResetPasswordRequest, opts?: client.RequestOptions): Promise<void>
[src]

Allows the administrator to reset the password for a user.

§

Starts a mailbox export job to export MIME-format email messages and calendar items from the specified mailbox to the specified Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Exporting mailbox content in the Amazon WorkMail Administrator Guide.

§
tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

Applies the specified tags to the specified Amazon WorkMail organization resource.

§
untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

Untags the specified tags from the specified Amazon WorkMail organization resource.

§
updateDefaultMailDomain(params: UpdateDefaultMailDomainRequest, opts?: client.RequestOptions): Promise<void>
[src]

Updates the default mail domain for an organization. The default mail domain is used by the WorkMail AWS Console to suggest an email address when enabling a mail user. You can only have one default domain.

§
updateMailboxQuota(params: UpdateMailboxQuotaRequest, opts?: client.RequestOptions): Promise<void>
[src]

Updates a user's current mailbox quota for a specified organization and user.

§
updateMobileDeviceAccessRule(params: UpdateMobileDeviceAccessRuleRequest, opts?: client.RequestOptions): Promise<void>
[src]

Updates a mobile device access rule for the specified Amazon WorkMail organization.

§
updatePrimaryEmailAddress(params: UpdatePrimaryEmailAddressRequest, opts?: client.RequestOptions): Promise<void>
[src]

Updates the primary email for a user, group, or resource. The current email is moved into the list of aliases (or swapped between an existing alias and the current primary email), and the email provided in the input is promoted as the primary.

§
updateResource(params: UpdateResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

Updates data for the resource. To have the latest information, it must be preceded by a "DescribeResource" call. The dataset in the request should be the one expected when performing another DescribeResource call.

§Static Properties