get_received_header_text

March 26, 2020

Name

get_received_header_text — Use this hook to set the text of the Received header in a message

Synopsis

#include "hooks/core/get_received_header_text.h"

| int **core_get_received_header_text** ( | closure, |   |
|   | msg, |   |
|   | mc, |   |
|   | ac, |   |
|   | ctx, |   |
|   | response); |   |

void * <var class="pdparam">closure</var>;
ec_message * <var class="pdparam">msg</var>;
message_construct * <var class="pdparam">mc</var>;
accept_construct * <var class="pdparam">ac</var>;
validate_context * <var class="pdparam">ctx</var>;
string * <var class="pdparam">response</var>;

Description

Use this hook to set the text of the Received header in a message.

Parameters

closure

A pointer to the closure function.

msg

An ec_message. For documentation of this data structure see “ec_message”

mc

A message_construct. For documentation of this data structure see “message_construct”.

ac

The accept_construct. For documentation of this data structure see “accept_construct”.

ctx

The validate_context struct. For documentation of this data structure see “validate_context”.

response

A pointer to a string. Use this to set the Received header text.

Return Values

Return 0 if you use the default text and 1 if you use the text in the response parameter.

Threading

This hook will be called in any thread.