MilterProtocolAgent 3 MILTER-MANAGER Library
MilterProtocolAgent

## Functions

void | milter_protocol_agent_set_macro_context ()
void | milter_protocol_agent_set_macros ()
void | milter_protocol_agent_set_macros_hash_table ()
void | milter_protocol_agent_set_macro ()
GHashTable * | milter_protocol_agent_get_macros ()
GHashTable * | milter_protocol_agent_get_available_macros ()
const gchar * | milter_protocol_agent_get_macro ()
void | milter_protocol_agent_clear_macros ()
void | milter_protocol_agent_clear_message_related_macros ()
void | milter_protocol_agent_set_macros_requests ()
MilterMacrosRequests * | milter_protocol_agent_get_macros_requests ()

## Properties

MilterCommand | macro-context | Read / Write

## Types and Values

#define | MILTER_TYPE_PROTOCOL_AGENT
struct | MilterProtocolAgentClass
| MilterProtocolAgent

## Object Hierarchy

        GObject
        ╰── MilterAgent
            ╰── MilterProtocolAgent
                ├── MilterClientContext
                ╰── MilterServerContext

## Implemented Interfaces

MilterProtocolAgent implements

## Description

## Functions

### milter_protocol_agent_set_macro_context ()

    void
    milter_protocol_agent_set_macro_context
                                   (MilterProtocolAgent *agent,
                                    MilterCommand macro_context);

milter_protocol_agent_set_macro_context

### milter_protocol_agent_set_macros ()

    void
    milter_protocol_agent_set_macros (MilterProtocolAgent *agent,
                                      MilterCommand macro_context,
                                      const gchar *macro_name,
                                      ...);

milter_protocol_agent_set_macros

### milter_protocol_agent_set_macros_hash_table ()

    void
    milter_protocol_agent_set_macros_hash_table
                                   (MilterProtocolAgent *agent,
                                    MilterCommand macro_context,
                                    GHashTable *macros);

milter_protocol_agent_set_macros_hash_table

### milter_protocol_agent_set_macro ()

    void
    milter_protocol_agent_set_macro (MilterProtocolAgent *agent,
                                     MilterCommand macro_context,
                                     const gchar *macro_name,
                                     const gchar *macro_value);

milter_protocol_agent_set_macro

### milter_protocol_agent_get_macros ()

    GHashTable *
    milter_protocol_agent_get_macros (MilterProtocolAgent *agent);

#### Parameters

agent | A MilterProtocolAgent. |

#### Returns

The macros of the agent.

[transfer none][element-type utf8 utf8][nullable]

milter_protocol_agent_get_macros

### milter_protocol_agent_get_available_macros ()

    GHashTable *
    milter_protocol_agent_get_available_macros
                                   (MilterProtocolAgent *agent);

#### Parameters

agent | A MilterProtocolAgent. |

#### Returns

The available macros of the agent.

[transfer none][element-type utf8 utf8]

milter_protocol_agent_get_available_macros

### milter_protocol_agent_get_macro ()

    const gchar *
    milter_protocol_agent_get_macro (MilterProtocolAgent *agent,
                                     const gchar *name);

milter_protocol_agent_get_macro

### milter_protocol_agent_clear_macros ()

    void
    milter_protocol_agent_clear_macros (MilterProtocolAgent *agent,
                                        MilterCommand macro_context);

milter_protocol_agent_clear_macros

### milter_protocol_agent_clear_message_related_macros ()

    void
    milter_protocol_agent_clear_message_related_macros
                                   (MilterProtocolAgent *agent);

milter_protocol_agent_clear_message_related_macros

### milter_protocol_agent_set_macros_requests ()

    void
    milter_protocol_agent_set_macros_requests
                                   (MilterProtocolAgent *agent,
                                    MilterMacrosRequests *requests);

milter_protocol_agent_set_macros_requests

### milter_protocol_agent_get_macros_requests ()

    MilterMacrosRequests *
    milter_protocol_agent_get_macros_requests
                                   (MilterProtocolAgent *agent);

#### Parameters

agent | A MilterProtocolAgent. |

#### Returns

The requested macros of the agent.

[transfer none]

milter_protocol_agent_get_macros_requests

## Types and Values

### MILTER_TYPE_PROTOCOL_AGENT

    #define MILTER_TYPE_PROTOCOL_AGENT            (milter_protocol_agent_get_type())

MILTER_TYPE_PROTOCOL_AGENT

### struct MilterProtocolAgentClass

    struct MilterProtocolAgentClass {
        MilterAgentClass parent_class;
    };

MilterProtocolAgentClass

### MilterProtocolAgent

    typedef struct _MilterProtocolAgent MilterProtocolAgent;

MilterProtocolAgent

## Property Details

### The `“macro-context”` property

      “macro-context”            MilterCommand

The current macro context.

Owner: MilterProtocolAgent

Flags: Read / Write

Default value: MILTER_COMMAND_UNKNOWN

MilterProtocolAgent:macro-context