Skip to main content

Name

smtp_client_xclient_args

Synopsis

#include "hooks/core/smtp_client_xclient_args.h"

| int **smtp_client_xclient_args** ( | closure, |   | |   | dc, |   | |   | args); |   |

void * <var class="pdparam">closure</var>; delivery_construct * <var class="pdparam">dc</var>; smtp_client_args * <var class="pdparam">args</var>;

| int **has_core_smtp_client_xclient_args_hook** ( | ); |   |

| void **register_core_smtp_client_xclient_args_hook_first** ( | hook, |   | |   | closure); |   |

ec_hook_core_smtp_client_xclient_args_func_t <var class="pdparam">hook</var>; void *<var class="pdparam">closure</var>;

| void **register_core_smtp_client_xclient_args_hook_last** ( | hook, |   | |   | closure); |   |

ec_hook_core_smtp_client_xclient_args_func_t <var class="pdparam">hook</var>; void *<var class="pdparam">closure</var>;

| int **call_core_smtp_client_xclient_args_hook** ( | dc, |   | |   | args); |   |

delivery_construct * <var class="pdparam">dc</var>; smtp_client_args * <var class="pdparam">args</var>;

Description

This hook is called before the XCLIENT phase in the SMTP client. The called function may add entries to smtp_client_args using the functions smtp_client_args_add(), delete with smtp_client_args_delete() and query entries using smtp_client_args_exists_and_fetch(). The called function is responsible for verifying that the remote SMTP server is capable of supporting the desired extension. If the smtp_client_args_add() call returns non-zero then the add failed and the hook should act appropriately. Returning 0 to the caller will cause subsequent hooks to be called and the message continue on its way. Returning non-zero will cause the message to transiently fail.

Was this page helpful?