AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Interface for accessing WorkMail

WorkMail is a secure, managed business email and calendaring service with support for existing desktop and mobile email clients. You can access your email, contacts, and calendars using Microsoft Outlook, your browser, or other native iOS and Android email applications. You can integrate WorkMail with your existing corporate directory and control both the keys that encrypt your data and the location in which your data is stored.

The WorkMail API is designed for the following scenarios:

All WorkMail API operations are Amazon-authenticated and certificate-signed. They not only require the use of the AWS SDK, but also allow for the exclusive use of AWS Identity and Access Management users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the WorkMail site, the IAM user gains full administrative visibility into the entire WorkMail organization (or as set in the IAM policy). This includes, but is not limited to, the ability to create, update, and delete users, groups, and resources. This allows developers to perform the scenarios listed above, as well as give users the ability to grant access on a selective basis using the IAM model.

Inheritance Hierarchy

Amazon.WorkMail.IAmazonWorkMail

Namespace: Amazon.WorkMail
Assembly: AWSSDK.WorkMail.dll
Version: 3.x.y.z

Syntax

C#
public interface IAmazonWorkMail
         IAmazonService, IDisposable

The IAmazonWorkMail type exposes the following members

Properties

NameTypeDescription
Public Property Paginators Amazon.WorkMail.Model.IWorkMailPaginatorFactory

Paginators for the service

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method AssociateDelegateToResource(AssociateDelegateToResourceRequest)

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

Public Method AssociateDelegateToResourceAsync(AssociateDelegateToResourceRequest, CancellationToken)

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

Public Method AssociateMemberToGroup(AssociateMemberToGroupRequest)

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

Public Method AssociateMemberToGroupAsync(AssociateMemberToGroupRequest, CancellationToken)

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

Public Method AssumeImpersonationRole(AssumeImpersonationRoleRequest)

Assumes an impersonation role for the given WorkMail organization. This method returns an authentication token you can use to make impersonated calls.

Public Method AssumeImpersonationRoleAsync(AssumeImpersonationRoleRequest, CancellationToken)

Assumes an impersonation role for the given WorkMail organization. This method returns an authentication token you can use to make impersonated calls.

Public Method CancelMailboxExportJob(CancelMailboxExportJobRequest)

Cancels a mailbox export job.

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

Public Method CancelMailboxExportJobAsync(CancelMailboxExportJobRequest, CancellationToken)

Cancels a mailbox export job.

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

Public Method CreateAlias(CreateAliasRequest)

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

Public Method CreateAliasAsync(CreateAliasRequest, CancellationToken)

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

Public Method CreateAvailabilityConfiguration(CreateAvailabilityConfigurationRequest)

Creates an AvailabilityConfiguration for the given WorkMail organization and domain.

Public Method CreateAvailabilityConfigurationAsync(CreateAvailabilityConfigurationRequest, CancellationToken)

Creates an AvailabilityConfiguration for the given WorkMail organization and domain.

Public Method CreateGroup(CreateGroupRequest)

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

Public Method CreateGroupAsync(CreateGroupRequest, CancellationToken)

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

Public Method CreateImpersonationRole(CreateImpersonationRoleRequest)

Creates an impersonation role for the given WorkMail organization.

Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries also complete successfully without performing any further actions.

Public Method CreateImpersonationRoleAsync(CreateImpersonationRoleRequest, CancellationToken)

Creates an impersonation role for the given WorkMail organization.

Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries also complete successfully without performing any further actions.

Public Method CreateMobileDeviceAccessRule(CreateMobileDeviceAccessRuleRequest)

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

Public Method CreateMobileDeviceAccessRuleAsync(CreateMobileDeviceAccessRuleRequest, CancellationToken)

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

Public Method CreateOrganization(CreateOrganizationRequest)

Creates a new 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 WorkMail directory for you. For more information, see Adding an organization in the WorkMail Administrator Guide.

