add

March 26, 2020 Contributors

Name

add — Add disclaimer to a message

Synopsis

#include "modules/generic/disclaimer_api.h"

| int **add** ( | mess, |   |
|   | plain_text, |   |
|   | html_text); |   |

ec_message * <var class="pdparam">mess</var>;
const char * <var class="pdparam">plain_text</var>;
const char * <var class="pdparam">html_text</var>;

Description

Note

This reference page was automatically generated from functions found in the header files in the development branch. The function described here may not exist in generally available versions of Momentum, and may change in behavior when it is generally available. Consult your vendor for definitive advice on the use of this function.

Add disclaimer to a message.

If plain_text is not null, all message parts of type text/plain will be appended with plain_text. If html_text is not null, all message parts of type text/html will be appended with html_text.

Parameters

mess
  • the message
plain_text
  • contains plain text version of disclaimer
html_text
  • contains html text version of disclaimer

Return Values

0 if disclaimer module is not configured; 1 otherwise.

**Configuration Change. ** This feature is available starting from Momentum 3.1.