diff options
author | Vincent Richard <[email protected]> | 2004-12-26 20:23:29 +0000 |
---|---|---|
committer | Vincent Richard <[email protected]> | 2004-12-26 20:23:29 +0000 |
commit | 4ce991d3b1bd97fbb896d17fb8f36f6650429a22 (patch) | |
tree | 2db6e072b862dd809d4acd8c571a1b859fdcb484 /src/messaging/session.hpp | |
parent | Allow creating a service from an URL. (diff) | |
download | vmime-4ce991d3b1bd97fbb896d17fb8f36f6650429a22.tar.gz vmime-4ce991d3b1bd97fbb896d17fb8f36f6650429a22.zip |
Moved all header files to 'vmime/' directory.
Diffstat (limited to 'src/messaging/session.hpp')
-rw-r--r-- | src/messaging/session.hpp | 134 |
1 files changed, 0 insertions, 134 deletions
diff --git a/src/messaging/session.hpp b/src/messaging/session.hpp deleted file mode 100644 index 4ee25157..00000000 --- a/src/messaging/session.hpp +++ /dev/null @@ -1,134 +0,0 @@ -// -// VMime library (http://vmime.sourceforge.net) -// Copyright (C) 2002-2004 Vincent Richard <[email protected]> -// -// 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., 675 Mass Ave, Cambridge, MA 02139, USA. -// - -#ifndef VMIME_MESSAGING_SESSION_HPP_INCLUDED -#define VMIME_MESSAGING_SESSION_HPP_INCLUDED - - -#include "messaging/authenticator.hpp" -#include "messaging/progressionListener.hpp" -#include "messaging/url.hpp" - -#include "propertySet.hpp" - - -namespace vmime { -namespace messaging { - - -class store; -class transport; - - -/** An object that contains all the information needed - * for connection to a service. - */ - -class session -{ -public: - - session(); - session(const propertySet& props); - - virtual ~session(); - - /** Return a transport service instance for the protocol specified - * in the session properties. - * - * The property "transport.protocol" specify the protocol to use. - * - * @param auth authenticator object to use for the new transport service. If - * NULL, a default one is used. The default authenticator simply return user - * credentials by reading the session properties "auth.username" and "auth.password". - * @return a new transport service - */ - transport* getTransport(authenticator* auth = NULL); - - /** Return a transport service instance for the specified protocol. - * - * @param protocol transport protocol to use (eg. "smtp") - * @param auth authenticator object to use for the new transport service. If - * NULL, a default one is used. The default authenticator simply return user - * credentials by reading the session properties "auth.username" and "auth.password". - * @return a new transport service - */ - transport* getTransport(const string& protocol, authenticator* auth = NULL); - - /** Return a transport service instance for the specified URL. - * - * @param url full URL with at least the protocol to use (eg: "smtp://myserver.com/") - * @param auth authenticator object to use for the new transport service. If - * NULL, a default one is used. The default authenticator simply return user - * credentials by reading the session properties "auth.username" and "auth.password". - * @return a new transport service - */ - transport* getTransport(const messaging::url& url, authenticator* auth = NULL); - - /** Return a transport service instance for the protocol specified - * in the session properties. - * - * The property "store.protocol" specify the protocol to use. - * - * @param auth authenticator object to use for the new store service. If - * NULL, a default one is used. The default authenticator simply return user - * credentials by reading the session properties "auth.username" and "auth.password". - * @return a new store service - */ - store* getStore(authenticator* auth = NULL); - - /** Return a store service instance for the specified protocol. - * - * @param protocol store protocol to use (eg. "imap") - * @param auth authenticator object to use for the new store service. If - * NULL, a default one is used. The default authenticator simply return user - * credentials by reading the session properties "auth.username" and "auth.password". - * @return a new store service - */ - store* getStore(const string& protocol, authenticator* auth = NULL); - - /** Return a store service instance for the specified URL. - * - * @param url full URL with at least the protocol to use (eg: "imap://username:[email protected]/") - * @param auth authenticator object to use for the new store service. If - * NULL, a default one is used. The default authenticator simply return user - * credentials by reading the session properties "auth.username" and "auth.password". - * @return a new store service - */ - store* getStore(const messaging::url& url, authenticator* auth = NULL); - - /** Properties for the session and for the services. - */ - const propertySet& getProperties() const; - - /** Properties for the session and for the services. - */ - propertySet& getProperties(); - -private: - - propertySet m_props; -}; - - -} // messaging -} // vmime - - -#endif // VMIME_MESSAGING_SESSION_HPP_INCLUDED |