You can associate multiple email domains with an organization, then choose your default email domain from the 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 WorkMail Administrator Guide.

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

Public Method CreateOrganizationAsync(CreateOrganizationRequest, CancellationToken)

Creates a new 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 WorkMail directory for you. For more information, see Adding an organization in the WorkMail Administrator Guide.

You can associate multiple email domains with an organization, then choose your default email domain from the 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 WorkMail Administrator Guide.

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

Public Method CreateResource(CreateResourceRequest)

Creates a new WorkMail resource.

Public Method CreateResourceAsync(CreateResourceRequest, CancellationToken)

Creates a new WorkMail resource.

Public Method CreateUser(CreateUserRequest)

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

Public Method CreateUserAsync(CreateUserRequest, CancellationToken)

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

Public Method DeleteAccessControlRule(DeleteAccessControlRuleRequest)

Deletes an access control rule for the specified WorkMail organization.

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.

Public Method DeleteAccessControlRuleAsync(DeleteAccessControlRuleRequest, CancellationToken)

Deletes an access control rule for the specified WorkMail organization.

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.

Public Method DeleteAlias(DeleteAliasRequest)

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

Public Method DeleteAliasAsync(DeleteAliasRequest, CancellationToken)

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

Public Method DeleteAvailabilityConfiguration(DeleteAvailabilityConfigurationRequest)

Deletes the AvailabilityConfiguration for the given WorkMail organization and domain.

Public Method DeleteAvailabilityConfigurationAsync(DeleteAvailabilityConfigurationRequest, CancellationToken)

Deletes the AvailabilityConfiguration for the given WorkMail organization and domain.

Public Method DeleteEmailMonitoringConfiguration(DeleteEmailMonitoringConfigurationRequest)

Deletes the email monitoring configuration for a specified organization.

Public Method DeleteEmailMonitoringConfigurationAsync(DeleteEmailMonitoringConfigurationRequest, CancellationToken)

Deletes the email monitoring configuration for a specified organization.

Public Method DeleteGroup(DeleteGroupRequest)

Deletes a group from WorkMail.

Public Method DeleteGroupAsync(DeleteGroupRequest, CancellationToken)

Deletes a group from WorkMail.

Public Method DeleteImpersonationRole(DeleteImpersonationRoleRequest)

Deletes an impersonation role for the given WorkMail organization.

Public Method DeleteImpersonationRoleAsync(DeleteImpersonationRoleRequest, CancellationToken)

Deletes an impersonation role for the given WorkMail organization.

Public Method DeleteMailboxPermissions(DeleteMailboxPermissionsRequest)

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

Public Method DeleteMailboxPermissionsAsync(DeleteMailboxPermissionsRequest, CancellationToken)

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

Public Method DeleteMobileDeviceAccessOverride(DeleteMobileDeviceAccessOverrideRequest)

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

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.

Public Method DeleteMobileDeviceAccessOverrideAsync(DeleteMobileDeviceAccessOverrideRequest, CancellationToken)

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

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.

Public Method DeleteMobileDeviceAccessRule(DeleteMobileDeviceAccessRuleRequest)

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

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.

Public Method DeleteMobileDeviceAccessRuleAsync(DeleteMobileDeviceAccessRuleRequest, CancellationToken)

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

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.

Public Method DeleteOrganization(DeleteOrganizationRequest)

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

Public Method DeleteOrganizationAsync(DeleteOrganizationRequest, CancellationToken)

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

Public Method DeleteResource(DeleteResourceRequest)

Deletes the specified resource.

Public Method DeleteResourceAsync(DeleteResourceRequest, CancellationToken)

Deletes the specified resource.

Public Method DeleteRetentionPolicy(DeleteRetentionPolicyRequest)

Deletes the specified retention policy from the specified organization.

Public Method DeleteRetentionPolicyAsync(DeleteRetentionPolicyRequest, CancellationToken)

Deletes the specified retention policy from the specified organization.

