mail::loginUrlEncode(3x)

1MAIL::LOGINURLENCODE(3x)Cone: COnsole Newsreader And EMAIL::LOGINURLENCODE(3x)
2
3
4

NAME

6       mail::loginUrlEncode - Create a mail account URL
7

SYNOPSIS

9       #include <libmail/mail.H>
10
11
12       std::string url=mail::loginUrlEncode(std::string method,
13                                            std::string server,
14                                            std::string uid,
15                                            std::string password);
16

USAGE

18       This utility function creates a URL, suitable for
19       mail::account::open(3x), for opening a mail account on a remote server.
20
21       method is one of the supported libmail network protocols: "imap",
22       "imaps", "pop3", "pop3s", "nntp", "nntps", "smtp", or "smtps".  server
23       is the remote server name. The server name is optionally appended by a
24       colon and a port number, to specify a non-default port for the
25       protocol.
26
27       uid identifies the mail account´s login id. With "smtp", or "smtps",
28       uid specifies the userid for authenticated ESMTP. The password is
29       optional.  mail::account::open(3x) accepts a separate password
30       parameter. This password should be an empty string, so that the
31       resulting URL does not include the password. The real password is then
32       passed as a parameter to mail::account::open(3x). As an alternative,
33       this password parameter can be initialized. The resulting URL will
34       include the password, and the the password parameter to
35       mail::account::open(3x). should be set to an empty string.
36
37   Options
38       Additional protocol options are specified by prefixing each option with
39       the forward-slash character, "/", and appending all options to server
40       (after any optional protocol port number).
41

RETURN CODES

43       This function returns the resulting URL.
44

NAME

SYNOPSIS

USAGE

RETURN CODES

SEE ALSO