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

NAME

6       mail::account::translatePath - Convert readable folder path to internal
7       folder path
8

SYNOPSIS

10       std::string folderPath=folder->getPath();
11
12       std::string path=account->translatePath(std::string folderPath);
13

USAGE

15       This function converts a human-readable representation of a folder´s
16       path to the internal folder path in the mail account. For example, IMAP
17       server mailboxes use names encoded in a modified version of the UTF-7
18       character set, and this method converts a folder path from the
19       application´s character set to the modified UTF-7 character set.
20       Specifically:
21
22       IMAP[1]
23
24           folderPath is converted from application´s character set to the
25           modified UTF-7 character set.
26
27       SMAP
28
29           folderPath is converted from application´s character set to UTF-8.
30           The forward slash character, “/” separates names of individual
31           folders in the SMAP hierarchy. Unicode/ISO-10646 characters that
32           cannot be represented in the application´s character set may be
33           specified as “%n;”, where n is a decimal Unicode value. Use “\/” to
34           specify a forward slash character in the folder name, “\\” to
35           specify a backslash character, and “\%” to specify the “%”
36           character.
37
38       mbox mail folders, and maildirs
39
40           folderPath is converted from application´s character set to
41           modified UTF-7 encoding. The forward slash character, “/” separates
42           names of individual folders in the local mail folder hierarchy.
43           Unicode/ISO-10646 characters that cannot be represented in the
44           application´s character set may be specified as “%n;”, where n is a
45           decimal Unicode value. Use “\\” to specify a backslash character,
46           and “\%” to specify the “%” character.
47

RETURN CODES AND CALLBACKS

49       This function returns the converted path string. An empty string is
50       returned if folderPath is not a valid folder path.
51

SEE ALSO

53       mail::account::findfolder(3x), mail::account::folderFromString(3x),
54       mail::setAppCharset(3x).
55

NOTES

57        1. IMAP
58           http://www.rfc-editor.org/rfc/rfc3501.txt
59
60
61
62[FIXME: source]                   05/08/2010          MAIL::ACCOUNT::TRANS(3x)
Impressum