Public Method DeleteUser(DeleteUserRequest)

Deletes a user from 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.

Public Method DeleteUserAsync(DeleteUserRequest, CancellationToken)

Deletes a user from 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.

Public Method DeregisterFromWorkMail(DeregisterFromWorkMailRequest)

Mark a user, group, or resource as no longer used in 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.

Public Method DeregisterFromWorkMailAsync(DeregisterFromWorkMailRequest, CancellationToken)

Mark a user, group, or resource as no longer used in 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.

Public Method DeregisterMailDomain(DeregisterMailDomainRequest)

Removes a domain from 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.

Public Method DeregisterMailDomainAsync(DeregisterMailDomainRequest, CancellationToken)

Removes a domain from 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.

Public Method DescribeEmailMonitoringConfiguration(DescribeEmailMonitoringConfigurationRequest)

Describes the current email monitoring configuration for a specified organization.

Public Method DescribeEmailMonitoringConfigurationAsync(DescribeEmailMonitoringConfigurationRequest, CancellationToken)

Describes the current email monitoring configuration for a specified organization.

Public Method DescribeEntity(DescribeEntityRequest)

Returns basic details about an entity in WorkMail.

Public Method DescribeEntityAsync(DescribeEntityRequest, CancellationToken)

Returns basic details about an entity in WorkMail.

Public Method DescribeGroup(DescribeGroupRequest)

Returns the data available for the group.

Public Method DescribeGroupAsync(DescribeGroupRequest, CancellationToken)

Returns the data available for the group.

Public Method DescribeInboundDmarcSettings(DescribeInboundDmarcSettingsRequest)

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

Public Method DescribeInboundDmarcSettingsAsync(DescribeInboundDmarcSettingsRequest, CancellationToken)

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

Public Method DescribeMailboxExportJob(DescribeMailboxExportJobRequest)

Describes the current status of a mailbox export job.

Public Method DescribeMailboxExportJobAsync(DescribeMailboxExportJobRequest, CancellationToken)

Describes the current status of a mailbox export job.

Public Method DescribeOrganization(DescribeOrganizationRequest)

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

Public Method DescribeOrganizationAsync(DescribeOrganizationRequest, CancellationToken)

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

Public Method DescribeResource(DescribeResourceRequest)

Returns the data available for the resource.

Public Method DescribeResourceAsync(DescribeResourceRequest, CancellationToken)

Returns the data available for the resource.

Public Method DescribeUser(DescribeUserRequest)

Provides information regarding the user.

Public Method DescribeUserAsync(DescribeUserRequest, CancellationToken)

Provides information regarding the user.

Public Method DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

Returns the endpoint that will be used for a particular request.

Public Method DisassociateDelegateFromResource(DisassociateDelegateFromResourceRequest)

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

Public Method DisassociateDelegateFromResourceAsync(DisassociateDelegateFromResourceRequest, CancellationToken)

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

Public Method DisassociateMemberFromGroup(DisassociateMemberFromGroupRequest)

Removes a member from a group.

Public Method DisassociateMemberFromGroupAsync(DisassociateMemberFromGroupRequest, CancellationToken)

Removes a member from a group.

Public Method GetAccessControlEffect(GetAccessControlEffectRequest)

Gets the effects of an organization's access control rules as they apply to a specified IPv4 address, access protocol action, and user ID or impersonation role ID. You must provide either the user ID or impersonation role ID. Impersonation role ID can only be used with Action EWS.

Public Method GetAccessControlEffectAsync(GetAccessControlEffectRequest, CancellationToken)

Gets the effects of an organization's access control rules as they apply to a specified IPv4 address, access protocol action, and user ID or impersonation role ID. You must provide either the user ID or impersonation role ID. Impersonation role ID can only be used with Action EWS.

Public Method GetDefaultRetentionPolicy(GetDefaultRetentionPolicyRequest)

Gets the default retention policy details for the specified organization.

