WorkMailClient Class

Member Function Documentation

WorkMailClient::WorkMailClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a WorkMailClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

WorkMailClient::WorkMailClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads WorkMailClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] AssociateDelegateToResourceResponse *WorkMailClient::associateDelegateToResource(const AssociateDelegateToResourceRequest &request)

Sends request to the WorkMailClient service, and returns a pointer to an AssociateDelegateToResourceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Adds a member to the resource's set of

[slot] AssociateMemberToGroupResponse *WorkMailClient::associateMemberToGroup(const AssociateMemberToGroupRequest &request)

Sends request to the WorkMailClient service, and returns a pointer to an AssociateMemberToGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Adds a member to the group's

[slot] CreateAliasResponse *WorkMailClient::createAlias(const CreateAliasRequest &request)

Sends request to the WorkMailClient service, and returns a pointer to an CreateAliasResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Adds an alias to the set of a given member of Amazon

[slot] CreateGroupResponse *WorkMailClient::createGroup(const CreateGroupRequest &request)

Sends request to the WorkMailClient service, and returns a pointer to an CreateGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] CreateResourceResponse *WorkMailClient::createResource(const CreateResourceRequest &request)

Sends request to the WorkMailClient service, and returns a pointer to an CreateResourceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a new Amazon WorkMail resource. The available types are equipment and

[slot] CreateUserResponse *WorkMailClient::createUser(const CreateUserRequest &request)

Sends request to the WorkMailClient service, and returns a pointer to an CreateUserResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DeleteAliasResponse *WorkMailClient::deleteAlias(const DeleteAliasRequest &request)

Sends request to the WorkMailClient service, and returns a pointer to an DeleteAliasResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Remove the alias from a set of aliases for a given

[slot] DeleteGroupResponse *WorkMailClient::deleteGroup(const DeleteGroupRequest &request)

Sends request to the WorkMailClient service, and returns a pointer to an DeleteGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes a group from Amazon

[slot] DeleteMailboxPermissionsResponse *WorkMailClient::deleteMailboxPermissions(const DeleteMailboxPermissionsRequest &request)

Sends request to the WorkMailClient service, and returns a pointer to an DeleteMailboxPermissionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes permissions granted to a user or

[slot] DeleteResourceResponse *WorkMailClient::deleteResource(const DeleteResourceRequest &request)

Sends request to the WorkMailClient service, and returns a pointer to an DeleteResourceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the specified resource.

[slot] DeleteUserResponse *WorkMailClient::deleteUser(const DeleteUserRequest &request)

Sends request to the WorkMailClient service, and returns a pointer to an DeleteUserResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes a user from Amazon WorkMail and all subsequent systems. The action can't be undone. The mailbox is kept as-is for a minimum of 30 days, without any means to restore it.

[slot] DeregisterFromWorkMailResponse *WorkMailClient::deregisterFromWorkMail(const DeregisterFromWorkMailRequest &request)

Sends request to the WorkMailClient service, and returns a pointer to an DeregisterFromWorkMailResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DescribeGroupResponse *WorkMailClient::describeGroup(const DescribeGroupRequest &request)

Sends request to the WorkMailClient service, and returns a pointer to an DescribeGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns the data available for the

[slot] DescribeOrganizationResponse *WorkMailClient::describeOrganization(const DescribeOrganizationRequest &request)

Sends request to the WorkMailClient service, and returns a pointer to an DescribeOrganizationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Provides more information regarding a given organization based on its

[slot] DescribeResourceResponse *WorkMailClient::describeResource(const DescribeResourceRequest &request)

Sends request to the WorkMailClient service, and returns a pointer to an DescribeResourceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns the data available for the

[slot] DescribeUserResponse *WorkMailClient::describeUser(const DescribeUserRequest &request)

Sends request to the WorkMailClient service, and returns a pointer to an DescribeUserResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Provides information regarding the

[slot] DisassociateDelegateFromResourceResponse *WorkMailClient::disassociateDelegateFromResource(const DisassociateDelegateFromResourceRequest &request)

