Variable EmailConst

Type Declaration

• request: {
      changes: InvocationFactory<
          BaseChangesRequestInvocationArgs,
          EmailInvocation<BaseChangesRequestInvocationArgs>,
      >;
      copy: InvocationFactory<
          EmailCopyRequestInvocationArgs,
          EmailInvocation<EmailCopyRequestInvocationArgs>,
      >;
      get: InvocationFactory<
          EmailGetRequestInvocationArgs,
          EmailInvocation<EmailGetRequestInvocationArgs>,
      >;
      import: InvocationFactory<
          EmailImportRequestInvocationArgs,
          EmailInvocation<EmailImportRequestInvocationArgs>,
      >;
      parse: InvocationFactory<
          EmailParseRequestInvocationArgs,
          EmailInvocation<EmailParseRequestInvocationArgs>,
      >;
      query: InvocationFactory<
          EmailQueryRequestInvocationArgs,
          EmailInvocation<EmailQueryRequestInvocationArgs>,
      >;
      queryChanges: InvocationFactory<
          EmailQueryChangesRequestInvocationArgs,
          EmailInvocation<EmailQueryChangesRequestInvocationArgs>,
      >;
      set: InvocationFactory<
          EmailSetRequestInvocationArgs,
          EmailInvocation<EmailSetRequestInvocationArgs>,
      >;
  }

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

    Returns changes to Email objects since a given state.

    Param: args

    The invocation arguments for Email/changes

    Param: methodCallId

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

    Returns

    An EmailInvocation representing the Email/changes request

    See

    RFC 8621 Section 4.3: Email/changes

  • copy: InvocationFactory<
        EmailCopyRequestInvocationArgs,
        EmailInvocation<EmailCopyRequestInvocationArgs>,
    >

    Copies Email objects from one account to another.

    Param: args

    The invocation arguments for Email/copy

    Param: methodCallId

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

    Returns

    An EmailInvocation representing the Email/copy request

    See

    RFC 8621 Section 4.7: Email/copy

  • get: InvocationFactory<
        EmailGetRequestInvocationArgs,
        EmailInvocation<EmailGetRequestInvocationArgs>,
    >

    Retrieves Email objects by their IDs.

    Param: args

    The invocation arguments for Email/get

    Param: methodCallId

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

    Returns

    An EmailInvocation representing the Email/get request

    See

    RFC 8621 Section 4.2: Email/get

  • import: InvocationFactory<
        EmailImportRequestInvocationArgs,
        EmailInvocation<EmailImportRequestInvocationArgs>,
    >

    Imports email messages from raw RFC 5322 message data.

    Param: args

    The invocation arguments for Email/import

    Param: methodCallId

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

    Returns

    An EmailInvocation representing the Email/import request

    See

    RFC 8621 Section 4.8: Email/import

  • parse: InvocationFactory<
        EmailParseRequestInvocationArgs,
        EmailInvocation<EmailParseRequestInvocationArgs>,
    >

    Parses email messages to extract structured information without importing them.

    Param: args

    The invocation arguments for Email/parse

    Param: methodCallId

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

    Returns

    An EmailInvocation representing the Email/parse request

    See

    RFC 8621 Section 4.9: Email/parse

  • query: InvocationFactory<
        EmailQueryRequestInvocationArgs,
        EmailInvocation<EmailQueryRequestInvocationArgs>,
    >

    Queries for Email objects matching specified criteria.

    Param: args

    The invocation arguments for Email/query

    Param: methodCallId

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

    Returns

    An EmailInvocation representing the Email/query request

    See

    RFC 8621 Section 4.4: Email/query

  • queryChanges: InvocationFactory<
        EmailQueryChangesRequestInvocationArgs,
        EmailInvocation<EmailQueryChangesRequestInvocationArgs>,
    >

    Returns changes to a query result since a given state.

    Param: args

    The invocation arguments for Email/queryChanges

    Param: methodCallId

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

    Returns

    An EmailInvocation representing the Email/queryChanges request

    See

    RFC 8621 Section 4.5: Email/queryChanges

  • set: InvocationFactory<
        EmailSetRequestInvocationArgs,
        EmailInvocation<EmailSetRequestInvocationArgs>,
    >

    Creates, updates, or destroys Email objects.

    Param: args

    The invocation arguments for Email/set

    Param: methodCallId

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

    Returns

    An EmailInvocation representing the Email/set request

    See

    RFC 8621 Section 4.6: Email/set

• response: {
      changes: InvocationFactory<
          BaseChangesResponseInvocationArgs,
          EmailInvocation<BaseChangesResponseInvocationArgs>,
      >;
      copy: InvocationFactory<
          EmailCopyResponseInvocationArgs,
          EmailInvocation<EmailCopyResponseInvocationArgs>,
      >;
      get: InvocationFactory<
          EmailGetResponseInvocationArgs,
          EmailInvocation<EmailGetResponseInvocationArgs>,
      >;
      import: InvocationFactory<
          EmailImportResponseInvocationArgs,
          EmailInvocation<EmailImportResponseInvocationArgs>,
      >;
      parse: InvocationFactory<
          EmailParseResponseInvocationArgs,
          EmailInvocation<EmailParseResponseInvocationArgs>,
      >;
      query: InvocationFactory<
          BaseQueryResponseInvocationArgs,
          EmailInvocation<BaseQueryResponseInvocationArgs>,
      >;
      queryChanges: InvocationFactory<
          BaseQueryChangesResponseInvocationArgs,
          EmailInvocation<BaseQueryChangesResponseInvocationArgs>,
      >;
      set: InvocationFactory<
          EmailSetResponseInvocationArgs,
          EmailInvocation<EmailSetResponseInvocationArgs>,
      >;
  }