MilterOption
3
milter managerライブラリ

# MilterOption

## 概要

    enum                MilterActionFlags;
    enum                MilterStepFlags;
    MilterStepFlags     milter_step_flags_merge             (MilterStepFlags a,
                                                             MilterStepFlags b);
    struct              MilterOption;
    MilterOption *      milter_option_new                   (guint32 version,
                                                             MilterActionFlags action,
                                                             MilterStepFlags step);
    MilterOption *      milter_option_new_empty             (void);
    MilterOption *      milter_option_copy                  (MilterOption *option);
    gboolean            milter_option_equal                 (MilterOption *option1,
                                                             MilterOption *option2);
    guint32             milter_option_get_version           (MilterOption *option);
    void                milter_option_set_version           (MilterOption *option,
                                                             guint32 version);
    MilterActionFlags   milter_option_get_action            (MilterOption *option);
    void                milter_option_set_action            (MilterOption *option,
                                                             MilterActionFlags action);
    void                milter_option_add_action            (MilterOption *option,
                                                             MilterActionFlags action);
    void                milter_option_remove_action         (MilterOption *option,
                                                             MilterActionFlags action);
    MilterStepFlags     milter_option_get_step              (MilterOption *option);
    void                milter_option_set_step              (MilterOption *option,
                                                             MilterStepFlags step);
    void                milter_option_add_step              (MilterOption *option,
                                                             MilterStepFlags step);
    void                milter_option_remove_step           (MilterOption *option,
                                                             MilterStepFlags step);
    gboolean            milter_option_combine               (MilterOption *dest,
                                                             MilterOption *src);
    gboolean            milter_option_merge                 (MilterOption *dest,
                                                             MilterOption *src);
    gchar *             milter_option_inspect               (MilterOption *option);

## オブジェクト階層

      GObject
       +----MilterOption

## 説明

## 詳細

### enum MilterActionFlags

    typedef enum {
        /* no flags */
        MILTER_ACTION_NONE =                         0 << 0,
        /* filter may add headers */
        MILTER_ACTION_ADD_HEADERS =                  0x00000001L,
        /* filter may replace body */
        MILTER_ACTION_CHANGE_BODY =                  0x00000002L,
        /* filter may add recipients */
        MILTER_ACTION_ADD_ENVELOPE_RECIPIENT =       0x00000004L,
        /* filter may delete recipients */
        MILTER_ACTION_DELETE_ENVELOPE_RECIPIENT =    0x00000008L,
        /* filter may change/delete headers */
        MILTER_ACTION_CHANGE_HEADERS =               0x00000010L,
        /* filter may quarantine envelope */
        MILTER_ACTION_QUARANTINE =                   0x00000020L,
        /* filter may change "from" (envelope sender) */
        MILTER_ACTION_CHANGE_ENVELOPE_FROM =         0x00000040L,
        /* add recipients incl. args */
        MILTER_ACTION_ADD_ENVELOPE_RECIPIENT_WITH_PARAMETERS = 0x00000080L,
        /* filter can send set of symbols (macros) that it wants */
        MILTER_ACTION_SET_SYMBOL_LIST =              0x00000100L
    } MilterActionFlags;

