MilterMessageResult 3 MILTER-MANAGER Library
MilterMessageResult

## Functions

MilterMessageResult * | milter_message_result_new ()
void | milter_message_result_start ()
void | milter_message_result_stop ()
const gchar * | milter_message_result_get_from ()
void | milter_message_result_set_from ()
GList * | milter_message_result_get_recipients ()
void | milter_message_result_set_recipients ()
void | milter_message_result_add_recipient ()
void | milter_message_result_remove_recipient ()
GList * | milter_message_result_get_temporary_failed_recipients ()
void | milter_message_result_set_temporary_failed_recipients ()
void | milter_message_result_add_temporary_failed_recipient ()
GList * | milter_message_result_get_rejected_recipients ()
void | milter_message_result_set_rejected_recipients ()
void | milter_message_result_add_rejected_recipient ()
MilterHeaders * | milter_message_result_get_headers ()
void | milter_message_result_set_headers ()
guint64 | milter_message_result_get_body_size ()
void | milter_message_result_set_body_size ()
void | milter_message_result_add_body_size ()
MilterState | milter_message_result_get_state ()
void | milter_message_result_set_state ()
MilterStatus | milter_message_result_get_status ()
void | milter_message_result_set_status ()
MilterHeaders * | milter_message_result_get_added_headers ()
void | milter_message_result_set_added_headers ()
MilterHeaders * | milter_message_result_get_removed_headers ()
void | milter_message_result_set_removed_headers ()
gboolean | milter_message_result_is_quarantine ()
void | milter_message_result_set_quarantine ()
GTimeVal * | milter_message_result_get_start_time ()
void | milter_message_result_set_start_time ()
GTimeVal * | milter_message_result_get_end_time ()
void | milter_message_result_set_end_time ()
gdouble | milter_message_result_get_elapsed_time ()
void | milter_message_result_set_elapsed_time ()

## Properties

MilterHeaders * | added-headers | Read / Write
guint64 | body-size | Read / Write
double | elapsed-time | Read / Write
char * | from | Read / Write
MilterHeaders * | headers | Read / Write
gboolean | quarantine | Read / Write
MilterHeaders * | removed-headers | Read / Write
MilterState | state | Read / Write
MilterStatus | status | Read / Write

## Types and Values

enum | MilterState

## Object Hierarchy

        GObject
        ╰── MilterMessageResult

## Description

## Functions

### milter_message_result_new ()

    MilterMessageResult *
    milter_message_result_new (void);

milter_message_result_new

### milter_message_result_start ()

    void
    milter_message_result_start (MilterMessageResult *result);

milter_message_result_start

### milter_message_result_stop ()

    void
    milter_message_result_stop (MilterMessageResult *result);

milter_message_result_stop

### milter_message_result_get_from ()

    const gchar *
    milter_message_result_get_from (MilterMessageResult *result);

milter_message_result_get_from

### milter_message_result_set_from ()

    void
    milter_message_result_set_from (MilterMessageResult *result,
                                    const gchar *from);

milter_message_result_set_from

### milter_message_result_get_recipients ()

    GList *
    milter_message_result_get_recipients (MilterMessageResult *result);

#### Parameters

result | A MilterMessageResult. |

#### Returns

The recipients of the results.

[transfer none][element-type utf8]

milter_message_result_get_recipients

### milter_message_result_set_recipients ()

    void
    milter_message_result_set_recipients (MilterMessageResult *result,
                                          const GList *recipients);

Set the recipients to the result.

#### Parameters

result | A MilterMessageResult. |
recipients | Recipient names. | [element-type utf8]

milter_message_result_set_recipients

### milter_message_result_add_recipient ()

    void
    milter_message_result_add_recipient (MilterMessageResult *result,
                                         const gchar *recipient);

milter_message_result_add_recipient

### milter_message_result_remove_recipient ()

    void
    milter_message_result_remove_recipient
                                   (MilterMessageResult *result,
                                    const gchar *recipient);

milter_message_result_remove_recipient

### milter_message_result_get_temporary_failed_recipients ()

    GList *
    milter_message_result_get_temporary_failed_recipients
                                   (MilterMessageResult *result);

#### Parameters

result | A MilterMessageResult. |

#### Returns

Temporary failed recipients of the result.

[transfer none][element-type utf8]

milter_message_result_get_temporary_failed_recipients

### milter_message_result_set_temporary_failed_recipients ()

    void
    milter_message_result_set_temporary_failed_recipients
                                   (MilterMessageResult *result,
                                    const GList *recipients);

