MilterOption
3
milter managerライブラリ

# MilterOption

## Functions

MilterStepFlags | milter_step_flags_merge ()
MilterOption * | milter_option_new ()
MilterOption * | milter_option_new_empty ()
MilterOption * | milter_option_copy ()
gboolean | milter_option_equal ()
guint32 | milter_option_get_version ()
void | milter_option_set_version ()
MilterActionFlags | milter_option_get_action ()
void | milter_option_set_action ()
void | milter_option_add_action ()
void | milter_option_remove_action ()
MilterStepFlags | milter_option_get_step ()
MilterStepFlags | milter_option_get_step_no_event ()
MilterStepFlags | milter_option_get_step_no_reply ()
MilterStepFlags | milter_option_get_step_no ()
MilterStepFlags | milter_option_get_step_yes ()
void | milter_option_set_step ()
void | milter_option_add_step ()
void | milter_option_remove_step ()
gboolean | milter_option_combine ()
gboolean | milter_option_merge ()
gchar * | milter_option_inspect ()

## プロパティ

MilterActionFlags | action | Read / Write
MilterStepFlags | step | Read / Write
guint | version | Read / Write

## Types and Values

enum | MilterActionFlags
enum | MilterStepFlags
#define | MILTER_STEP_NO_EVENT_MASK
#define | MILTER_STEP_NO_REPLY_MASK
#define | MILTER_STEP_NO_MASK
#define | MILTER_STEP_YES_MASK

## オブジェクト階層

        GFlags
        ├── MilterActionFlags
        ╰── MilterStepFlags
        GObject
        ╰── MilterOption

## 説明

## Functions

### milter_step_flags_merge ()

    MilterStepFlags
    milter_step_flags_merge (MilterStepFlags a,
                             MilterStepFlags b);

### 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_get_step_no_event ()

    MilterStepFlags
    milter_option_get_step_no_event (MilterOption *option);

### milter_option_get_step_no_reply ()

    MilterStepFlags
    milter_option_get_step_no_reply (MilterOption *option);

### milter_option_get_step_no ()

    MilterStepFlags
    milter_option_get_step_no (MilterOption *option);

### milter_option_get_step_yes ()

    MilterStepFlags
    milter_option_get_step_yes (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);

## Types and Values

### enum MilterActionFlags

#### Members

MILTER_ACTION_NONE |  |
MILTER_ACTION_ADD_HEADERS |  |
MILTER_ACTION_CHANGE_BODY |  |
MILTER_ACTION_ADD_ENVELOPE_RECIPIENT |  |
MILTER_ACTION_DELETE_ENVELOPE_RECIPIENT |  |
MILTER_ACTION_CHANGE_HEADERS |  |
MILTER_ACTION_QUARANTINE |  |
MILTER_ACTION_CHANGE_ENVELOPE_FROM |  |
MILTER_ACTION_ADD_ENVELOPE_RECIPIENT_WITH_PARAMETERS |  |
MILTER_ACTION_SET_SYMBOL_LIST |  |

### enum MilterStepFlags

#### Members

MILTER_STEP_NONE |  |
MILTER_STEP_NO_CONNECT |  |
MILTER_STEP_NO_HELO |  |
MILTER_STEP_NO_ENVELOPE_FROM |  |
MILTER_STEP_NO_ENVELOPE_RECIPIENT |  |
MILTER_STEP_NO_BODY |  |
MILTER_STEP_NO_HEADERS |  |
MILTER_STEP_NO_END_OF_HEADER |  |
MILTER_STEP_NO_REPLY_HEADER |  |
MILTER_STEP_NO_UNKNOWN |  |
MILTER_STEP_NO_DATA |  |
MILTER_STEP_SKIP |  |
MILTER_STEP_ENVELOPE_RECIPIENT_REJECTED |  |
MILTER_STEP_NO_REPLY_CONNECT |  |
MILTER_STEP_NO_REPLY_HELO |  |
MILTER_STEP_NO_REPLY_ENVELOPE_FROM |  |
MILTER_STEP_NO_REPLY_ENVELOPE_RECIPIENT |  |
MILTER_STEP_NO_REPLY_DATA |  |
MILTER_STEP_NO_REPLY_UNKNOWN |  |
MILTER_STEP_NO_REPLY_END_OF_HEADER |  |
MILTER_STEP_NO_REPLY_BODY |  |
MILTER_STEP_HEADER_VALUE_WITH_LEADING_SPACE |  |

### MILTER_STEP_NO_EVENT_MASK

    #define             MILTER_STEP_NO_EVENT_MASK

### MILTER_STEP_NO_REPLY_MASK

    #define             MILTER_STEP_NO_REPLY_MASK

### MILTER_STEP_NO_MASK

    #define             MILTER_STEP_NO_MASK

### MILTER_STEP_YES_MASK

    #define             MILTER_STEP_YES_MASK

## プロパティ詳細

### The `“action”` property

      “action”                   MilterActionFlags

The action of the option.

Flags: Read / Write

### The `“step”` property

      “step”                     MilterStepFlags

The step of the option.

Flags: Read / Write

### The `“version”` property

      “version”                  guint

The milter protocol version of the option.

Flags: Read / Write

デフォルト値: 0