putMailboxPermissions method

Future<void> putMailboxPermissions({ required String entityId, required String granteeId, required String organizationId, required List<PermissionType> permissionValues, })

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

May throw EntityNotFoundException. May throw EntityStateException. May throw InvalidParameterException. May throw OrganizationNotFoundException. May throw OrganizationStateException.

Parameter entityId : The identifier of the user, group, or resource for which to update mailbox permissions.

Parameter granteeId : The identifier of the user, group, or resource to which to grant the permissions.

Parameter organizationId : The identifier of the organization under which the user, group, or resource exists.

Parameter permissionValues : The permissions granted to the grantee. SEND_AS allows the grantee to send email as the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not mentioned as the physical sender of these emails). FULL_ACCESS allows the grantee full access to the mailbox, irrespective of other folder-level permissions set on the mailbox.

Implementation

Future<void> putMailboxPermissions({
  required String entityId,
  required String granteeId,
  required String organizationId,
  required List<PermissionType> permissionValues,
}) async {
  ArgumentError.checkNotNull(entityId, 'entityId');
  _s.validateStringLength(
    'entityId',
    entityId,
    12,
    256,
    isRequired: true,
  );
  ArgumentError.checkNotNull(granteeId, 'granteeId');
  _s.validateStringLength(
    'granteeId',
    granteeId,
    12,
    256,
    isRequired: true,
  );
  ArgumentError.checkNotNull(organizationId, 'organizationId');
  _s.validateStringLength(
    'organizationId',
    organizationId,
    34,
    34,
    isRequired: true,
  );
  ArgumentError.checkNotNull(permissionValues, 'permissionValues');
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'WorkMailService.PutMailboxPermissions'
  };
  await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'EntityId': entityId,
      'GranteeId': granteeId,
      'OrganizationId': organizationId,
      'PermissionValues': permissionValues.map((e) => e.toValue()).toList(),
    },
  );
}