Set temporary failed recipients to the result.

#### Parameters

result | A MilterMessageResult. |
recipients | Recipient names. | [element-type utf8]

milter_message_result_set_temporary_failed_recipients

### milter_message_result_add_temporary_failed_recipient ()

    void
    milter_message_result_add_temporary_failed_recipient
                                   (MilterMessageResult *result,
                                    const gchar *recipient);

milter_message_result_add_temporary_failed_recipient

### milter_message_result_get_rejected_recipients ()

    GList *
    milter_message_result_get_rejected_recipients
                                   (MilterMessageResult *result);

#### Parameters

result | A MilterMessageResult. |

#### Returns

Rejected recipients of the result.

[transfer none][element-type utf8]

milter_message_result_get_rejected_recipients

### milter_message_result_set_rejected_recipients ()

    void
    milter_message_result_set_rejected_recipients
                                   (MilterMessageResult *result,
                                    const GList *recipients);

Set rejected recipients to the result.

#### Parameters

result | A MilterMessageResult. |
recipients | Recipient names. | [element-type utf8]

milter_message_result_set_rejected_recipients

### milter_message_result_add_rejected_recipient ()

    void
    milter_message_result_add_rejected_recipient
                                   (MilterMessageResult *result,
                                    const gchar *recipient);

milter_message_result_add_rejected_recipient

### milter_message_result_get_headers ()

    MilterHeaders *
    milter_message_result_get_headers (MilterMessageResult *result);

#### Parameters

result | A MilterMessageResult. |

#### Returns

The headers of the result.

[transfer none]

milter_message_result_get_headers

### milter_message_result_set_headers ()

    void
    milter_message_result_set_headers (MilterMessageResult *result,
                                       MilterHeaders *headers);

milter_message_result_set_headers

### milter_message_result_get_body_size ()

    guint64
    milter_message_result_get_body_size (MilterMessageResult *result);

milter_message_result_get_body_size

### milter_message_result_set_body_size ()

    void
    milter_message_result_set_body_size (MilterMessageResult *result,
                                         guint64 body_size);

milter_message_result_set_body_size

### milter_message_result_add_body_size ()

    void
    milter_message_result_add_body_size (MilterMessageResult *result,
                                         guint64 body_size);

milter_message_result_add_body_size

### milter_message_result_get_state ()

    MilterState
    milter_message_result_get_state (MilterMessageResult *result);

milter_message_result_get_state

### milter_message_result_set_state ()

    void
    milter_message_result_set_state (MilterMessageResult *result,
                                     MilterState state);

milter_message_result_set_state

### milter_message_result_get_status ()

    MilterStatus
    milter_message_result_get_status (MilterMessageResult *result);

milter_message_result_get_status

### milter_message_result_set_status ()

    void
    milter_message_result_set_status (MilterMessageResult *result,
                                      MilterStatus status);

milter_message_result_set_status

### milter_message_result_get_added_headers ()

    MilterHeaders *
    milter_message_result_get_added_headers
                                   (MilterMessageResult *result);

#### Parameters

result | A MilterMessageResult. |

#### Returns

The added headers of the result.

[transfer none]

milter_message_result_get_added_headers

### milter_message_result_set_added_headers ()

    void
    milter_message_result_set_added_headers
                                   (MilterMessageResult *result,
                                    MilterHeaders *added_headers);

milter_message_result_set_added_headers

### milter_message_result_get_removed_headers ()

    MilterHeaders *
    milter_message_result_get_removed_headers
                                   (MilterMessageResult *result);

#### Parameters

result | A MilterMessageResult. |

#### Returns

The removed headers of the result.

[transfer none]

milter_message_result_get_removed_headers

### milter_message_result_set_removed_headers ()

    void
    milter_message_result_set_removed_headers
                                   (MilterMessageResult *result,
                                    MilterHeaders *removed_headers);

milter_message_result_set_removed_headers

### milter_message_result_is_quarantine ()

    gboolean
    milter_message_result_is_quarantine (MilterMessageResult *result);

milter_message_result_is_quarantine

### milter_message_result_set_quarantine ()

    void
    milter_message_result_set_quarantine (MilterMessageResult *result,
                                          gboolean quarantine);

milter_message_result_set_quarantine

### milter_message_result_get_start_time ()

    GTimeVal *
    milter_message_result_get_start_time (MilterMessageResult *result);

[skip]

#### Parameters

result | A MilterMessageResult. |

#### Returns

The start time of the result.

