smtp_error_retrieve_class

March 26, 2020 Contributors

Name

smtp_error_retrieve_class — Return the name and description for a bounce code

Synopsis

#include "misc/smtp_error_classify.h"

| int **smtp_error_retrieve_class** ( | class_code, |   |
|   | name, |   |
|   | name_len, |   |
|   | desc, |   |
|   | desc_len); |   |

unsigned short <var class="pdparam">class_code</var>;
char * <var class="pdparam">name</var>;
int <var class="pdparam">name_len</var>;
char * <var class="pdparam">desc</var>;
int <var class="pdparam">desc_len</var>;

Description

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

Return the name and description for a bounce code.

Parameters

class_code

The class code.

name

The buffer to store the name.

name_len

The buffer size.

desc

The buffer to store description.

desc_len

The desc buffer size.

Return Values

If the code is found, this function returns 1; Otherwise 0 is returned.

Threading

It is legal to call this function in any thread.

See Also

SMTP-related Functions and Bounce Classification Codes.