Public Method GetDefaultRetentionPolicyAsync(GetDefaultRetentionPolicyRequest, CancellationToken)

Gets the default retention policy details for the specified organization.

Public Method GetImpersonationRole(GetImpersonationRoleRequest)

Gets the impersonation role details for the given WorkMail organization.

Public Method GetImpersonationRoleAsync(GetImpersonationRoleRequest, CancellationToken)

Gets the impersonation role details for the given WorkMail organization.

Public Method GetImpersonationRoleEffect(GetImpersonationRoleEffectRequest)

Tests whether the given impersonation role can impersonate a target user.

Public Method GetImpersonationRoleEffectAsync(GetImpersonationRoleEffectRequest, CancellationToken)

Tests whether the given impersonation role can impersonate a target user.

Public Method GetMailboxDetails(GetMailboxDetailsRequest)

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

Public Method GetMailboxDetailsAsync(GetMailboxDetailsRequest, CancellationToken)

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

Public Method GetMailDomain(GetMailDomainRequest)

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

Public Method GetMailDomainAsync(GetMailDomainRequest, CancellationToken)

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

Public Method GetMobileDeviceAccessEffect(GetMobileDeviceAccessEffectRequest)

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 WorkMail organization for a particular user's attributes.

Public Method GetMobileDeviceAccessEffectAsync(GetMobileDeviceAccessEffectRequest, CancellationToken)

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 WorkMail organization for a particular user's attributes.

Public Method GetMobileDeviceAccessOverride(GetMobileDeviceAccessOverrideRequest)

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

Public Method GetMobileDeviceAccessOverrideAsync(GetMobileDeviceAccessOverrideRequest, CancellationToken)

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

Public Method ListAccessControlRules(ListAccessControlRulesRequest)

Lists the access control rules for the specified organization.

Public Method ListAccessControlRulesAsync(ListAccessControlRulesRequest, CancellationToken)

Lists the access control rules for the specified organization.

Public Method ListAliases(ListAliasesRequest)

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

Public Method ListAliasesAsync(ListAliasesRequest, CancellationToken)

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

Public Method ListAvailabilityConfigurations(ListAvailabilityConfigurationsRequest)

List all the AvailabilityConfiguration's for the given WorkMail organization.

Public Method ListAvailabilityConfigurationsAsync(ListAvailabilityConfigurationsRequest, CancellationToken)

List all the AvailabilityConfiguration's for the given WorkMail organization.

Public Method ListGroupMembers(ListGroupMembersRequest)

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

Public Method ListGroupMembersAsync(ListGroupMembersRequest, CancellationToken)

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

Public Method ListGroups(ListGroupsRequest)

Returns summaries of the organization's groups.

Public Method ListGroupsAsync(ListGroupsRequest, CancellationToken)

Returns summaries of the organization's groups.

Public Method ListGroupsForEntity(ListGroupsForEntityRequest)

Returns all the groups to which an entity belongs.

Public Method ListGroupsForEntityAsync(ListGroupsForEntityRequest, CancellationToken)

Returns all the groups to which an entity belongs.

Public Method ListImpersonationRoles(ListImpersonationRolesRequest)

Lists all the impersonation roles for the given WorkMail organization.

Public Method ListImpersonationRolesAsync(ListImpersonationRolesRequest, CancellationToken)

Lists all the impersonation roles for the given WorkMail organization.

Public Method ListMailboxExportJobs(ListMailboxExportJobsRequest)

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

Public Method ListMailboxExportJobsAsync(ListMailboxExportJobsRequest, CancellationToken)

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

Public Method ListMailboxPermissions(ListMailboxPermissionsRequest)

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

Public Method ListMailboxPermissionsAsync(ListMailboxPermissionsRequest, CancellationToken)

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

Public Method ListMailDomains(ListMailDomainsRequest)

Lists the mail domains in a given WorkMail organization.

Public Method ListMailDomainsAsync(ListMailDomainsRequest, CancellationToken)

