Amazon 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.
\n\n## Installing\n\nTo install the this package using NPM, simply type the following into a terminal window:\n\n```\nnpm install @aws-sdk/client-workmail-browser\n```\n\n## Getting Started\n\n### Import\n\nThe AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(`WorkMailClient`) and the commands you need, for example `AssociateDelegateToResourceCommand`:\n\n```javascript\n//JavaScript\nconst {\n WorkMailClient\n} = require(\"@aws-sdk/client-workmail-browser/WorkMailClient\");\nconst {\n AssociateDelegateToResourceCommand\n} = require(\"@aws-sdk/client-workmail-browser/commands/AssociateDelegateToResourceCommand\");\n```\n\n```javascript\n//TypeScript\nimport { WorkMailClient } from \"@aws-sdk/client-workmail-browser/WorkMailClient\";\nimport { AssociateDelegateToResourceCommand } from \"@aws-sdk/client-workmail-browser/commands/AssociateDelegateToResourceCommand\";\n```\n\n### Usage\n\nTo send a request, you:\n\n- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].\n- Initiate command with input parameters.\n- Call `send` operation on client with command object as input.\n- If you are using a custom http handler, you may call `destroy()` to close open connections.\n\n```javascript\nconst workMail = new WorkMailClient({region: 'region'});\n//clients can be shared by different commands\nconst params = {\n OrganizationId: /**a string value*/,\n ResourceId: /**a string value*/,\n EntityId: /**a string value*/,\n};\nconst associateDelegateToResourceCommand = new AssociateDelegateToResourceCommand(params);\nworkMail.send(associateDelegateToResourceCommand).then(data => {\n // do something\n}).catch(error => {\n // error handling\n})\n```\n\nIn addition to using promises, there are 2 other ways to send a request:\n\n```javascript\n// async/await\ntry {\n const data = await workMail.send(associateDelegateToResourceCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\nworkMail.send(associateDelegateToResourceCommand, (err, data) => {\n //do something\n});\n```\n\nThe SDK can also send requests using the simplified callback style from version 2 of the SDK.\n\n```javascript\nimport * as AWS from \"@aws-sdk/@aws-sdk/client-workmail-browser/WorkMail\";\nconst workMail = new AWS.WorkMail({ region: \"region\" });\nworkMail.associateDelegateToResource(params, (err, data) => {\n //do something\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).\n\n```javascript\ntry {\n const data = await workMail.send(associateDelegateToResourceCommand);\n // do something\n} catch (error) {\n const metadata = error.$metadata;\n console.log(\n `requestId: ${metadata.requestId}\ncfId: ${metadata.cfId}\nextendedRequestId: ${metadata.extendedRequestId}`\n );\n /*\nThe keys within exceptions are also parsed. You can access them by specifying exception names:\n if(error.name === 'SomeServiceException') {\n const value = error.specialKeyInException;\n }\n*/\n}\n```\n\n## Getting Help\n\nPlease use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.\n\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`\n- Come join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3)\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues)\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-workmail-browser' package is updated. To contribute to SDK you can checkout our [code generator package][].\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n[code generator package]: https://github.com/aws/aws-sdk-js-v3/tree/master/packages/service-types-generator\n[api reference]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/\n","scripts":{"test":"exit 0","clean":"npm run remove-definitions && npm run remove-maps && npm run remove-js","pretest":"tsc","remove-js":"rimraf *.js && rimraf ./commands/*.js && rimraf ./model/*.js && rimraf ./types/*.js","smoke-test":"karma start karma.conf","remove-maps":"rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./model/*.js.map && rimraf ./types/*.js.map","prepublishOnly":"tsc","remove-definitions":"rimraf *.d.ts && rimraf ./commands/*.d.ts && rimraf ./model/*.d.ts rimraf ./types/*.d.ts","build-documentation":"npm run clean && typedoc ./","remove-documentation":"rimraf ./docs"},"_npmUser":{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},"deprecated":"The package @aws-sdk/client-workmail-browser has been renamed to @aws-sdk/client-workmail. Please install the renamed package.","_npmVersion":"6.9.0","description":"Browser SDK for Amazon WorkMail","directories":{},"_nodeVersion":"10.1.0","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.5","@aws-sdk/json-parser":"^0.1.0-preview.5","@aws-sdk/core-handler":"^0.1.0-preview.5","@aws-sdk/json-builder":"^0.1.0-preview.5","@aws-sdk/signature-v4":"^0.1.0-preview.7","@aws-sdk/config-resolver":"^0.1.0-preview.5","@aws-sdk/middleware-stack":"^0.1.0-preview.6","@aws-sdk/retry-middleware":"^0.1.0-preview.5","@aws-crypto/sha256-browser":"^0.1.0-preview.1","@aws-sdk/protocol-json-rpc":"^0.1.0-preview.6","@aws-sdk/util-utf8-browser":"^0.1.0-preview.3","@aws-sdk/fetch-http-handler":"^0.1.0-preview.5","@aws-sdk/signing-middleware":"^0.1.0-preview.7","@aws-sdk/url-parser-browser":"^0.1.0-preview.5","@aws-sdk/util-base64-browser":"^0.1.0-preview.3","@aws-sdk/middleware-serializer":"^0.1.0-preview.5","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.6","@aws-sdk/util-user-agent-browser":"^0.1.0-preview.6","@aws-sdk/stream-collector-browser":"^0.1.0-preview.5","@aws-sdk/util-body-length-browser":"^0.1.0-preview.3","@aws-sdk/middleware-content-length":"^0.1.0-preview.5","@aws-sdk/middleware-header-default":"^0.1.0-preview.5"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"rimraf":"^2.6.2","typedoc":"^0.14.2","typescript":"~3.4.0","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-workmail-browser_0.1.0-preview.3_1568908770127_0.763363908143766","host":"s3://npm-registry-packages"}},"0.1.0-preview.4":{"name":"@aws-sdk/client-workmail-browser","version":"0.1.0-preview.4","author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","_id":"@aws-sdk/client-workmail-browser@0.1.0-preview.4","maintainers":[{"name":"amzn-oss","email":"osa-3p@amazon.com"},{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},{"name":"trivikr-aws","email":"trivikr@amazon.com"},{"name":"zheallan","email":"zheallan@amazon.com"}],"dist":{"shasum":"7af8e5f8ef67a248237ae645dbfbad79849a9b45","tarball":"https://registry.npmjs.org/@aws-sdk/client-workmail-browser/-/client-workmail-browser-0.1.0-preview.4.tgz","fileCount":890,"integrity":"sha512-s+PcYFLwPrT9InQC2udWWuxLtODqJFkxd6T9FETVpHI0fDwAV/LQpGw208v5bFTY8+JUf5hT9VLT+jI8oM1ExQ==","signatures":[{"sig":"MEYCIQDAuveMgF0kCGXLU5ENjzSiGpk+EyFgY8w0vYDNkgMAwwIhAL4A8PgI2i1tytN2744cz/WA8o8cEOrSd9ngjPFyfdmi","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":546863,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJduM+sCRA9TVsSAnZWagAAgwAP/1l3Qq4p5NzcUJY9qO8D\nax1KxuMqDX5xzSSDarimx/lgTO6r0PMP46W3ifxrp7hGEhVrF+VU03p4OhV/\nz07wuIqfGZDavKNhHstI8sHtYnchFX+aFeAtuI4MaHptuyK2dDARDwfkOZwm\nhrP6qQZVN4QRdSvMsenLCvRS7Eg2ytCr2X7am7ud5x+LVfxOLPWH72q6qUsy\nAMJcYMcvVVcl9SSr8Wlwh0zIZjFx8UYblyJVt7pdsnv1flJLNGIRUNNAMxQx\nsJfHlFfeFFmTKgILyB5iy14Ti+Y/1+0oTlkwq8MXPkJmMnSHmN7e1LYv3e4w\nHpbCLY1AH5u2bOLVh5yiy3bkkdfH1cv8UV+vzr6b1hTZ/jX/HzEBGAtxlxBq\n68pi7+1DAvwyJCHt5oq0ClwmepIPqWsPXQzijsj9mmv+1JDfEkQoH/TNeEnY\ncbqgBtgsno+tjSSPf13EX3kyPBU9bFovDsFSCp7rivK79rQL69UvsxJ+D8Jj\nqbrEuKPmzcitBS7TmiEgzv/sZ8uF9caLK7TDPvqHDWkdTKrwmEyMEPfAWSbs\n0N7QnKj5mfV1uSgwx/G1UbrLKvI+FanNHKTkq8krkKqyVy13PEeBOauxgyv1\nYBFdyrDFX+ABbHhW3Z/Y9+HLAwwnjo9q8D+4O5jwfmYoHnR7aTDEbmMx5tG5\nChyp\r\n=t8iU\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./index.js","types":"./index.d.ts","readme":"# @aws-sdk/client-workmail-browser\n\n[](https://www.npmjs.com/package/@aws-sdk/client-workmail-browser)\n[](https://www.npmjs.com/package/@aws-sdk/client-workmail-browser)\n\n## Description\n\nAmazon 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.
\n\n## Installing\n\nTo install the this package using NPM, simply type the following into a terminal window:\n\n```\nnpm install @aws-sdk/client-workmail-browser\n```\n\n## Getting Started\n\n### Import\n\nThe AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(`WorkMailClient`) and the commands you need, for example `AssociateDelegateToResourceCommand`:\n\n```javascript\n//JavaScript\nconst {\n WorkMailClient,\n AssociateDelegateToResourceCommand\n} = require(\"@aws-sdk/client-workmail-browser\");\n```\n\n```javascript\n//TypeScript\nimport {\n WorkMailClient,\n AssociateDelegateToResourceCommand\n} from \"@aws-sdk/client-workmail-browser\";\n```\n\n### Usage\n\nTo send a request, you:\n\n- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].\n- Initiate command with input parameters.\n- Call `send` operation on client with command object as input.\n- If you are using a custom http handler, you may call `destroy()` to close open connections.\n\n```javascript\nconst workMail = new WorkMailClient({region: 'region'});\n//clients can be shared by different commands\nconst params = {\n OrganizationId: /**a string value*/,\n ResourceId: /**a string value*/,\n EntityId: /**a string value*/,\n};\nconst associateDelegateToResourceCommand = new AssociateDelegateToResourceCommand(params);\nworkMail.send(associateDelegateToResourceCommand).then(data => {\n // do something\n}).catch(error => {\n // error handling\n})\n```\n\nIn addition to using promises, there are 2 other ways to send a request:\n\n```javascript\n// async/await\ntry {\n const data = await workMail.send(associateDelegateToResourceCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\nworkMail.send(associateDelegateToResourceCommand, (err, data) => {\n //do something\n});\n```\n\nThe SDK can also send requests using the simplified callback style from version 2 of the SDK.\n\n```javascript\nimport * as AWS from \"@aws-sdk/client-workmail-browser\";\nconst workMail = new AWS.WorkMail({ region: \"region\" });\nworkMail.associateDelegateToResource(params, (err, data) => {\n //do something\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).\n\n```javascript\ntry {\n const data = await workMail.send(associateDelegateToResourceCommand);\n // do something\n} catch (error) {\n const metadata = error.$metadata;\n console.log(\n `requestId: ${metadata.requestId}\ncfId: ${metadata.cfId}\nextendedRequestId: ${metadata.extendedRequestId}`\n );\n /*\nThe keys within exceptions are also parsed. You can access them by specifying exception names:\n if(error.name === 'SomeServiceException') {\n const value = error.specialKeyInException;\n }\n*/\n}\n```\n\n## Getting Help\n\nPlease use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.\n\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`\n- Come join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3)\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues)\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-workmail-browser' package is updated. To contribute to SDK you can checkout our [code generator package][].\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n[code generator package]: https://github.com/aws/aws-sdk-js-v3/tree/master/packages/service-types-generator\n[api reference]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/\n","scripts":{"test":"exit 0","clean":"npm run remove-definitions && npm run remove-maps && npm run remove-js","pretest":"tsc","remove-js":"rimraf *.js && rimraf ./commands/*.js && rimraf ./model/*.js && rimraf ./types/*.js","smoke-test":"karma start karma.conf","remove-maps":"rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./model/*.js.map && rimraf ./types/*.js.map","prepublishOnly":"tsc","remove-definitions":"rimraf *.d.ts && rimraf ./commands/*.d.ts && rimraf ./model/*.d.ts rimraf ./types/*.d.ts","build-documentation":"npm run clean && typedoc ./","remove-documentation":"rimraf ./docs"},"_npmUser":{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},"deprecated":"The package @aws-sdk/client-workmail-browser has been renamed to @aws-sdk/client-workmail. Please install the renamed package.","_npmVersion":"6.9.0","description":"Browser SDK for Amazon WorkMail","directories":{},"_nodeVersion":"10.1.0","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.6","@aws-sdk/json-parser":"^0.1.0-preview.6","@aws-sdk/core-handler":"^0.1.0-preview.6","@aws-sdk/json-builder":"^0.1.0-preview.6","@aws-sdk/signature-v4":"^0.1.0-preview.8","@aws-sdk/config-resolver":"^0.1.0-preview.6","@aws-sdk/middleware-stack":"^0.1.0-preview.7","@aws-sdk/retry-middleware":"^0.1.0-preview.6","@aws-crypto/sha256-browser":"^0.1.0-preview.1","@aws-sdk/protocol-json-rpc":"^0.1.0-preview.7","@aws-sdk/util-utf8-browser":"^0.1.0-preview.3","@aws-sdk/fetch-http-handler":"^0.1.0-preview.6","@aws-sdk/signing-middleware":"^0.1.0-preview.8","@aws-sdk/url-parser-browser":"^0.1.0-preview.6","@aws-sdk/util-base64-browser":"^0.1.0-preview.3","@aws-sdk/middleware-serializer":"^0.1.0-preview.6","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.7","@aws-sdk/util-user-agent-browser":"^0.1.0-preview.7","@aws-sdk/stream-collector-browser":"^0.1.0-preview.6","@aws-sdk/util-body-length-browser":"^0.1.0-preview.3","@aws-sdk/middleware-content-length":"^0.1.0-preview.6","@aws-sdk/middleware-header-default":"^0.1.0-preview.6"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"rimraf":"^2.6.2","typedoc":"^0.14.2","typescript":"~3.4.0","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-workmail-browser_0.1.0-preview.4_1572392875976_0.1270164734528354","host":"s3://npm-registry-packages"}},"0.1.0-preview.5":{"name":"@aws-sdk/client-workmail-browser","version":"0.1.0-preview.5","author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","_id":"@aws-sdk/client-workmail-browser@0.1.0-preview.5","maintainers":[{"name":"amzn-oss","email":"osa-3p@amazon.com"},{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},{"name":"trivikr-aws","email":"trivikr@amazon.com"},{"name":"zheallan","email":"zheallan@amazon.com"}],"dist":{"shasum":"21167ce53df2b8f1f409faf6166acf3b39318296","tarball":"https://registry.npmjs.org/@aws-sdk/client-workmail-browser/-/client-workmail-browser-0.1.0-preview.5.tgz","fileCount":890,"integrity":"sha512-K7RL1VQEpAmtLehHZz8UqYNFnJnBfjAdRVcNv+jTfHocFdpmtktngEq+oJpPveihf2EvJ8iUjQmtVAHeM/zdAg==","signatures":[{"sig":"MEUCIBRmPms5NHXmHbaZvJJheVszJZGSFbwZJbO9i4URcRZ1AiEA669aPqsPTj9qRphzUaxRysXX9m79SYrVqHspNHNO/Q0=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":547107,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdueKjCRA9TVsSAnZWagAA1kAQAIb8Nib+9uRAWXDHYlxX\nSpzuMkRqTGP/Eit9ap4H9OC6qoo8ROJS2C5plecUhRMhUdQVHdLXcxmD3K+D\nUhGkZjdnsYiyyV6gNgSZm+qxMMzZeaNyD/eToSX5frAIJeQ53NY2+QmyIc94\nHrGtVeG0x/c6r+5x+qqfH27+3RxV8IE2AGUftlk2e1/BHApIE72rUfX4mNE2\nlXdUNTtoJHJjt6IAO8FcTaGgl21Jc7Sw35wZ6PE/WfgsHDDdPGEXlEj6LcgO\nm1GyGb1jz9PbLZWAarxbC2pvyE02f7rjAHrn2ijj0Hj/TUd7Z4+8fyv5auEO\n45eflJ+3GeSLQTlBTMHyTFGZSABwX6h7nWx0LpharmscO2wOfEWEUUxrPK/h\n1rq6bUdEFFS/y360N/wUlhmeCnIin4FMV4JCeVSWuHIR6r3bCtaYhPul4rPG\nQlw7jK9xi2Y0lWYB3bveYFi2t+A7U27QCAHD3kPbliTaQXjbS9PZ0oj4ZTPn\nYw4Fzfl4/fTk0o4vjdMSbGHBzEd2GPpdUpqO24EKcMZqCBfcwfYn/rbovlTd\nCdAH7O793edwaqkw216tgWVhrd8asl0+sk0whHzPjDmyLmFSbL0SCz9I4d0a\nef/FiAdJ2VxciwTqB1gmeTYN3B1ze2obbSKzLoLHwALAectHfFgOLaYnl3Fh\nWz5s\r\n=mIBH\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./index.js","types":"./index.d.ts","readme":"# @aws-sdk/client-workmail-browser\n\n[](https://www.npmjs.com/package/@aws-sdk/client-workmail-browser)\n[](https://www.npmjs.com/package/@aws-sdk/client-workmail-browser)\n\n## Description\n\nAmazon 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.
\n\n## Installing\n\nTo install the this package using NPM, simply type the following into a terminal window:\n\n```\nnpm install @aws-sdk/client-workmail-browser\n```\n\n## Getting Started\n\n### Import\n\nThe AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(`WorkMailClient`) and the commands you need, for example `AssociateDelegateToResourceCommand`:\n\n```javascript\n//JavaScript\nconst {\n WorkMailClient,\n AssociateDelegateToResourceCommand\n} = require(\"@aws-sdk/client-workmail-browser\");\n```\n\n```javascript\n//TypeScript\nimport {\n WorkMailClient,\n AssociateDelegateToResourceCommand\n} from \"@aws-sdk/client-workmail-browser\";\n```\n\n### Usage\n\nTo send a request, you:\n\n- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].\n- Initiate command with input parameters.\n- Call `send` operation on client with command object as input.\n- If you are using a custom http handler, you may call `destroy()` to close open connections.\n\n```javascript\nconst workMail = new WorkMailClient({region: 'region'});\n//clients can be shared by different commands\nconst params = {\n OrganizationId: /**a string value*/,\n ResourceId: /**a string value*/,\n EntityId: /**a string value*/,\n};\nconst associateDelegateToResourceCommand = new AssociateDelegateToResourceCommand(params);\nworkMail.send(associateDelegateToResourceCommand).then(data => {\n // do something\n}).catch(error => {\n // error handling\n})\n```\n\nIn addition to using promises, there are 2 other ways to send a request:\n\n```javascript\n// async/await\ntry {\n const data = await workMail.send(associateDelegateToResourceCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\nworkMail.send(associateDelegateToResourceCommand, (err, data) => {\n //do something\n});\n```\n\nThe SDK can also send requests using the simplified callback style from version 2 of the SDK.\n\n```javascript\nimport * as AWS from \"@aws-sdk/client-workmail-browser\";\nconst workMail = new AWS.WorkMail({ region: \"region\" });\nworkMail.associateDelegateToResource(params, (err, data) => {\n //do something\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).\n\n```javascript\ntry {\n const data = await workMail.send(associateDelegateToResourceCommand);\n // do something\n} catch (error) {\n const metadata = error.$metadata;\n console.log(\n `requestId: ${metadata.requestId}\ncfId: ${metadata.cfId}\nextendedRequestId: ${metadata.extendedRequestId}`\n );\n /*\nThe keys within exceptions are also parsed. You can access them by specifying exception names:\n if(error.name === 'SomeServiceException') {\n const value = error.specialKeyInException;\n }\n*/\n}\n```\n\n## Getting Help\n\nPlease use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.\n\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`\n- Come join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3)\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues)\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-workmail-browser' package is updated. To contribute to SDK you can checkout our [code generator package][].\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n[code generator package]: https://github.com/aws/aws-sdk-js-v3/tree/master/packages/service-types-generator\n[api reference]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/\n","scripts":{"test":"exit 0","clean":"npm run remove-definitions && npm run remove-maps && npm run remove-js","pretest":"tsc","remove-js":"rimraf *.js && rimraf ./commands/*.js && rimraf ./model/*.js && rimraf ./types/*.js","smoke-test":"karma start karma.conf","remove-maps":"rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./model/*.js.map && rimraf ./types/*.js.map","prepublishOnly":"tsc","remove-definitions":"rimraf *.d.ts && rimraf ./commands/*.d.ts && rimraf ./model/*.d.ts rimraf ./types/*.d.ts","build-documentation":"npm run clean && typedoc ./","remove-documentation":"rimraf ./docs"},"_npmUser":{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},"deprecated":"The package @aws-sdk/client-workmail-browser has been renamed to @aws-sdk/client-workmail. Please install the renamed package.","_npmVersion":"6.9.0","description":"Browser SDK for Amazon WorkMail","directories":{},"_nodeVersion":"10.1.0","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.7","@aws-sdk/json-parser":"^0.1.0-preview.7","@aws-sdk/core-handler":"^0.1.0-preview.7","@aws-sdk/json-builder":"^0.1.0-preview.7","@aws-sdk/signature-v4":"^0.1.0-preview.9","@aws-sdk/config-resolver":"^0.1.0-preview.7","@aws-sdk/middleware-stack":"^0.1.0-preview.8","@aws-sdk/retry-middleware":"^0.1.0-preview.7","@aws-crypto/sha256-browser":"^0.1.0-preview.1","@aws-sdk/protocol-json-rpc":"^0.1.0-preview.8","@aws-sdk/util-utf8-browser":"^0.1.0-preview.3","@aws-sdk/fetch-http-handler":"^0.1.0-preview.7","@aws-sdk/signing-middleware":"^0.1.0-preview.9","@aws-sdk/url-parser-browser":"^0.1.0-preview.7","@aws-sdk/util-base64-browser":"^0.1.0-preview.3","@aws-sdk/middleware-serializer":"^0.1.0-preview.7","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.8","@aws-sdk/util-user-agent-browser":"^0.1.0-preview.8","@aws-sdk/stream-collector-browser":"^0.1.0-preview.7","@aws-sdk/util-body-length-browser":"^0.1.0-preview.3","@aws-sdk/middleware-content-length":"^0.1.0-preview.7","@aws-sdk/middleware-header-default":"^0.1.0-preview.7"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"rimraf":"^2.6.2","typedoc":"^0.14.2","typescript":"~3.4.0","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-workmail-browser_0.1.0-preview.5_1572463267369_0.5298945723562265","host":"s3://npm-registry-packages"}},"0.1.0-preview.6":{"name":"@aws-sdk/client-workmail-browser","version":"0.1.0-preview.6","author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","_id":"@aws-sdk/client-workmail-browser@0.1.0-preview.6","maintainers":[{"name":"amzn-oss","email":"osa-3p@amazon.com"},{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},{"name":"trivikr-aws","email":"trivikr@amazon.com"},{"name":"zheallan","email":"zheallan@amazon.com"}],"dist":{"shasum":"249329e0cebb7380370856ee8e61803d923e7410","tarball":"https://registry.npmjs.org/@aws-sdk/client-workmail-browser/-/client-workmail-browser-0.1.0-preview.6.tgz","fileCount":890,"integrity":"sha512-GC48Q5sp2F9ZP7KA4cvD5wKYfcRw7oVTVHTn8sbuHfTG5w0IuTdF2FQfw31DpJ+uq+x2sc2Vs9ZjiRx/Y4zW/w==","signatures":[{"sig":"MEUCIEzglKQG3TO/wUiDk3Du4DFaJXyUOGPTwFD7MvkVDA8GAiEA1WyWCc6szAQgZG9F1T9NA5NRVImq4xLo4il0vnUF8os=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":547377,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd1FPNCRA9TVsSAnZWagAAA/IP/1mZgA3tih4Me2Wajo0Y\npWAhp9FnmuiaQht00txt3PePcPg9g4RbgkjUOiqjdbEbXLWlq5qSChc5BKmu\nJ5r9Fc1pSUDPlTXpN6sBQ6iRd5RwJK4pkIW2lrdjdjeCMbBnmQ7Kz5WxQSX1\n1V7B36m7cWmoLi7u3p4vyNMoLYIKv7I4Twoe1HrAChwlVTYVfZiQ7o8B5dk7\nl2b7/wLpByKXfVG0lEFUbTqnkJu3t9foaSYpY33OId1Wp2QaJVCjdF7UIEnS\nPnXStv/GEJRbYuPUCgSqV4PSuzTOfxAX2iZN6JpxCryDlVWUMCWy+oeCLvQf\nvDe8aw6E99NsbUyIOMAqA2JeQBDzj78Cn6juDQJwcUJ+Zi9ihV/Lo/9u0ie6\nowSC0nx0EjvpcduDpsgH4vy/9gKOpNdRF/79g2BgS7TosL73vGIHHiOb/PQA\nIDCpKGWyfj3lpOO/NcyPCRGe/p7lATY0Df1zJB0CLIRqaRaNjbgQwOirYQTq\nBSk+72bKBmFzNz+GB+ToGz+deaVVQLt+7WftVrPC0OnazcWE4Bjka3Zkn3St\nHLOCbQ/Jp9HtoEZGbtcwqy9YW7y2p+Y3nPxEPf/zIX36HNTcVj108gPgJT76\nt2L32hhOdYS+v19eBwsRu8DfXtlKHp6bveKPRl2ADF3k8QFnK9xmJTCG5P1Y\nUfHI\r\n=JX7Y\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./index.js","types":"./index.d.ts","readme":"# @aws-sdk/client-workmail-browser\n\n[](https://www.npmjs.com/package/@aws-sdk/client-workmail-browser)\n[](https://www.npmjs.com/package/@aws-sdk/client-workmail-browser)\n\n## Description\n\nAmazon 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.
\n\n## Installing\n\nTo install the this package using NPM, simply type the following into a terminal window:\n\n```\nnpm install @aws-sdk/client-workmail-browser\n```\n\n## Getting Started\n\n### Import\n\nThe AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(`WorkMailClient`) and the commands you need, for example `AssociateDelegateToResourceCommand`:\n\n```javascript\n//JavaScript\nconst {\n WorkMailClient,\n AssociateDelegateToResourceCommand\n} = require(\"@aws-sdk/client-workmail-browser\");\n```\n\n```javascript\n//TypeScript\nimport {\n WorkMailClient,\n AssociateDelegateToResourceCommand\n} from \"@aws-sdk/client-workmail-browser\";\n```\n\n### Usage\n\nTo send a request, you:\n\n- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].\n- Initiate command with input parameters.\n- Call `send` operation on client with command object as input.\n- If you are using a custom http handler, you may call `destroy()` to close open connections.\n\n```javascript\nconst workMail = new WorkMailClient({region: 'region'});\n//clients can be shared by different commands\nconst params = {\n OrganizationId: /**a string value*/,\n ResourceId: /**a string value*/,\n EntityId: /**a string value*/,\n};\nconst associateDelegateToResourceCommand = new AssociateDelegateToResourceCommand(params);\nworkMail.send(associateDelegateToResourceCommand).then(data => {\n // do something\n}).catch(error => {\n // error handling\n})\n```\n\nIn addition to using promises, there are 2 other ways to send a request:\n\n```javascript\n// async/await\ntry {\n const data = await workMail.send(associateDelegateToResourceCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\nworkMail.send(associateDelegateToResourceCommand, (err, data) => {\n //do something\n});\n```\n\nThe SDK can also send requests using the simplified callback style from version 2 of the SDK.\n\n```javascript\nimport * as AWS from \"@aws-sdk/client-workmail-browser\";\nconst workMail = new AWS.WorkMail({ region: \"region\" });\nworkMail.associateDelegateToResource(params, (err, data) => {\n //do something\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).\n\n```javascript\ntry {\n const data = await workMail.send(associateDelegateToResourceCommand);\n // do something\n} catch (error) {\n const metadata = error.$metadata;\n console.log(\n `requestId: ${metadata.requestId}\ncfId: ${metadata.cfId}\nextendedRequestId: ${metadata.extendedRequestId}`\n );\n /*\nThe keys within exceptions are also parsed. You can access them by specifying exception names:\n if(error.name === 'SomeServiceException') {\n const value = error.specialKeyInException;\n }\n*/\n}\n```\n\n## Getting Help\n\nPlease use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.\n\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`\n- Come join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3)\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues)\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-workmail-browser' package is updated. To contribute to SDK you can checkout our [code generator package][].\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n[code generator package]: https://github.com/aws/aws-sdk-js-v3/tree/master/packages/service-types-generator\n[api reference]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/\n","scripts":{"test":"exit 0","clean":"npm run remove-definitions && npm run remove-maps && npm run remove-js","pretest":"tsc","remove-js":"rimraf *.js && rimraf ./commands/*.js && rimraf ./model/*.js && rimraf ./types/*.js","smoke-test":"karma start karma.conf","remove-maps":"rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./model/*.js.map && rimraf ./types/*.js.map","prepublishOnly":"tsc","remove-definitions":"rimraf *.d.ts && rimraf ./commands/*.d.ts && rimraf ./model/*.d.ts rimraf ./types/*.d.ts","build-documentation":"npm run clean && typedoc ./","remove-documentation":"rimraf ./docs"},"_npmUser":{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},"deprecated":"The package @aws-sdk/client-workmail-browser has been renamed to @aws-sdk/client-workmail. Please install the renamed package.","_npmVersion":"6.9.0","description":"Browser SDK for Amazon WorkMail","directories":{},"_nodeVersion":"10.16.3","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.7","@aws-sdk/json-parser":"^0.1.0-preview.7","@aws-sdk/core-handler":"^0.1.0-preview.7","@aws-sdk/json-builder":"^0.1.0-preview.7","@aws-sdk/signature-v4":"^0.1.0-preview.10","@aws-sdk/config-resolver":"^0.1.0-preview.7","@aws-sdk/middleware-stack":"^0.1.0-preview.9","@aws-sdk/retry-middleware":"^0.1.0-preview.7","@aws-crypto/sha256-browser":"^0.1.0-preview.1","@aws-sdk/protocol-json-rpc":"^0.1.0-preview.8","@aws-sdk/util-utf8-browser":"^0.1.0-preview.3","@aws-sdk/fetch-http-handler":"^0.1.0-preview.8","@aws-sdk/signing-middleware":"^0.1.0-preview.10","@aws-sdk/url-parser-browser":"^0.1.0-preview.7","@aws-sdk/util-base64-browser":"^0.1.0-preview.3","@aws-sdk/middleware-serializer":"^0.1.0-preview.7","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.8","@aws-sdk/util-user-agent-browser":"^0.1.0-preview.9","@aws-sdk/stream-collector-browser":"^0.1.0-preview.7","@aws-sdk/util-body-length-browser":"^0.1.0-preview.3","@aws-sdk/middleware-content-length":"^0.1.0-preview.7","@aws-sdk/middleware-header-default":"^0.1.0-preview.7"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"rimraf":"^2.6.2","typedoc":"^0.14.2","typescript":"~3.4.0","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-workmail-browser_0.1.0-preview.6_1574196173322_0.32792826741693815","host":"s3://npm-registry-packages"}}},"time":{"created":"2019-09-09T17:45:36.414Z","modified":"2025-03-27T18:43:33.585Z","0.1.0-preview.2":"2019-09-09T17:45:36.823Z","0.1.0-preview.3":"2019-09-19T15:59:30.419Z","0.1.0-preview.4":"2019-10-29T23:47:56.177Z","0.1.0-preview.5":"2019-10-30T19:21:07.531Z","0.1.0-preview.6":"2019-11-19T20:42:53.457Z"},"author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","description":"Browser SDK for Amazon WorkMail","maintainers":[{"email":"osa-3p@amazon.com","name":"amzn-oss"},{"email":"aws-sdk-js-automation@amazon.com","name":"aws-sdk-bot"}],"readme":"","readmeFilename":""}