spf_response.h

Go to the documentation of this file.

/* 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of either:
 * 
 *   a) The GNU Lesser General Public License as published by the Free
 *      Software Foundation; either version 2.1, or (at your option) any
 *      later version,
 * 
 *   OR
 * 
 *   b) The two-clause BSD license.
 *
 * These licenses can be found with the distribution in the file LICENSES
 */

#ifndef INC_SPF_RESPONSE
#define INC_SPF_RESPONSE

typedef
enum SPF_result_enum {
        SPF_RESULT_INVALID = 0,         
        SPF_RESULT_NEUTRAL,
        SPF_RESULT_PASS,
        SPF_RESULT_FAIL,
        SPF_RESULT_SOFTFAIL,

        SPF_RESULT_NONE,
        SPF_RESULT_TEMPERROR,
        SPF_RESULT_PERMERROR
} SPF_result_t;

typedef
enum SPF_reason_enum {
        SPF_REASON_NONE                 = 0
,       SPF_REASON_FAILURE
,       SPF_REASON_LOCALHOST    
,       SPF_REASON_LOCAL_POLICY 
,       SPF_REASON_MECH                 
,       SPF_REASON_DEFAULT              
,       SPF_REASON_2MX                  
} SPF_reason_t;

typedef
enum SPF_errcode_t {
        SPF_E_SUCCESS    = 0    
,       SPF_E_NO_MEMORY                 
,       SPF_E_NOT_SPF                   
,       SPF_E_SYNTAX                    
,       SPF_E_MOD_W_PREF                
,       SPF_E_INVALID_CHAR              
,       SPF_E_UNKNOWN_MECH              
,       SPF_E_INVALID_OPT               
,       SPF_E_INVALID_CIDR              
,       SPF_E_MISSING_OPT               
,       SPF_E_INTERNAL_ERROR    
,       SPF_E_INVALID_ESC               
,       SPF_E_INVALID_VAR               
,       SPF_E_BIG_SUBDOM                
,       SPF_E_INVALID_DELIM             
,       SPF_E_BIG_STRING                
,       SPF_E_BIG_MECH                  
,       SPF_E_BIG_MOD                   
,       SPF_E_BIG_DNS                   
,       SPF_E_INVALID_IP4               
,       SPF_E_INVALID_IP6               
,       SPF_E_INVALID_PREFIX    
,       SPF_E_RESULT_UNKNOWN    
,       SPF_E_UNINIT_VAR                
,       SPF_E_MOD_NOT_FOUND             
,       SPF_E_NOT_CONFIG                
,       SPF_E_DNS_ERROR                 
,       SPF_E_BAD_HOST_IP               
,       SPF_E_BAD_HOST_TLD              
,       SPF_E_MECH_AFTER_ALL    
,       SPF_E_INCLUDE_RETURNED_NONE     
,       SPF_E_RECURSIVE                 
,       SPF_E_MULTIPLE_RECORDS  
} SPF_errcode_t;

typedef
struct SPF_error_struct
{
        SPF_errcode_t    code;
        char                    *message;
        char                     is_error;
} SPF_error_t;

typedef struct SPF_response_struct SPF_response_t;

#include "spf.h"
#include "spf_request.h"

struct SPF_response_struct {
        /* Structure variables */
        SPF_request_t   *spf_request;
        SPF_record_t    *spf_record_exp;

        /* The answer itself. */
        SPF_result_t     result;
        SPF_reason_t     reason;
        SPF_errcode_t    err;

        char                    *received_spf;
        char                    *received_spf_value;
        char                    *header_comment;
        char                    *smtp_comment;
        char                    *explanation;

        /* The errors */
        SPF_error_t             *errors;
        unsigned short   errors_size;           
        unsigned short   errors_length;         
        unsigned short   num_errors;            
        /* Stuff which lets us get there. */
        int                              num_dns_mech;
};


SPF_response_t  *SPF_response_new(SPF_request_t *spf_request);
void                     SPF_response_free(SPF_response_t *rp);
SPF_response_t  *SPF_response_combine(SPF_response_t *main,
                                        SPF_response_t *r2mx);

        /* Query functions for elements of the result */
SPF_result_t     SPF_response_result(SPF_response_t *rp);
SPF_reason_t     SPF_response_reason(SPF_response_t *rp);
SPF_errcode_t    SPF_response_errcode(SPF_response_t *rp);
const char              *SPF_response_get_received_spf(SPF_response_t *rp);
const char              *SPF_response_get_received_spf_value(SPF_response_t*rp);
const char              *SPF_response_get_header_comment(SPF_response_t *rp);
const char              *SPF_response_get_smtp_comment(SPF_response_t *rp);
const char              *SPF_response_get_explanation(SPF_response_t *rp);

int                              SPF_response_messages(SPF_response_t *rp);
int                              SPF_response_errors(SPF_response_t *rp);
int                              SPF_response_warnings(SPF_response_t *rp);
SPF_error_t             *SPF_response_message(SPF_response_t *rp, int idx);

SPF_errcode_t    SPF_error_code(SPF_error_t *err);
const char *     SPF_error_message(SPF_error_t *err);
char                     SPF_error_errorp(SPF_error_t *err);

SPF_errcode_t    SPF_response_add_error_ptr(SPF_response_t *rp,
                                        SPF_errcode_t code,
                                        const char *text, const char *tptr,
                                        const char *format, ...);
SPF_errcode_t    SPF_response_add_error_idx(SPF_response_t *rp,
                                        SPF_errcode_t code,
                                        const char *text, int idx,
                                        const char *format, ...);
SPF_errcode_t    SPF_response_add_error(SPF_response_t *rp,
                                        SPF_errcode_t code,
                                        const char *format, ...);
SPF_errcode_t    SPF_response_add_warn_ptr(SPF_response_t *rp,
                                        SPF_errcode_t code,
                                        const char *text, const char *tptr,
                                        const char *format, ...);
SPF_errcode_t    SPF_response_add_warn_idx(SPF_response_t *rp,
                                        SPF_errcode_t code,
                                        const char *text, int idx,
                                        const char *format, ...);
SPF_errcode_t    SPF_response_add_warn(SPF_response_t *rp,
                                        SPF_errcode_t code,
                                        const char *format, ...);

#endif

---