Lists the mail domains in a given WorkMail organization.

Public Method ListMobileDeviceAccessOverrides(ListMobileDeviceAccessOverridesRequest)

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

Public Method ListMobileDeviceAccessOverridesAsync(ListMobileDeviceAccessOverridesRequest, CancellationToken)

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

Public Method ListMobileDeviceAccessRules(ListMobileDeviceAccessRulesRequest)

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

Public Method ListMobileDeviceAccessRulesAsync(ListMobileDeviceAccessRulesRequest, CancellationToken)

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

Public Method ListOrganizations(ListOrganizationsRequest)

Returns summaries of the customer's organizations.

Public Method ListOrganizationsAsync(ListOrganizationsRequest, CancellationToken)

Returns summaries of the customer's organizations.

Public Method ListResourceDelegates(ListResourceDelegatesRequest)

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

Public Method ListResourceDelegatesAsync(ListResourceDelegatesRequest, CancellationToken)

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

Public Method ListResources(ListResourcesRequest)

Returns summaries of the organization's resources.

Public Method ListResourcesAsync(ListResourcesRequest, CancellationToken)

Returns summaries of the organization's resources.

Public Method ListTagsForResource(ListTagsForResourceRequest)

Lists the tags applied to an WorkMail organization resource.

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

Lists the tags applied to an WorkMail organization resource.

Public Method ListUsers(ListUsersRequest)

Returns summaries of the organization's users.

Public Method ListUsersAsync(ListUsersRequest, CancellationToken)

Returns summaries of the organization's users.

Public Method PutAccessControlRule(PutAccessControlRuleRequest)

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, user IDs and impersonation IDs. Adding a new rule with the same name as an existing rule replaces the older rule.

Public Method PutAccessControlRuleAsync(PutAccessControlRuleRequest, CancellationToken)

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, user IDs and impersonation IDs. Adding a new rule with the same name as an existing rule replaces the older rule.

Public Method PutEmailMonitoringConfiguration(PutEmailMonitoringConfigurationRequest)

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

Public Method PutEmailMonitoringConfigurationAsync(PutEmailMonitoringConfigurationRequest, CancellationToken)

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

Public Method PutInboundDmarcSettings(PutInboundDmarcSettingsRequest)

Enables or disables a DMARC policy for a given organization.

Public Method PutInboundDmarcSettingsAsync(PutInboundDmarcSettingsRequest, CancellationToken)

Enables or disables a DMARC policy for a given organization.

Public Method PutMailboxPermissions(PutMailboxPermissionsRequest)

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

Public Method PutMailboxPermissionsAsync(PutMailboxPermissionsRequest, CancellationToken)

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

Public Method PutMobileDeviceAccessOverride(PutMobileDeviceAccessOverrideRequest)

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

Public Method PutMobileDeviceAccessOverrideAsync(PutMobileDeviceAccessOverrideRequest, CancellationToken)

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

Public Method PutRetentionPolicy(PutRetentionPolicyRequest)

Puts a retention policy to the specified organization.

Public Method PutRetentionPolicyAsync(PutRetentionPolicyRequest, CancellationToken)

Puts a retention policy to the specified organization.

Public Method RegisterMailDomain(RegisterMailDomainRequest)

Registers a new domain in 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.

Public Method RegisterMailDomainAsync(RegisterMailDomainRequest, CancellationToken)

Registers a new domain in 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.

Public Method RegisterToWorkMail(RegisterToWorkMailRequest)

Registers an existing and disabled user, group, or resource for 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.

Public Method RegisterToWorkMailAsync(RegisterToWorkMailRequest, CancellationToken)

Registers an existing and disabled user, group, or resource for 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.

Public Method ResetPassword(ResetPasswordRequest)

Allows the administrator to reset the password for a user.

Public Method ResetPasswordAsync(ResetPasswordRequest, CancellationToken)