milter_message_result_get_start_time

### milter_message_result_set_start_time ()

    void
    milter_message_result_set_start_time (MilterMessageResult *result,
                                          GTimeVal *time);

milter_message_result_set_start_time

### milter_message_result_get_end_time ()

    GTimeVal *
    milter_message_result_get_end_time (MilterMessageResult *result);

[skip]

#### Parameters

result | A MilterMessageResult. |

#### Returns

The end time of the result.

milter_message_result_get_end_time

### milter_message_result_set_end_time ()

    void
    milter_message_result_set_end_time (MilterMessageResult *result,
                                        GTimeVal *time);

milter_message_result_set_end_time

### milter_message_result_get_elapsed_time ()

    gdouble
    milter_message_result_get_elapsed_time
                                   (MilterMessageResult *result);

milter_message_result_get_elapsed_time

### milter_message_result_set_elapsed_time ()

    void
    milter_message_result_set_elapsed_time
                                   (MilterMessageResult *result,
                                    gdouble elapsed_time);

milter_message_result_set_elapsed_time

## Types and Values

### enum MilterState

#### Members

MILTER_STATE_INVALID |  |
MILTER_STATE_START |  |
MILTER_STATE_NEGOTIATE |  |
MILTER_STATE_NEGOTIATE_REPLIED |  |
MILTER_STATE_CONNECT |  |
MILTER_STATE_CONNECT_REPLIED |  |
MILTER_STATE_HELO |  |
MILTER_STATE_HELO_REPLIED |  |
MILTER_STATE_ENVELOPE_FROM |  |
MILTER_STATE_ENVELOPE_FROM_REPLIED |  |
MILTER_STATE_ENVELOPE_RECIPIENT |  |
MILTER_STATE_ENVELOPE_RECIPIENT_REPLIED |  |
MILTER_STATE_DATA |  |
MILTER_STATE_DATA_REPLIED |  |
MILTER_STATE_UNKNOWN |  |
MILTER_STATE_UNKNOWN_REPLIED |  |
MILTER_STATE_HEADER |  |
MILTER_STATE_HEADER_REPLIED |  |
MILTER_STATE_END_OF_HEADER |  |
MILTER_STATE_END_OF_HEADER_REPLIED |  |
MILTER_STATE_BODY |  |
MILTER_STATE_BODY_REPLIED |  |
MILTER_STATE_END_OF_MESSAGE |  |
MILTER_STATE_END_OF_MESSAGE_REPLIED |  |
MILTER_STATE_QUIT |  |
MILTER_STATE_QUIT_REPLIED |  |
MILTER_STATE_ABORT |  |
MILTER_STATE_ABORT_REPLIED |  |
MILTER_STATE_FINISHED |  |

MilterState

## Property Details

### The `“added-headers”` property

      “added-headers”            MilterHeaders *

The added headers of the message.

Owner: MilterMessageResult

Flags: Read / Write

MilterMessageResult:added-headers

### The `“body-size”` property

      “body-size”                guint64

The size of body of the message.

Owner: MilterMessageResult

Flags: Read / Write

Default value: 0

MilterMessageResult:body-size

### The `“elapsed-time”` property

      “elapsed-time”             double

The elapsed time of the message.

Owner: MilterMessageResult

Flags: Read / Write

Allowed values: >= 0

Default value: 0

MilterMessageResult:elapsed-time

### The `“from”` property

      “from”                     char *

The sender of the message.

Owner: MilterMessageResult

Flags: Read / Write

Default value: NULL

MilterMessageResult:from

### The `“headers”` property

      “headers”                  MilterHeaders *

The headers of the message.

Owner: MilterMessageResult

Flags: Read / Write

MilterMessageResult:headers

### The `“quarantine”` property

      “quarantine”               gboolean

The status of the message.

Owner: MilterMessageResult

Flags: Read / Write

Default value: FALSE

MilterMessageResult:quarantine

### The `“removed-headers”` property

      “removed-headers”          MilterHeaders *

The removed headers of the message.

Owner: MilterMessageResult

Flags: Read / Write

MilterMessageResult:removed-headers

### The `“state”` property

      “state”                    MilterState

The last state of the message.

Owner: MilterMessageResult

Flags: Read / Write

Default value: MILTER_STATE_INVALID

MilterMessageResult:state

### The `“status”` property

      “status”                   MilterStatus

The status of the message.

Owner: MilterMessageResult

Flags: Read / Write

Default value: MILTER_STATUS_DEFAULT

MilterMessageResult:status