path: root/camel/camel-provider.h

/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* camel-provider.h :  provider definition  */

/* 
 *
 * Author : 
 *  Bertrand Guiheneuf <bertrand@helixcode.com>
 *
 * Copyright 1999, 2000 Helix Code, Inc. (http://www.helixcode.com)
 *
 * This program is free software; you can redistribute it and/or 
 * modify it under the terms of the GNU General Public License as 
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 * USA
 */


#ifndef CAMEL_PROVIDER_H
#define CAMEL_PROVIDER_H 1


#ifdef __cplusplus
extern "C" {
#pragma }
#endif /* __cplusplus }*/

#include <gtk/gtk.h>
#include <gmodule.h>

#define CAMEL_PROVIDER(obj) ((CamelProvider *)(obj))

typedef enum {
    PROVIDER_STORE,
    PROVIDER_TRANSPORT
} ProviderType;

#define PROVIDER_REMOTE     0x01

typedef struct {
    GtkType object_type;        /* used to create instance of the provider */
    ProviderType provider_type; /* is a store or a transport */ 
    int flags;                  /* information about the provider */

    /* Provider name used in CamelURLs. */
    gchar *protocol;

    /* Provider name as used by people. (May be the same as protocol) */
    gchar *name;

    /* Description of the provider. A novice user should be able
     * to read this description, and the information provided by
     * an ISP, IS department, etc, and determine whether or not
     * this provider is relevant to him, and if so, which
     * information goes with it.
     */
    gchar *description;

    GModule *gmodule;
} CamelProvider;

void camel_provider_register (CamelProvider *provider);
const CamelProvider *camel_provider_register_as_module (const gchar *module_path);
const CamelProvider *camel_provider_get_for_protocol (const gchar *protocol, ProviderType type);
GList *camel_provider_scan (void);


#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* CAMEL_PROVIDER_H */