Allows the administrator to reset the password for a user.

Public Method StartMailboxExportJob(StartMailboxExportJobRequest)

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 WorkMail Administrator Guide.

Public Method StartMailboxExportJobAsync(StartMailboxExportJobRequest, CancellationToken)

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 WorkMail Administrator Guide.

Public Method TagResource(TagResourceRequest)

Applies the specified tags to the specified WorkMailorganization resource.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

Applies the specified tags to the specified WorkMailorganization resource.

Public Method TestAvailabilityConfiguration(TestAvailabilityConfigurationRequest)

Performs a test on an availability provider to ensure that access is allowed. For EWS, it verifies the provided credentials can be used to successfully log in. For Lambda, it verifies that the Lambda function can be invoked and that the resource access policy was configured to deny anonymous access. An anonymous invocation is one done without providing either a SourceArn or SourceAccount header.

The request must contain either one provider definition (EwsProvider or LambdaProvider) or the DomainName parameter. If the DomainName parameter is provided, the configuration stored under the DomainName will be tested.

Public Method TestAvailabilityConfigurationAsync(TestAvailabilityConfigurationRequest, CancellationToken)

Performs a test on an availability provider to ensure that access is allowed. For EWS, it verifies the provided credentials can be used to successfully log in. For Lambda, it verifies that the Lambda function can be invoked and that the resource access policy was configured to deny anonymous access. An anonymous invocation is one done without providing either a SourceArn or SourceAccount header.

The request must contain either one provider definition (EwsProvider or LambdaProvider) or the DomainName parameter. If the DomainName parameter is provided, the configuration stored under the DomainName will be tested.

Public Method UntagResource(UntagResourceRequest)

Untags the specified tags from the specified WorkMail organization resource.

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Untags the specified tags from the specified WorkMail organization resource.

Public Method UpdateAvailabilityConfiguration(UpdateAvailabilityConfigurationRequest)

Updates an existing AvailabilityConfiguration for the given WorkMail organization and domain.

Public Method UpdateAvailabilityConfigurationAsync(UpdateAvailabilityConfigurationRequest, CancellationToken)

Updates an existing AvailabilityConfiguration for the given WorkMail organization and domain.

Public Method UpdateDefaultMailDomain(UpdateDefaultMailDomainRequest)

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.

Public Method UpdateDefaultMailDomainAsync(UpdateDefaultMailDomainRequest, CancellationToken)

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.

Public Method UpdateGroup(UpdateGroupRequest)

Updates attibutes in a group.

Public Method UpdateGroupAsync(UpdateGroupRequest, CancellationToken)

Updates attibutes in a group.

Public Method UpdateImpersonationRole(UpdateImpersonationRoleRequest)

Updates an impersonation role for the given WorkMail organization.

Public Method UpdateImpersonationRoleAsync(UpdateImpersonationRoleRequest, CancellationToken)

Updates an impersonation role for the given WorkMail organization.

Public Method UpdateMailboxQuota(UpdateMailboxQuotaRequest)

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

Public Method UpdateMailboxQuotaAsync(UpdateMailboxQuotaRequest, CancellationToken)

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

Public Method UpdateMobileDeviceAccessRule(UpdateMobileDeviceAccessRuleRequest)

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

Public Method UpdateMobileDeviceAccessRuleAsync(UpdateMobileDeviceAccessRuleRequest, CancellationToken)

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

Public Method UpdatePrimaryEmailAddress(UpdatePrimaryEmailAddressRequest)

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.

Public Method UpdatePrimaryEmailAddressAsync(UpdatePrimaryEmailAddressRequest, CancellationToken)

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.

Public Method UpdateResource(UpdateResourceRequest)

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.

Public Method UpdateResourceAsync(UpdateResourceRequest, CancellationToken)

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.

Public Method UpdateUser(UpdateUserRequest)

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

Public Method UpdateUserAsync(UpdateUserRequest, CancellationToken)

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

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5