4c42c93dc6
* camel-provider.h: Add an "extra_conf" field to CamelProvider with structures and defines and stuff, for providers to specify additional configuration options that they want. Also add a "supports ssl" flag to the provider flags. * camel-remote-store.c: add a "default_ssl_port" field. (remote_construct): If the URL has the "use_ssl" parameter, set the store's use_ssl flag. (remote_connect): If using SSL and no port specified, use the default_ssl_port rather than the default_port. * providers/smtp/camel-smtp-provider.c (smtp_provider): add CAMEL_PROVIDER_SUPPORTS_SSL and CAMEL_URL_ALLOW_USER. (The config gui code knows that the ALLOW_USER and ALLOW_AUTH go together.) (ssmtp_provider): gone * providers/smtp/camel-smtp-transport.c (smtp_construct): Set a flag if "use_ssl" param is set. (smtp_connect): Check the CamelSmtpTransport use_ssl flag rather than checking if this is smtp or ssmtp. * providers/imap/camel-imap-provider.c (imap_conf_entries): Add a bunch of IMAP-specific configuration options, like "check for new mail in all folders" (default TRUE), "show only subscribed folders" (default TRUE), "ignore server-supplied namespace", and "apply filters to INBOX" (not yet implemented). (imap_provider): We support SSL and we no longer allow a path in the URL. (namespace is handled via extra_conf) (simap_provider): Gone * providers/imap/camel-imap-store.c (camel_imap_store_init): Set default_ssl_port, don't set CAMEL_STORE_SUBSCRIPTIONS here (construct): remove simap stuff, deal with "use_lsub", "namespace", "check_all", and "filter" parameters. Set base_url to not include params. (imap_store_setup_online): Don't ask for the namespace if it was set explicitly. Don't get subscribed folders if !use_lsub. (imap_concat): Fix a bug. (get_folder_info): Support for not checking all folders. * providers/pop3/camel-pop3-provider.c (pop3_conf_entries): "keep on server" (currently still implemented by the mailer code, not here), "delete after N days" (not yet implemented). (pop3_provider): we support SSL (spop_provider): gone * providers/pop3/camel-pop3-store.c (camel_pop3_store_init): Set default_ssl_port (pop3_connect): Remove spop code svn path=/trunk/; revision=8968
162 lines
5.0 KiB
C
162 lines
5.0 KiB
C
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
|
|
/* camel-provider.h : provider definition */
|
|
|
|
/*
|
|
*
|
|
* Authors:
|
|
* Bertrand Guiheneuf <bertrand@helixcode.com>
|
|
* Jeffrey Stedfast <fejj@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 <camel/camel-types.h>
|
|
#include <camel/camel-object.h>
|
|
|
|
#define CAMEL_PROVIDER(obj) ((CamelProvider *)(obj))
|
|
|
|
typedef enum {
|
|
CAMEL_PROVIDER_STORE,
|
|
CAMEL_PROVIDER_TRANSPORT,
|
|
CAMEL_NUM_PROVIDER_TYPES
|
|
} CamelProviderType;
|
|
|
|
extern char *camel_provider_type_name[CAMEL_NUM_PROVIDER_TYPES];
|
|
|
|
/* _IS_SOURCE means the user can get mail from there.
|
|
* _IS_STORAGE means the user can read mail from there.
|
|
*/
|
|
#define CAMEL_PROVIDER_IS_REMOTE (1 << 0)
|
|
#define CAMEL_PROVIDER_IS_SOURCE (1 << 1)
|
|
#define CAMEL_PROVIDER_IS_STORAGE (1 << 2)
|
|
#define CAMEL_PROVIDER_SUPPORTS_SSL (1 << 3)
|
|
|
|
|
|
/* Flags for url_flags. "ALLOW" means the config dialog will let
|
|
* the user configure it. "NEED" implies "ALLOW" but means the user
|
|
* must configure it. Service code can assume that any url part
|
|
* for which it has set the NEED flag will be set when the service
|
|
* is created.
|
|
*/
|
|
#define CAMEL_URL_PART_USER (1 << 0)
|
|
#define CAMEL_URL_PART_AUTH (1 << 1)
|
|
#define CAMEL_URL_PART_PASSWORD (1 << 2)
|
|
#define CAMEL_URL_PART_HOST (1 << 3)
|
|
#define CAMEL_URL_PART_PORT (1 << 4)
|
|
#define CAMEL_URL_PART_PATH (1 << 5)
|
|
|
|
#define CAMEL_URL_PART_NEED 6
|
|
|
|
/* Use these macros to test a provider's url_flags */
|
|
#define CAMEL_PROVIDER_ALLOWS(prov, flags) (prov->url_flags & (flags | (flags << CAMEL_URL_PART_NEED)))
|
|
#define CAMEL_PROVIDER_NEEDS(prov, flags) (prov->url_flags & (flags << CAMEL_URL_PART_NEED))
|
|
|
|
/* Providers use these macros to actually define their url_flags */
|
|
#define CAMEL_URL_ALLOW_USER (CAMEL_URL_PART_USER)
|
|
#define CAMEL_URL_ALLOW_AUTH (CAMEL_URL_PART_AUTH)
|
|
#define CAMEL_URL_ALLOW_PASSWORD (CAMEL_URL_PART_PASSWORD)
|
|
#define CAMEL_URL_ALLOW_HOST (CAMEL_URL_PART_HOST)
|
|
#define CAMEL_URL_ALLOW_PORT (CAMEL_URL_PART_PORT)
|
|
#define CAMEL_URL_ALLOW_PATH (CAMEL_URL_PART_PATH)
|
|
|
|
#define CAMEL_URL_NEED_USER (CAMEL_URL_PART_USER << CAMEL_URL_PART_NEED)
|
|
#define CAMEL_URL_NEED_AUTH (CAMEL_URL_PART_AUTH << CAMEL_URL_PART_NEED)
|
|
#define CAMEL_URL_NEED_PASSWORD (CAMEL_URL_PART_PASSWORD << CAMEL_URL_PART_NEED)
|
|
#define CAMEL_URL_NEED_HOST (CAMEL_URL_PART_HOST << CAMEL_URL_PART_NEED)
|
|
#define CAMEL_URL_NEED_PORT (CAMEL_URL_PART_PORT << CAMEL_URL_PART_NEED)
|
|
#define CAMEL_URL_NEED_PATH (CAMEL_URL_PART_PATH << CAMEL_URL_PART_NEED)
|
|
|
|
#define CAMEL_URL_PATH_IS_ABSOLUTE (1 << 12)
|
|
|
|
|
|
/* Generic extra config stuff */
|
|
typedef enum {
|
|
CAMEL_PROVIDER_CONF_END,
|
|
CAMEL_PROVIDER_CONF_SECTION_START,
|
|
CAMEL_PROVIDER_CONF_SECTION_END,
|
|
CAMEL_PROVIDER_CONF_CHECKBOX,
|
|
CAMEL_PROVIDER_CONF_CHECKSPIN,
|
|
CAMEL_PROVIDER_CONF_ENTRY,
|
|
} CamelProviderConfType;
|
|
|
|
typedef struct {
|
|
CamelProviderConfType type;
|
|
char *name, *depname;
|
|
char *text, *value;
|
|
} CamelProviderConfEntry;
|
|
|
|
|
|
|
|
typedef struct {
|
|
/* Provider name used in CamelURLs. */
|
|
char *protocol;
|
|
|
|
/* Provider name as used by people. (May be the same as protocol) */
|
|
char *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.
|
|
*/
|
|
char *description;
|
|
|
|
/* The category of message that this provider works with.
|
|
* (evolution-mail will only list a provider in the store/transport
|
|
* config dialogs if its domain is "mail".)
|
|
*/
|
|
char *domain;
|
|
|
|
/* Flags describing the provider, flags describing its URLs */
|
|
int flags, url_flags;
|
|
|
|
/* Extra configuration information */
|
|
CamelProviderConfEntry *extra_conf;
|
|
|
|
CamelType object_types [CAMEL_NUM_PROVIDER_TYPES];
|
|
|
|
/* GList of CamelServiceAuthTypes the provider supports */
|
|
GList *authtypes;
|
|
|
|
GHashTable *service_cache;
|
|
|
|
} CamelProvider;
|
|
|
|
GHashTable *camel_provider_init (void);
|
|
void camel_provider_load (CamelSession *session, const char *path, CamelException *ex);
|
|
|
|
/* This is defined by each module, not by camel-provider.c. */
|
|
void camel_provider_module_init (CamelSession *session);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif /* __cplusplus */
|
|
|
|
#endif /* CAMEL_PROVIDER_H */
|