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       #include <libmail/sync.H>
11
12       mail::ACCOUNT *mail;
13
14       std::string path=mail->translatePath(std::string folderPath);
15

USAGE

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

RETURN CODES AND CALLBACKS

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

SEE ALSO

55       mail::ACCOUNT::getFolderFromPath(3x),
56       mail::ACCOUNT::getFolderFromString(3x), mail::setAppCharset(3x).
57

NOTES

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