Variable EmailSubmissionConst

Type Declaration

• request: {
      changes: InvocationFactory<
          BaseChangesRequestInvocationArgs,
          EmailSubmissionInvocation<BaseChangesRequestInvocationArgs>,
      >;
      get: InvocationFactory<
          EmailSubmissionGetRequestInvocationArgs,
          EmailSubmissionInvocation<EmailSubmissionGetRequestInvocationArgs>,
      >;
      query: InvocationFactory<
          EmailSubmissionQueryRequestInvocationArgs,
          EmailSubmissionInvocation<EmailSubmissionQueryRequestInvocationArgs>,
      >;
      queryChanges: InvocationFactory<
          EmailSubmissionQueryChangesRequestInvocationArgs,
          EmailSubmissionInvocation<
              EmailSubmissionQueryChangesRequestInvocationArgs,
          >,
      >;
      set: InvocationFactory<
          EmailSubmissionSetRequestInvocationArgs,
          EmailSubmissionInvocation<EmailSubmissionSetRequestInvocationArgs>,
      >;
  }

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

    Returns changes to EmailSubmission objects since a given state.

    Param: args

    The invocation arguments for EmailSubmission/changes

    Param: methodCallId

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

    Returns

    An EmailSubmissionInvocation representing the EmailSubmission/changes request

    See

    RFC 8621 Section 7.2: EmailSubmission/changes

  • get: InvocationFactory<
        EmailSubmissionGetRequestInvocationArgs,
        EmailSubmissionInvocation<EmailSubmissionGetRequestInvocationArgs>,
    >

    Retrieves EmailSubmission objects by their IDs.

    Param: args

    The invocation arguments for EmailSubmission/get

    Param: methodCallId

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

    Returns

    An EmailSubmissionInvocation representing the EmailSubmission/get request

    See

    RFC 8621 Section 7.1: EmailSubmission/get

  • query: InvocationFactory<
        EmailSubmissionQueryRequestInvocationArgs,
        EmailSubmissionInvocation<EmailSubmissionQueryRequestInvocationArgs>,
    >

    Queries for EmailSubmission objects matching specified criteria.

    Param: args

    The invocation arguments for EmailSubmission/query

    Param: methodCallId

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

    Returns

    An EmailSubmissionInvocation representing the EmailSubmission/query request

    See

    RFC 8621 Section 7.3: EmailSubmission/query

  • queryChanges: InvocationFactory<
        EmailSubmissionQueryChangesRequestInvocationArgs,
        EmailSubmissionInvocation<EmailSubmissionQueryChangesRequestInvocationArgs>,
    >

    Returns changes to a query result since a given state.

    Param: args

    The invocation arguments for EmailSubmission/queryChanges

    Param: methodCallId

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

    Returns

    An EmailSubmissionInvocation representing the EmailSubmission/queryChanges request

    See

    RFC 8621 Section 7.4: EmailSubmission/queryChanges

  • set: InvocationFactory<
        EmailSubmissionSetRequestInvocationArgs,
        EmailSubmissionInvocation<EmailSubmissionSetRequestInvocationArgs>,
    >

    Creates, updates, or destroys EmailSubmission objects.

    An Email is sent by creating an EmailSubmission object. Additional onSuccessUpdateEmail and onSuccessDestroyEmail arguments allow updating or destroying the referenced Email upon successful submission.

    Param: args

    The invocation arguments for EmailSubmission/set

    Param: methodCallId

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

    Returns

    An EmailSubmissionInvocation representing the EmailSubmission/set request

    See

    RFC 8621 Section 7.5: EmailSubmission/set

• response: {
      changes: InvocationFactory<
          BaseChangesResponseInvocationArgs,
          EmailSubmissionInvocation<BaseChangesResponseInvocationArgs>,
      >;
      get: InvocationFactory<
          EmailSubmissionGetResponseInvocationArgs,
          EmailSubmissionInvocation<EmailSubmissionGetResponseInvocationArgs>,
      >;
      query: InvocationFactory<
          BaseQueryResponseInvocationArgs,
          EmailSubmissionInvocation<BaseQueryResponseInvocationArgs>,
      >;
      queryChanges: InvocationFactory<
          BaseQueryChangesResponseInvocationArgs,
          EmailSubmissionInvocation<BaseQueryChangesResponseInvocationArgs>,
      >;
      set: InvocationFactory<
          EmailSubmissionSetResponseInvocationArgs,
          EmailSubmissionInvocation<EmailSubmissionSetResponseInvocationArgs>,
      >;
  }