Client

workmail

R Documentation

Amazon WorkMail¶

Description¶

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:

Listing and describing organizations
Managing users
Managing groups
Managing resources

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.

Usage¶

workmail(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- workmail(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

associate_delegate_to_resource: Adds a member (user or group) to the resource's set of delegates
associate_member_to_group: Adds a member (user or group) to the group's set
assume_impersonation_role: Assumes an impersonation role for the given WorkMail organization
cancel_mailbox_export_job: Cancels a mailbox export job
create_alias: Adds an alias to the set of a given member (user or group) of WorkMail
create_availability_configuration: Creates an AvailabilityConfiguration for the given WorkMail organization and domain
create_group: Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation
create_impersonation_role: Creates an impersonation role for the given WorkMail organization
create_mobile_device_access_rule: Creates a new mobile device access rule for the specified WorkMail organization
create_organization: Creates a new WorkMail organization
create_resource: Creates a new WorkMail resource
create_user: Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation
delete_access_control_rule: Deletes an access control rule for the specified WorkMail organization
delete_alias: Remove one or more specified aliases from a set of aliases for a given user
delete_availability_configuration: Deletes the AvailabilityConfiguration for the given WorkMail organization and domain
delete_email_monitoring_configuration: Deletes the email monitoring configuration for a specified organization
delete_group: Deletes a group from WorkMail
delete_impersonation_role: Deletes an impersonation role for the given WorkMail organization
delete_mailbox_permissions: Deletes permissions granted to a member (user or group)
delete_mobile_device_access_override: Deletes the mobile device access override for the given WorkMail organization, user, and device
delete_mobile_device_access_rule: Deletes a mobile device access rule for the specified WorkMail organization
delete_organization: Deletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the organization
delete_resource: Deletes the specified resource
delete_retention_policy: Deletes the specified retention policy from the specified organization
delete_user: Deletes a user from WorkMail and all subsequent systems
deregister_from_work_mail: Mark a user, group, or resource as no longer used in WorkMail
deregister_mail_domain: Removes a domain from WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail use; Describes the current email monitoring configuration for a specified organization
describe_entity: Returns basic details about an entity in WorkMail
describe_group: Returns the data available for the group
describe_inbound_dmarc_settings: Lists the settings in a DMARC policy for a specified organization
describe_mailbox_export_job: Describes the current status of a mailbox export job
describe_organization: Provides more information regarding a given organization based on its identifier
describe_resource: Returns the data available for the resource
describe_user: Provides information regarding the user
disassociate_delegate_from_resource: Removes a member from the resource's set of delegates
disassociate_member_from_group: Removes a member from a group
get_access_control_effect: 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
get_default_retention_policy: Gets the default retention policy details for the specified organization
get_impersonation_role: Gets the impersonation role details for the given WorkMail organization
get_impersonation_role_effect: Tests whether the given impersonation role can impersonate a target user
get_mailbox_details: Requests a user's mailbox details for a specified organization and user
get_mail_domain: Gets details for a mail domain, including domain records required to configure your domain with recommended security
get_mobile_device_access_effect: Simulates the effect of the mobile device access rules for the given attributes of a sample access event
get_mobile_device_access_override: Gets the mobile device access override for the given WorkMail organization, user, and device
list_access_control_rules: Lists the access control rules for the specified organization
list_aliases: Creates a paginated call to list the aliases associated with a given entity
list_availability_configurations: List all the AvailabilityConfiguration's for the given WorkMail organization
list_group_members: Returns an overview of the members of a group
list_groups: Returns summaries of the organization's groups
list_groups_for_entity: Returns all the groups to which an entity belongs
list_impersonation_roles: Lists all the impersonation roles for the given WorkMail organization
list_mailbox_export_jobs: Lists the mailbox export jobs started for the specified organization within the last seven days
list_mailbox_permissions: Lists the mailbox permissions associated with a user, group, or resource mailbox
list_mail_domains: Lists the mail domains in a given WorkMail organization
list_mobile_device_access_overrides: Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device
list_mobile_device_access_rules: Lists the mobile device access rules for the specified WorkMail organization
list_organizations: Returns summaries of the customer's organizations
list_resource_delegates: Lists the delegates associated with a resource
list_resources: Returns summaries of the organization's resources
list_tags_for_resource: Lists the tags applied to an WorkMail organization resource
list_users: Returns summaries of the organization's users
put_access_control_rule: Adds a new access control rule for the specified organization
put_email_monitoring_configuration: Creates or updates the email monitoring configuration for a specified organization
put_inbound_dmarc_settings: Enables or disables a DMARC policy for a given organization
put_mailbox_permissions: Sets permissions for a user, group, or resource
put_mobile_device_access_override: Creates or updates a mobile device access override for the given WorkMail organization, user, and device
put_retention_policy: Puts a retention policy to the specified organization
register_mail_domain: Registers a new domain in WorkMail and SES, and configures it for use by WorkMail
register_to_work_mail: Registers an existing and disabled user, group, or resource for WorkMail use by associating a mailbox and calendaring capabilities
reset_password: Allows the administrator to reset the password for a user
start_mailbox_export_job: 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
tag_resource: Applies the specified tags to the specified WorkMailorganization resource
test_availability_configuration: Performs a test on an availability provider to ensure that access is allowed
untag_resource: Untags the specified tags from the specified WorkMail organization resource
update_availability_configuration: Updates an existing AvailabilityConfiguration for the given WorkMail organization and domain
update_default_mail_domain: Updates the default mail domain for an organization
update_group: Updates attibutes in a group
update_impersonation_role: Updates an impersonation role for the given WorkMail organization
update_mailbox_quota: Updates a user's current mailbox quota for a specified organization and user
update_mobile_device_access_rule: Updates a mobile device access rule for the specified WorkMail organization
update_primary_email_address: Updates the primary email for a user, group, or resource
update_resource: Updates data for the resource
update_user: Updates data for the user

Examples¶

## Not run: 
svc <- workmail()
svc$associate_delegate_to_resource(
  Foo = 123
)

## End(Not run)