Package software.amazon.awssdk.services.workmail.model

Class PutMailboxPermissionsRequest

    • Method Detail

      • organizationId

        public final String organizationId()

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

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

      • entityId

        public final String entityId()

        The identifier of the user or resource for which to update mailbox permissions.

        The identifier can be UserId, ResourceID, or Group Id, Username, Resourcename, or Groupname, or email.

        • Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234

        • Email address: entity@domain.tld

        • Entity name: entity

        Returns:
        The identifier of the user or resource for which to update mailbox permissions.

        The identifier can be UserId, ResourceID, or Group Id, Username, Resourcename, or Groupname, or email.

        • Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234

        • Email address: entity@domain.tld

        • Entity name: entity

      • granteeId

        public final String granteeId()

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

        The identifier can be UserId, ResourceID, or Group Id, Username, Resourcename, or Groupname, or email.

        • Grantee ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234

        • Email address: grantee@domain.tld

        • Grantee name: grantee

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

        The identifier can be UserId, ResourceID, or Group Id, Username, Resourcename, or Groupname, or email.

        • Grantee ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234

        • Email address: grantee@domain.tld

        • Grantee name: grantee

      • permissionValues

        public final List<PermissionType> 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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPermissionValues() method.

        Returns:
        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.

      • hasPermissionValues

        public final boolean hasPermissionValues()
        For responses, this returns true if the service returned a value for the PermissionValues property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • permissionValuesAsStrings

        public final List<String> permissionValuesAsStrings()

        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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPermissionValues() method.

        Returns:
        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.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object