Variable MailboxConst

Type Declaration

• request: {
      changes: InvocationFactory<
          BaseChangesRequestInvocationArgs,
          MailboxInvocation<BaseChangesRequestInvocationArgs>,
      >;
      get: InvocationFactory<
          MailboxGetRequestInvocationArgs,
          MailboxInvocation<MailboxGetRequestInvocationArgs>,
      >;
      query: InvocationFactory<
          MailboxQueryRequestInvocationArgs,
          MailboxInvocation<MailboxQueryRequestInvocationArgs>,
      >;
      queryChanges: InvocationFactory<
          MailboxQueryChangesRequestInvocationArgs,
          MailboxInvocation<MailboxQueryChangesRequestInvocationArgs>,
      >;
      set: InvocationFactory<
          MailboxSetRequestInvocationArgs,
          MailboxInvocation<MailboxSetRequestInvocationArgs>,
      >;
  }

  • changes: InvocationFactory<
        BaseChangesRequestInvocationArgs,
        MailboxInvocation<BaseChangesRequestInvocationArgs>,
    >

    Returns changes to Mailbox objects since a given state.

    Param: args

    The invocation arguments for Mailbox/changes

    Param: methodCallId

    An optional unique symbol to identify this method call for result referencing

    Returns

    A MailboxInvocation representing the Mailbox/changes request

    See

    RFC 8621 Section 2.2: Mailbox/changes

  • get: InvocationFactory<
        MailboxGetRequestInvocationArgs,
        MailboxInvocation<MailboxGetRequestInvocationArgs>,
    >

    Retrieves Mailbox objects by their IDs.

    Param: args

    The invocation arguments for Mailbox/get

    Param: methodCallId

    An optional unique symbol to identify this method call for result referencing

    Returns

    A MailboxInvocation representing the Mailbox/get request

    See

    RFC 8621 Section 2.1: Mailbox/get

  • query: InvocationFactory<
        MailboxQueryRequestInvocationArgs,
        MailboxInvocation<MailboxQueryRequestInvocationArgs>,
    >

    Queries for Mailbox objects matching specified criteria.

    Param: args

    The invocation arguments for Mailbox/query

    Param: methodCallId

    An optional unique symbol to identify this method call for result referencing

    Returns

    A MailboxInvocation representing the Mailbox/query request

    See

    RFC 8621 Section 2.3: Mailbox/query

  • queryChanges: InvocationFactory<
        MailboxQueryChangesRequestInvocationArgs,
        MailboxInvocation<MailboxQueryChangesRequestInvocationArgs>,
    >

    Returns changes to a query result since a given state.

    Param: args

    The invocation arguments for Mailbox/queryChanges

    Param: methodCallId

    An optional unique symbol to identify this method call for result referencing

    Returns

    A MailboxInvocation representing the Mailbox/queryChanges request

    See

    RFC 8621 Section 2.4: Mailbox/queryChanges

  • set: InvocationFactory<
        MailboxSetRequestInvocationArgs,
        MailboxInvocation<MailboxSetRequestInvocationArgs>,
    >

    Creates, updates, or destroys Mailbox objects.

    Param: args

    The invocation arguments for Mailbox/set

    Param: methodCallId

    An optional unique symbol to identify this method call for result referencing

    Returns

    A MailboxInvocation representing the Mailbox/set request

    See

    RFC 8621 Section 2.5: Mailbox/set

• response: {
      changes: InvocationFactory<
          MailboxChangesResponseInvocationArgs,
          MailboxInvocation<MailboxChangesResponseInvocationArgs>,
      >;
      get: InvocationFactory<
          MailboxGetResponseInvocationArgs,
          MailboxInvocation<MailboxGetResponseInvocationArgs>,
      >;
      query: InvocationFactory<
          BaseQueryResponseInvocationArgs,
          MailboxInvocation<BaseQueryResponseInvocationArgs>,
      >;
      queryChanges: InvocationFactory<
          BaseQueryChangesResponseInvocationArgs,
          MailboxInvocation<BaseQueryChangesResponseInvocationArgs>,
      >;
      set: InvocationFactory<
          MailboxSetResponseInvocationArgs,
          MailboxInvocation<MailboxSetResponseInvocationArgs>,
      >;
  }