InboxForwarderController

Update an inbox forwarder

Update inbox forwarder

put/forwarders/{id}

Request

  • Base URL: https://api.mailslurp.com
  • URL: https://api.mailslurp.com/forwarders/{id}
  • Auth: API key in header x-api-key

Path parameters

idstring uuid required

ID of inbox forwarder

Request body

field'RECIPIENTS' | 'SENDER' | 'SUBJECT' | 'ATTACHMENTS' | 'ATTACHMENT_FILENAME' | 'ATTACHMENT_TEXT' nullable

Field to match against to trigger inbox forwarding for inbound email

matchstring nullable

String or wildcard style match for field specified when evaluating forwarding rules

forwardToRecipientsstring[] required

Email addresses to forward an email to if it matches the field and match criteria of the forwarder

should'WILDCARD' | 'MATCH' | 'CONTAIN' | 'EQUAL' nullable

Comparison mode for inbox automation matching.

attachmentTextExtractionMethod'AUTO' | 'NATIVE' | 'OCR' | 'LLM' | 'OCR_THEN_LLM' nullable

Method for extracting text from attachments.

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.