hornet icon

hornet

Interact with hornet API

Actions452

Email Encryption → Email Encryption Communication Settings Post

AI-generated

Summary

Post email encryption communication settings to Hornetsecurity.

Inputs

  • object_id (required) — The ID of an object. An object can be a user, customer or partner.
  • APP-ID (required) — A unique identifier specific to your app issued by us.
  • id (required) — ID of the communication settings object.
  • action — The action (1=ALLOW_UNENCRYPTED, 2=ALWAYS_ENCRYPT).
  • criterion — The criterion to create (1=ADVANCED, 2=HEADER, 3=BODY, 4=ADD_IN).
  • sender — The sender to filter for. Only required if criterion = ADVANCED or ADD_IN.
  • receiver — The recipient to filter for. Only required if criterion = ADVANCED or ADD_IN.
  • ip — The IP to filter for. Only required if criterion = ADVANCED or ADD_IN.
  • hostname — The Hostname to filter for. Only required if criterion = ADVANCED or ADD_IN.
  • subject_contains — The subject to filter for. Only required for outgoing if criterion = ADVANCED or ADD_IN.
  • attachment_contains — The attachment name to filter for. Only required for outgoing if criterion = ADVANCED or ADD_IN.
  • info — Description of the Rule.
  • email_header_filter — The email_header part to filter for. Only required if criterion = HEADER.
  • email_body_filter — The email_body part to filter for. Only required if criterion = BODY.
  • encryption_type — List of encryption types as strings. Only required if action = ALWAYS_ENCRYPT. Can be one of: TLS, EMIG, DANE, SMIME, PGP, WEBSAFE, ALL_CIPHER, TRUSTED_CERT, SECURE_CIPHER, TRUSTED_CERT_SECURE_CIPHER.
  • active — Flag if the rule should be applied.
  • priority — Priority of the rule. Lower integer = higher priority.
  • requestOptions — Request options including batching, proxy, timeout, and SSL validation settings.
  • allowUnauthorizedCerts — Whether to accept the response even if SSL certificate validation is not possible.
  • proxy — HTTP proxy to use. If authentication is required it can be defined as follow: http://username:password@myproxy:3128.
  • timeout — Time in ms to wait for the server to send response headers (and start the response body) before aborting the request.

Output shape

The API response shape is determined by the Hornetsecurity endpoint; properties do not declare a return type.

Parameter necessity for sender, receiver, ip, hostname, subject_contains, attachment_contains, email_header_filter, and email_body_filter depends on the criterion value. encryption_type is required when action is ALWAYS_ENCRYPT. requestOptions, allowUnauthorizedCerts, proxy, and timeout are optional node-level settings.

Links

Discussion