Sends request to the WorkMailClient service, and returns a pointer to an DisassociateDelegateFromResourceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Removes a member from the resource's set of

[slot] DisassociateMemberFromGroupResponse *WorkMailClient::disassociateMemberFromGroup(const DisassociateMemberFromGroupRequest &request)

Sends request to the WorkMailClient service, and returns a pointer to an DisassociateMemberFromGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Removes a member from a

[slot] ListAliasesResponse *WorkMailClient::listAliases(const ListAliasesRequest &request)

Sends request to the WorkMailClient service, and returns a pointer to an ListAliasesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] ListGroupMembersResponse *WorkMailClient::listGroupMembers(const ListGroupMembersRequest &request)

Sends request to the WorkMailClient service, and returns a pointer to an ListGroupMembersResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns an overview of the members of a

[slot] ListGroupsResponse *WorkMailClient::listGroups(const ListGroupsRequest &request)

Sends request to the WorkMailClient service, and returns a pointer to an ListGroupsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns summaries of the organization's

[slot] ListMailboxPermissionsResponse *WorkMailClient::listMailboxPermissions(const ListMailboxPermissionsRequest &request)

Sends request to the WorkMailClient service, and returns a pointer to an ListMailboxPermissionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the mailbox permissions associated with a

[slot] ListOrganizationsResponse *WorkMailClient::listOrganizations(const ListOrganizationsRequest &request)

Sends request to the WorkMailClient service, and returns a pointer to an ListOrganizationsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns summaries of the customer's non-deleted

[slot] ListResourceDelegatesResponse *WorkMailClient::listResourceDelegates(const ListResourceDelegatesRequest &request)

Sends request to the WorkMailClient service, and returns a pointer to an ListResourceDelegatesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] ListResourcesResponse *WorkMailClient::listResources(const ListResourcesRequest &request)

Sends request to the WorkMailClient service, and returns a pointer to an ListResourcesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns summaries of the organization's

[slot] ListUsersResponse *WorkMailClient::listUsers(const ListUsersRequest &request)

Sends request to the WorkMailClient service, and returns a pointer to an ListUsersResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns summaries of the organization's

[slot] PutMailboxPermissionsResponse *WorkMailClient::putMailboxPermissions(const PutMailboxPermissionsRequest &request)

Sends request to the WorkMailClient service, and returns a pointer to an PutMailboxPermissionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Sets permissions for a user or group. This replaces any pre-existing permissions set for the

[slot] RegisterToWorkMailResponse *WorkMailClient::registerToWorkMail(const RegisterToWorkMailRequest &request)

Sends request to the WorkMailClient service, and returns a pointer to an RegisterToWorkMailResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Registers an existing and disabled user, group, or resource/entity for Amazon WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the entity is enabled and fails if the entity is deleted. This operation results in the accumulation of costs. For more information, see <a href="http://aws.amazon.com/workmail/pricing">Pricing</a>. The equivalent console functionality for this operation is <i>Enable</i>. Users can either be created by calling the CreateUser API or they can be synchronized from your directory. For more information, see

[slot] ResetPasswordResponse *WorkMailClient::resetPassword(const ResetPasswordRequest &request)

Sends request to the WorkMailClient service, and returns a pointer to an ResetPasswordResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Allows the administrator to reset the password for a

[slot] UpdatePrimaryEmailAddressResponse *WorkMailClient::updatePrimaryEmailAddress(const UpdatePrimaryEmailAddressRequest &request)

Sends request to the WorkMailClient service, and returns a pointer to an UpdatePrimaryEmailAddressResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates the primary email for an entity. 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

[slot] UpdateResourceResponse *WorkMailClient::updateResource(const UpdateResourceRequest &request)

Sends request to the WorkMailClient service, and returns a pointer to an UpdateResourceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates data for the resource. It must be preceded by a describe call in order to have the latest information. The dataset in the request should be the one expected when performing another describe