### enum MilterStepFlags

    typedef enum {
        MILTER_STEP_NONE =                   0 << 0,
        /* MTA should not send connect info */
        MILTER_STEP_NO_CONNECT =             0x00000001L,
        /* MTA should not send HELO info */
        MILTER_STEP_NO_HELO =                0x00000002L,
        /* MTA should not send MAIL info */
        MILTER_STEP_NO_ENVELOPE_FROM =       0x00000004L,
        /* MTA should not send RCPT info */
        MILTER_STEP_NO_ENVELOPE_RECIPIENT =  0x00000008L,
        /* MTA should not send body */
        MILTER_STEP_NO_BODY =                0x00000010L,
        /* MTA should not send headers */
        MILTER_STEP_NO_HEADERS =             0x00000020L,
        /* MTA should not send end of header */
        MILTER_STEP_NO_END_OF_HEADER =       0x00000040L,
        /* No reply for headers */
        MILTER_STEP_NO_REPLY_HEADER =        0x00000080L,
        /* MTA should not send unknown commands */
        MILTER_STEP_NO_UNKNOWN =             0x00000100L,
        /* MTA should not send DATA */
        MILTER_STEP_NO_DATA =                0x00000200L,
        /* MTA understands SMFIS_SKIP */
        MILTER_STEP_SKIP =                   0x00000400L,
        /* MTA should also send rejected RCPTs */
        MILTER_STEP_ENVELOPE_RECIPIENT_REJECTED = 0x00000800L,
        /* No reply for connect */
        MILTER_STEP_NO_REPLY_CONNECT =       0x00001000L,
        /* No reply for HELO */
        MILTER_STEP_NO_REPLY_HELO =          0x00002000L,
        /* No reply for MAIL */
        MILTER_STEP_NO_REPLY_ENVELOPE_FROM = 0x00004000L,
        /* No reply for RCPT */
        MILTER_STEP_NO_REPLY_ENVELOPE_RECIPIENT = 0x00008000L,
        /* No reply for DATA */
        MILTER_STEP_NO_REPLY_DATA =          0x00010000L,
        /* No reply for UNKNOWN */
        MILTER_STEP_NO_REPLY_UNKNOWN =       0x00020000L,
        /* No reply for end of header */
        MILTER_STEP_NO_REPLY_END_OF_HEADER = 0x00040000L,
        /* No reply for body chunk */
        MILTER_STEP_NO_REPLY_BODY =          0x00080000L,
        /* header value with leading space */
        MILTER_STEP_HEADER_VALUE_WITH_LEADING_SPACE = 0x00100000L
    } MilterStepFlags;

### milter_step_flags_merge ()

    MilterStepFlags     milter_step_flags_merge             (MilterStepFlags a,
                                                             MilterStepFlags b);

### struct MilterOption

    struct MilterOption;

### milter_option_new ()

    MilterOption *      milter_option_new                   (guint32 version,
                                                             MilterActionFlags action,
                                                             MilterStepFlags step);

### milter_option_new_empty ()

    MilterOption *      milter_option_new_empty             (void);

### milter_option_copy ()

    MilterOption *      milter_option_copy                  (MilterOption *option);

### milter_option_equal ()

    gboolean            milter_option_equal                 (MilterOption *option1,
                                                             MilterOption *option2);

### milter_option_get_version ()

    guint32             milter_option_get_version           (MilterOption *option);

### milter_option_set_version ()

    void                milter_option_set_version           (MilterOption *option,
                                                             guint32 version);

### milter_option_get_action ()

    MilterActionFlags   milter_option_get_action            (MilterOption *option);

### milter_option_set_action ()

    void                milter_option_set_action            (MilterOption *option,
                                                             MilterActionFlags action);

### milter_option_add_action ()

    void                milter_option_add_action            (MilterOption *option,
                                                             MilterActionFlags action);

### milter_option_remove_action ()

    void                milter_option_remove_action         (MilterOption *option,
                                                             MilterActionFlags action);

### milter_option_get_step ()

    MilterStepFlags     milter_option_get_step              (MilterOption *option);

### milter_option_set_step ()

    void                milter_option_set_step              (MilterOption *option,
                                                             MilterStepFlags step);

### milter_option_add_step ()

    void                milter_option_add_step              (MilterOption *option,
                                                             MilterStepFlags step);

### milter_option_remove_step ()

    void                milter_option_remove_step           (MilterOption *option,
                                                             MilterStepFlags step);

### milter_option_combine ()

    gboolean            milter_option_combine               (MilterOption *dest,
                                                             MilterOption *src);

### milter_option_merge ()

    gboolean            milter_option_merge                 (MilterOption *dest,
                                                             MilterOption *src);

### milter_option_inspect ()

    gchar *             milter_option_inspect               (MilterOption *option);