ec_message_get_envelope
Name
ec_message_get_envelope — Returns information from the envelope of the message
Synopsis
#include "ec_message.h"
| int **ec_message_get_envelope** ( | mess, | |
| | flags, | |
| | localpart, | |
| | llen, | |
| | domain, | |
| | dlen, | |
| | isnull); | |
ec_message * <var class="pdparam">mess</var>;
int <var class="pdparam">flags</var>;
char * <var class="pdparam">localpart</var>;
int <var class="pdparam">llen</var>;
char * <var class="pdparam">domain</var>;
int <var class="pdparam">dlen</var>;
int * <var class="pdparam">isnull</var>;
Description
Fetches information from the envelope of the message.
ec_message_get_envelope(message, EC_MSG_ENV_FROM|EC_MSG_ENV_COMPLETE, emailaddr, sizeof(emailaddr), NULL, 0, &is_null)
Parameters
- mess
-
A pointer to an ec_message struct. For documentation of this data structure see “ec_message”
- flags
-
An int parameter as follows:
-
If flags includes
EC_MSG_ENV_FROMthen the envelope sender will be the source of the information. -
If flags includes
EC_MSG_ENV_TO, then the envelope recipient will be the source of the information. -
If
EC_MSG_ENV_COMPLETEis contained in flags, then the address will be copied into the localpart buffer only, without any protocol decoration (eg: no MAIL FROM:<>CRLF).
Warning
It is not valid to pass
EC_MSG_ENV_FROM | EC_MSG_ENV_TOas a parameter to flags. See also the section called “TheEC_MSG_ENV_COMPLETEFlag”. -
- localpart
-
The address of localpart buffer which is llen bytes long. The localpart of the email address will be copied into the provided localpart buffer if it is not NULL.
- llen
-
The size of the localpart buffer. No more than llen bytes will be copied into the buffer, and the buffer is guaranteed to be NUL terminated.
- domain
-
The address of domain buffer which is dlen bytes long. The domain of the email address will be copied into the provided domain buffer if it is not NULL.
- dlen
-
The size of the domain buffer. No more than dlen bytes will be copied into the buffer and the buffer is guaranteed to be NUL terminated.
- isnull
-
A pointer to int. If isnull is not NULL, then it will be set to 1 to indicate that the address is the null email address. It will be set to 0 otherwise.
If you want the complete email address you must use the EC_MSG_ENV_COMPLETE flag. Consider the following code invoked during the log_delivery hook:
ec_message_get_envelope(msg, EC_MSG_ENV_TO|EC_MSG_ENV_COMPLETE, to, sizeof(to), NULL, 0, NULL);
fprintf(stderr, "with complete: %s\n", to);
ec_message_get_envelope(msg, EC_MSG_ENV_TO, to1, sizeof(to1), NULL, 0, NULL);
fprintf(stderr, "withOUT complete: %s\n", to1);
The first print statement outputs the complete rcptto address, for example, test@example.com. The second print statement outputs the localpart only, for example, test.
Returns 1 on success (including if the envelope address is empty) and 0 if the address is not understood by the system.
It is legal to call this function in any thread.