| Internet Engineering Task Force | I. Radu, Ed. |
| Internet-Draft | |
| Intended status: Informational | October 27, 2014 |
| Expires: April 30, 2015 |
Advanced Groupware Access Protocol
draft-iulian-advanced-groupware-access-protocol-10
The Advanced Groupware Access Protocol, (AGAP) allows a client to access and store electronic mail messages, contacts, events, files, and configurations on a server. The electronic mail messages can be grouped in folders. AGAP also provides the capability for an offline client to resynchronize with the server.
AGAP does not specify a means of posting electronic mail messages; this function is handled by a mail transfer protocol such as SMTP [RFC2821] . It also does not specify a means for exchanging messages with contacts that are reported as being online; this function is handled by an instant messaging protocol such as XMPP [RFC3921] .
AGAP includes the following operations for electronic mail messages: creating, deleting, renaming, moving and coping mail folders; checking for new messages; permanently removing messages; moving and coping messages between folders; fetching information about a message; setting and clearing tags for messages; searching in messages; retrieving only a part of a message; marking messages as SPAM; deleting attachments from a message.
AGAP includes the following operations to manipulate the contacts: creating, deleting, moving, coping, tagging, and searching contacts; checking if a contact is online; fetching information about a contact.
AGAP includes the following operations related to the use of the events: creating, deleting, moving, coping and tagging events in calendar; fetching events details; searching for events.
All items are read and written in format XML encoded UTF-8 [RFC3629] and each item is identified by a unique alphanumeric identifier.
AGAP is designed to support access only to a single server per connection. It is also designed to balance the volume of text exchanged between the server and clients and its readability by humans for debugging.
This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."
This Internet-Draft will expire on April 30, 2015.
Copyright (c) 2014 IETF Trust and the persons identified as the document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.
This document is written from the point of view of someone implementing an AGAP client or server, and also from the point of view of a server administrator. The protocol overview (chapter 2) presents all aspects related to a correct implementation (like the maximum length of a command or response line, charset used). The material in chapter 3 through 5 provides the states in which can be a connection at a moment, respectively what commands are valid in each state and their valid responses. Chapter 6 makes a summary of the return codes for each command. The implementers find in chapter 7 samples of conversations so that they can test the compliance of their applications with this standard.
Document conventions are noted in this chapter. The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT","MAY", and "OPTIONAL" in this document are to be interpreted as described in 'Key words for use in RFCs to Indicate Requirement Levels' [RFC2119] . The word "CAN" (not "MAY") is used to refer to a possible circumstance or situation, as opposed to an optional facility of the protocol.
"User" is used to refer to a human user. "Client" refers to the software being run by the user. "Server" refers to the software responding to the client requests. In examples, "C:" and "S:" indicate lines sent by the client and server respectively. "Connection" refers to the entire sequence of client/server interaction from the initial establishment of the network connection until its termination. "Conversation" is an exchange of commands and responses between the client and the server. "Account" defines all folders and their content that can be accessed from Authenticated State. All references to characters order is according to the UTF-8 [RFC3629] specification.
All data exchanged between the server and the client is done using strings encoded UTF-8 [RFC3629] . If the server or client send a string incorrect encoded then the other side can close immediately the connection.
A command or response consists of a line of text that has a maximal length of 1024 characters (including line end). A line of text is ended with the character LF (0x0A). There can be optionally a CR character (0x0D) before the LF character. If the server or client sends a line with a length greater of 1024 then the other side can close immediately the connection.
The numbers that are used in commands are signed integers on 32 bits. The valid values are between -2,147,483,648 and 2,147,483,647.
Following is a resume of all regular expression rules that CAN be used by the commands defined in this standard:
Logical operators:
XY X followed by Y
X|Y Either X or Y
Predefined character class:
. Any character (does not match line terminators)
Characters:
x The character x
\\ The backslash character
\xhh The character with hexadecimal value 0xhh
\uhhhh The character with hexadecimal value 0xhhhh
\t The tab character ('\x09')
\n The newline (line feed) character ('\x0A')
\r The carriage-return character ('\x0D')
Character classes:
[abc] a, b, or c (simple class)
[^abc] Any character except a, b, or c (negation)
[a-zA-Z] a through z or A through Z, inclusive (range)
Boundary matchers:
^ The beginning of a line
$ The end of a line
\b A word boundary
\B A non-word boundary
Greedy quantifiers:
X? X, once or not at all
X* X, zero or more times
X+ X, one or more times
X{n} X, exactly n times
X{n,} X, at least n times
X{n,m} X, at least n but not more than m times
Reluctant quantifiers:
X?? X, once or not at all
X*? X, zero or more times
X+? X, one or more times
X{n}? X, exactly n times
X{n,}? X, at least n times
X{n,m}? X, at least n but not more than m times
Figure 1
The length of an UID is between 1 and 32 characters.
The UIDs MUST to be unique only between items from the same folder.
The characters accepted for building an UID are only all 26 Latin letters (A-Z) in lowercase and uppercase and all 10 Latin digits (0-9). An UID is case sensitive and it is the same for each connections, except after server change it and announce the change by changing the ECID assigned to the corresponding folder.
Any new item MUST have a bigger UID as all other existing items in the selected folder. The sorting is made according UTF-8 [RFC3629] (digits before letters and uppercase letters before the lowercase letters - 0..9A..Za..z). A shorter UID is before a longer one (9234 before 02345) and any zero (0) before a number is take into account by the server when two UIDs are compared.
We get an approximately maximum number of 4.50+e+17 unique combinations for 32 characters long UIDs. We get a maximum number of 3381098545 unique combinations for 8 characters long UIDs.
An FCID has the same format as a normal UID and each new value of an FCID is bigger as the precedent one (as is described for UIDs). An FCID is changed for a folder when the structure of the folder is changed (subfolders are added or removed). The FCID of a folder is not changed if it is changed the (sub)child of one of its children.
An ECID has the same format as a normal UID and each new value of an ECID is bigger as the precedent one (as is described for UIDs). If the last ECID has already had the biggest valid UID value then its new value can be the first valid UID value. An ECID is changed for a folder when items ware added or removed. Or when the server had changed the UIDs assigned to the items. This can be necessary if, for example, there is a new item and already last valid UID was assigned to an other item. The new UIDs must keep the items in the same order as before the renumbering.
Binary content must be encoded using the BASE64 [RFC4648] method and the corresponding tag must have the ENCODED attribute set to "base64" (if it is not assumed as default encoding method). All BASE64 encoded content found in one line must have a length divisible by 4. The server can refuse an encoded content having a length not divisible by 4 in a line.
A text content can be passed as it is ( UTF-8 [RFC3629] ) or it can be encoded using the BASE64 [RFC4648] method. The corresponding tag must have the ENCODED attribute set to "utf-8", in case of plain text, and to "base64", if the content was encoded using the BASE64 method.
An SRV record (Service record) defines the location in the DNS (Domain Name System) of a server providing a specified service. It is defined in RFC 2782 [RFC2782] . A non-secured port is searched with _agap and a secured port with _agaps as _service name.
An SRV record has the form:
_service._proto.name ttl IN SRV priority weight port target
The following textual item can be used to specify the location of an AGAP service:
_agap._tcp.example.com. 86400 IN SRV 0 5 143 agapserver.example.com.
The following textual item can be used to specify the location of a secured AGAP port (via SSL):
_agaps._tcp.example.com. 86400 IN SRV 0 5 993 agapserver.example.com.
All folder names are case sensitive and they are encoded according to UTF-8 [RFC3629] .
A backslash (\) does not escape the character after it (it has no special meaning).
For building a folder name, the user CAN use all UTF-8 [RFC3629] characters with a value bigger then 0x1f (white space is the first allowed character), but with the exception of the slash (/ 9x2F), back slash (\ 0x5C), multiplication sign (* 0x2A), and question mark (? 0x3F).
The following folder names are also not accepted: '.', and '..'.
None of the reserved folders can have subfolders, exception makes TRASH that must store also deleted folders and FILESHARE that holds ordinary files.
The character used for delimiting path levels is the slash (/). A path that starts with '/' represents an absolute path. All other are relative to currently selected folder (with SLCT).
If there is no folder currently selected then the client MUST use only absolute paths. It is recommended for a client to use always absolute paths.
The following folder types are defined by this standard:
Each of these types allow for subfolders in them.
All the following reserved folders are located in the root of the user's account:
A client can use different names for these folders when display them so that the client application can use localization and standard or customized names for them. If this is the case, then the user cannot create a folder, in the root of his account, with the same name as the real (reserved) name of the folder.
The client can set tags for folder and folder items. The tags of a folder are reported by the STAT command and can be read with GFTG. The tags of an item can be get with GTAG. The tags of a server can be set with SFTG, and the tags for folder items with STAG.
The format of a tag is a name optionally followed by the equal sign (=) and a value. Each time a tag is set, the new value replace the old one. All tags that have no value assigned are returned only as names. Assigning an empty value to a tag makes it to return a name followed by the equal sign and no value. Setting a tag without a value for an item which previously had the same tag with a value makes the tag to lose its value and to be returned as name only (without the equal sign).
The characters accepted for building a TAG are only all 26 Latin letters (A-Z) in uppercase, all 10 Latin digits (0-9) and the minus sign (-). A TAG is case insensitive. Its length is between 1 and 32 characters.
The characters accepted for a TAG value are only all 26 Latin letters (A-Z) in lowercase and uppercase, all 10 Latin digits (0-9), plus the minus (-), underscore (_) and dot (.) characters. A TAG value is case sensitive. Its length is between 1 and 32 characters.
The server returns always the TAG names in uppercase, even if the client set them using a lowercase version. The server should convert silently any lowercase character in a TAG name (sent by client) to its corresponding uppercase character.
The following tag names have a meaning set by this standard for folders:
Implicit the folder's items can be read only by its owner.
The following tag names have a meaning set by this standard for messages:
An access right is represented by a letter between a and z, respectivelly between A and Z. A minus '-' sign means no rights. A lowercase letter represents a different right then its uppercase version.
This document defines following rights:
The ACL of a folder is made from pairs of rights and an account pattern. By default the ACL of a folder cannot be changed by user and an user have no rights. The rights for an user are the union of all rights found for matching account patterns. For the state STORING and PRESENCE, the rights are checked only at the access moment.
The account pattern is a regexp as defined in chapter 2.4 Regular Expressions in Commands .
All responses are in XML format. The tags and their attributes names are written only in uppercase. The values for attributes only in lowercase. The exception are header items for a message. The tags keep the case from the message.
The content is encoded in UTF-8 [RFC3629] format.
Each type of folder returns its items in a different format.
Each tag written in uppercase must to be send as it is, each tag written in lowercase will be replaced with the right value at the time of generation.
Each tag that have a question mark will be present only once if it is the case and without the question mark.
Each tag that have a star will be present, possible many times, only if it is the case and without the star.
If a command is correct but the server cannot execute it because of an internal error, then the server returns the code 401.
A response holding the content of an audio note has the following structure:
<AUDIO-NOTE>
<SUBJECT>...</SUBJECT>
<CONTENT type="text/..." encoded="utf-8|base64">...</CONTENT>
<AUDIO>...</AUDIO>
</AUDIO-NOTE>
Figure 2
Note: the subject can be any short text. The content can be encoded UTF-8 or BASE64. Implicit is content encoded in utf-8. The type can be any subtype of 'text/*'. Implicit is 'text/plain'. It is recommended to be used only 'text/plain' and 'text/html'.
Note: the audio represents the bytes of a linear PCM encoding of one channel having a frame rate of 8000 and 8 bits per sample, signed and in little endian order. These bytes are encoded BASE64.
Example:
<AUDIO-NOTE>
<SUBJECT>Important speaker recorded</SUBJECT>
<CONTENT type="text/plain" encoded="utf-8">
Listen the audio.</CONTENT>
<AUDIO>AAD//...</AUDIO>
</AUDIO-NOTE>
Figure 3
A response holding the content of a bookmark has the following structure:
<BOOKMARK>
<SUBJECT>...</SUBJECT>
<URL>https?://...</URL>
<CONTENT type="text/..." encoded="utf-8|base64">...</CONTENT>
</BOOKMARK>
Figure 4
Note: the subject can be any short text. The URL must start with http:// or https://. The content can be encoded UTF-8 or BASE64. Implicit is content encoded in utf-8. The type can be any subtype of 'text/*'. Implicit is 'text/plain'. It is recommended to be used only 'text/plain' and 'text/html'.
Example:
<NOTE>
<SUBJECT>The best search engine</SUBJECT>
<URL>http://www.google.com/</URL>
<CONTENT type="text/plain" encoded="utf-8">
Use it every day.</CONTENT>
</NOTE>
Figure 5
A calendar entry represents a non repetitive or repetitive action who took a specified amount of time. The format for a timestamp is: yyyy-mm-dd hh:mm:ss. All times are UTC/GMT times according Representation of dates and times [ISO.8601.1988]. The DESCRIPTION must be BASE-64 encoded if there are empty lines present. Implicitly the description is in UTF-8, but if it is BASE-64 encoded then there must be present 'encoded="base64"'. The implicit type of description is text/plain, but it can be also text/html.
The VERSION of a calendar entry is used when there are sent updates. Each new version must have a higher number.
The CONTENT has an implicit type of text/plain.
The list of weekdays are:
The LOCATION is a two fields record, with a TAB character (UTF-8 code 9) delimiting the two fields. It is represented bellow as \t.
The ALARM represents the timestamp in UTC when the alarm must be triggered.
A response holding the content of a calendar entry has the following structure:
<CALENDAR>
<UID>a_unique_string</UID>
<VERSION>version_as_a_number</VERSION>
<AUTHOR>author@domain</AUTHOR>
<SUBJECT>a subject</SUBJECT>
<STATUS>DECLINED|NEEDS-ACTION|ACCEPTED|another status</STATUS>
<FREE_BUSY>FREE|TENTATIVE|BUSY|OUT OF OFFICE|another status</FREE_BUSY>
<LOCATION>location name\tlocation address</LOCATION>
<START>yyyy-mm-dd hh:mm:ss</START>
<END>yyyy-mm-dd hh:mm:ss</END>
<CONTENT type="text/..." encoded="utf-8|base64">
description</CONTENT>
<ATTENDEE>attendee_as_name_or_email</ATTENDEE>...
<RESOURCE>resource_as_name_or_email</RESOURCE>...
<CATEGORY>a category</CATEGORY>...
<ALARM signal='audio|popup|email' email='email@address,...'>
yyyy-mm-dd hh:mm:ss</ALARM>
<JOURNAL>path_to_jrnl_folder</JOURNAL>...
<REPEAT_RULES>?
<DAYS>weekday,..</DAYS>?
</REPEAT_RULES>
</CALENDAR>
Figure 6
Example:
<CALENDAR>
<UID>CALENDAR-UIDx1234:author@domain</UID>
<VERSION>1</VERSION>
<AUTHOR>author@domain</AUTHOR>
<SUBJECT>To improve the draft for AGAP</SUBJECT>
<STATUS>ACCEPTED</STATUS>
<FREE_BUSY>BUSY</FREE_BUSY>
<LOCATION>Tower Office Landstrasse, Wien</LOCATION>
<START>2014-02-15 10:40:00</START>
<END>2014-03-25 15:59:59</END>
<CONTENT type="text/plain" encoded="utf-8">
Improved AGAP</CONTENT>
<ATTENDEE>iulian.radu@gmx.at</ATTENDEE>
<RESOURCE>PC</RESOURCE>
<CATEGORY>IETF_Drafts</CATEGORY>
<ALARM type='popup'>-300</ALARM>
<JOURNAL>/journal/projectX</JOURNAL>
<REPEAT_RULES>
<DAYS>MO,TU,WE,TH,FR</DAYS>
</REPEAT_RULES>
</CALENDAR>
Figure 7
A response holding the configuration has the following structure:
<CONFIGURATION>
<name>value</name>...
</CONFIGURATION>
Figure 8
Example:
<CONFIGURATION>
<CHECK-EACH-MIN>10</CHECK-EACH-MIN>
<QUOTA>1024</QUOTA>
</CONFIGURATION>
Figure 9
The format is derived from the one defined by the vCard [RFC2426] standard.
The following example corresponds to this VCARD definition:
BEGIN:VCARD
VERSION:3.0
FN:Iulian Radu
N:Radu;Iulian;;Dipl.Ing.;
ORG:Example Com\, Inc.;European Division
EMAIL;TYPE=internet,home:iulian.radu@gmx.at
TZ:+01:00
REV:20110531T184600Z
LOGO;TYPE=JPEG;ENCODING=b:ABCDEFGHIJ==
LABEL;TYPE=work;TYPE=parcel,intl:1. Operngasse\n1010 Wien\nAustria
END:VCARD
Figure 10
Example:
<VCARD>
<VERSION>3.0</VERSION>
<FN>Iulian Radu</FN>
<N>Radu;Iulian;;Dipl.Ing.;</N>
<ORG>Example Com, Inc.;European Division</ORG>
<EMAIL type="internet,home">iulian.radu@gmx.at</EMAIL>
<TZ>+01:00</TZ>
<REV>2011-05-31 18:46:00</REV>
<LOGO type="image/jpeg" encoded="base64">ABCDEFGHIJ==</LOGO>
<LABEL type="work,parcel,intl">1. Operngasse
1010 Wien
Austria</LABEL>
</VCARD>
Figure 11
The BEGIN:VCARD is replaced with <VCARD> and END:VCARD is replaced with </VCARD>. Each type in VCARD has a corresponding tag. As in RFC all types are defined in uppercase so are also defined all tags. All attributes are lowercase. All values of attribute TYPE from a VCARD must to be gathered together in a single list and passed as attribute TYPE to the corresponding tag (they are delimited by commas). Any escaped semicolon or comma in VCARD is also passed prefixed with a backslash in XML. Any \n is replaced with a real end of line. The VCARD attributes LANGUAGE, VALUE, CONTEXT and CHARSET must not be present in XML. The attribute ENCODING="b" is replaced with ENCODED="base64", any other encoding scheme is silently dropped. The client can also send an attribute ENCODED="utf-8" as this is the default encoding for tags. The format for a date is: YYYY-MM-DD. The format for a time is: HH:MM:SS. The format for a timestamp is: yyyy-mm-ddThh:mm:ssZ. All times are UTC/GMT times according Representation of dates and times [ISO.8601.1988]. As VCARD attribute VALUE is missing then the format of the value is detected automatically based on the context. For example, a value starting with 'http://' corresponds to a 'VALUE=uri'; an 'ENCODED="base64"' corresponds to a 'VALUE=binary'. Were VCARD standar accepts a date or a date-time then we expect to receive a timestamp (date-time). It is not accepted an attribute SOURCE for VCARD type as the content of this VCARD must be defined inside of the XML. Also are not accepted tags that corresponds to VCARD types having 'VALUE=uri:CID:', so referincing parts that cannot exists in this XML.
A response holding the content of a file has the following structure:
<FILE>
<NAME>name</NAME>
<TYPE>mime/type</TYPE>
<SIZE>size</SIZE>
<DESCRIPTION encoded="utf-8|base64">a short text</DESCRIPTION>
<CONTENT encoded="utf-8|base64">content</CONTENT>
</FILE>
Figure 12
The valid encodings type are: utf-8 and base64. The default encoding is utf-8. The size is in bytes.
Example:
<FILE>
<NAME>Example.txt</NAME>
<TYPE>text/plain</TYPE>
<SIZE>6</SIZE>
<DESCRIPTION>my first example</DESCRIPTION>
<CONTENT encoded="base64">c3VyZS4=</CONTENT>
</FILE>
Figure 13
An ruleOp can be: AND, OR, NOT, UID, TAG, HAS, IS, WILDCARD, REGEXP or NEW. The value associated to ruleOp is specified as an XML text node. The HAS has one attribute: PATH. The IS, WILDCARD and REGEXP tags have two attributes: PATH and OP. Their values are set as for a filter command (see chapter 4.3 Syntax of a Filter for more information). The tag RULES group all its rules in an AND group.
There must be assigned at least one folder and must be present at least a rule. Optionally can be gived a description using ABOUT tag. Cannot be assigned as folders for being searched folders of the following types: FILT and FOLD.
A response holding the content of a file has the following structure:
<FILTER>
<ABOUT>...</ABOUT>?
<FOLDERS>
<FOLDER>...</FOLDER>...
</FOLDERS>
<RULES>
<ruleOp>...</ruleOp>...
</RULES>
</FILTER>
Figure 14
Example:
<FILTER>
<ABOUT>A sample FILT filter.</ABOUT>
<FOLDERS>
<FOLDER>/INBOX</FOLDER>
<FOLDER>/Spam</FOLDER>
</FOLDERS>
<RULES>
<OR>
<IS path="/MESSAGE/HEADER/subject" op="=">Viagra</IS>
<AND>
<UID>UIDx1234:UIDx4321</UID>
<TAG>SPAM</TAG>
</AND>
</OR>
</RULES>
</FILTER>
Figure 15
A response holding the content of a Japp has the following structure:
<JAPP>
<JAR-NAME>jar file name</NAME>
<ICON type="image/mime-type">icon</ICON>
<JAPP-NAME>JAPP's name</JAPP-NAME>
<MAIN-CLASS>main-class</MAIN-CLASS>
<SIZE>size</SIZE>
<DESCRIPTION encoded="utf-8|base64">a short text</DESCRIPTION>
<CONTENT>content</CONTENT>
</JAPP>
Figure 16
The default encoding for DESCRIPTION is utf-8. The ICON and CONTENT are assumed to be encoded base64. The content is a jar file having as main class the class defined in the tag MAIN-CLASS.
Example:
<JAPP>
<NAME>Sokoban.jar</NAME>
<ICON type="image/png">AnIcon==</ICON>
<JAPP-NAME>Sokoban</JAPP-NAME>
<MAIN-CLASS>japp.Sokoban</MAIN-CLASS>
<SIZE>9</SIZE>
<DESCRIPTION>a short text</DESCRIPTION>
<CONTENT>ABCDEFGHIJ==</CONTENT>
</JAPP>
Figure 17
The DESCRIPTION tag do not accept an encoded attribute and the text must not have in it empty lines. If the text has empty lines then the server must refuse to accept this XML.
A journal entry represents a non repetitive action who took no time. The format for a timestamp is: yyyy-mm-dd hh:mm:ss. All times are UTC/GMT times according Representation of dates and times [ISO.8601.1988]. The DESCRIPTION must be BASE-64 encoded if there are empty lines present. Implicitly the description is in UTF-8, but if it is BASE-64 encoded then there must be present 'encoded="base64"'. The implicit type of description is text/plain, but it can be also text/html. A response holding the content of a journal entry has the following structure:
<JOURNAL>
<TIMESTAMP>yyyy-mm-dd hh:mm:ss</TIMESTAMP>
<AUTHOR>author@domain</AUTHOR>
<SUBJECT>a summary</SUBJECT>
<CONTENT type="text/..." encoded="utf-8|base64">
a description</CONTENT>
<ATTENDEE>attendee_as_name_or_email<ATTENDEE>...
</JOURNAL>
Figure 18
Example:
<JOURNAL>
<TIMESTAMP>2011-06-07 13:52:38</TIMESTAMP>
<AUTHOR>user@example.com</AUTHOR>
<SUBJECT>The AGAP was updated</SUBJECT>
<CONTENT type="text/html">A new version of AGAP
was uploaded to IETF</CONTENT>
<ATTENDEE>secretary@ietf.com</ATTENDEE>
<ATTENDEE>Iulian Radu
<iulian.radu@gmx.at></ATTENDEE>
</JOURNAL>
Figure 19
This type of folder allows for specifying a link to an item found in an other folder. It cannot indicate an item found in an other SLNK folder.
Example:
<SYMBOLIC-LINK>
<PATH>/Reports</PATH>
<UID>UIDx0012345</UID>
</SYMBOLIC-LINK>
Figure 20
A response holding the content of a message has the following structure:
<MESSAGE>
<HEADER>
<header-item-once>value</header-item-once>...
<header-item-multi>value 1
value 2
...
value n...</header-item-multi>...
</HEADER>
<TEXT? encoded="utf-8|base64">main text</TEXT>
<HTML? encoded="utf-8|base64">main html</HTML>
<ATTACHMENT-{id}*>
<HEADER>
...
</HEADER>
<BODY encoded="utf-8|base64">
...
</BODY>
</ATTACHMENT-{id}>...
</MESSAGE>
Figure 21
The first attachment id has value 1.
The id of on item tag shows the order of the items in the original message.
The default content encoding is utf-8. It is assumed that the content for TEXT and HTML is encoded in UTF-8 when the ENCODED attribut has the value base64.
The items in the header of the main message and attachments are the same with the one from the e-mail message.
There can be at most 2,147,483,647 attachments defined and their numbers must be sequential starting with 1.
Example:
<MESSAGE>
<HEADER>
<from>example@no-spam.com</from>
<to>example@example.com</to>
<received>
<item>
from mail.yahoo.com by example.com; Tue, 16 Mar 2010 12:14:24 +0100
</item>
<item>
from no-spam.com by mail.yahoo.com; Mon, 15 Mar 2010 11:13:23 +0100
</item>
</received>
<content-type>multipart/mixed; boundary="XYZ"</content-type>
<subject>A basic example</subject>
</HEADER>
<TEXT>Please see the attachments.</TEXT>
<HTML>
<b>Please</b> see the <u>attachments</u>.
</HTML>
<ATTACHMENT-1/>
<HEADER>
<content-type>text/plain</content-type>
</HEADER>
<BODY encoded="utf-8">See the picture.</BODY>
</ATTACHMENT-1>
<ATTACHMENT-2>
<HEADER>
<content-type>image/jpeg</content-type>
<content-transfer-encoding>base64</content-transfer-encoding>
</HEADER>
<BODY encoded="base64">c3VyZS4=</BODY>
</ATTACHMENT-2>
</MESSAGE>
Figure 22
The previous example corresponds to a message with the following structure:
A response holding the content of the note has the following structure:
<NOTE>
<SUBJECT>...</SUBJECT>
<CONTENT type="text/..." encoded="utf-8|base64">...</CONTENT>
</NOTE>
Figure 23
Note: the subject can be any short text. The content can be encoded UTF-8 or BASE64. Implicit is content encoded in utf-8. The type can be any subtype of 'text/*'. Implicit is 'text/plain'. It is recommended to be used only 'text/plain' and 'text/html'.
Example:
<NOTE>
<SUBJECT>Important!</SUBJECT>
<CONTENT type="text/plain" encoded="utf-8">
To review the code.</CONTENT>
</NOTE>
Figure 24
A task entry represents a non repetitive action who took a specified amount of time and which can have subtasks associated. The format for a timestamp is: yyyy-mm-dd hh:mm:ss. All times are UTC/GMT times according Representation of dates and times [ISO.8601.1988]. The DESCRIPTION must be BASE-64 encoded if there are empty lines present. Implicitly the description is in UTF-8, but if it is BASE-64 encoded then there must be present 'encoded="base64"'. The implicit type of description is text/plain, but it can be also text/html.
The VERSION of a task is used when there are sent updates. Each new version must have a higher number.
The CONTENT has an implicit type of text/plain.
The PRIORITY 0 means that there was no priority assigned and the higher the number the higer is the priority. The EFFORT means how difficult it is to implement this. The BENEFIT is how high is the ROI after implementing and using this. The POINTS is a value based on PRIORITY, EFFORT and BENEFIT and it is intendet to offer a mean for ordering the tasks. The higher the number the quicker should be the task implemented. The START-DAYS and DUE-DAYS says in which days of the week the task must start or end. The list is made from two letter days names delimited with comma. The list of weekdays are:
The GLUE defines how this task influence other tasks. The first start/due is for this task and the second start/due is for referenced task. If there is a delay present then it is applied after the two tasks were aligned. If the new timestamp do not meet the requirements of START-DAYS or END-DAYS then the user should be asked for deciding the new dates.
The ALARM represents the timestamp in UTC when the alarm must be triggered.
A response holding the content of a task entry has the following structure:
<TASK>
<UID>a_unique_string</UID>
<VERSION>version_as_a_number</VERSION>
<AUTHOR>author@domain</AUTHOR>
<SUBJECT>a subject</SUBJECT>
<STATUS>NOT-ASSIGNED|ASSIGNED|ACCEPTED|DECLINED|ON-HOLD|
WAITING-FOR-INFO|IN-PROGRESS|READY-FOR-REVIEW|IN-REVIEW|
APPROVED|DONE|another status</STATUS>
<LOCATION>a location as string</LOCATION>
<START-EARLIEST>yyyy-mm-dd hh:mm:ss</START-EARLIEST>?
<START-LATEST>yyyy-mm-dd hh:mm:ss</START-LATEST>?
<START-DAYS>weekday,..</START-DAYS>?
<START>yyyy-mm-dd hh:mm:ss</START>
<DUE-EARLIEST>yyyy-mm-dd hh:mm:ss</DUE-EARLIEST>?
<DUE-LATEST>yyyy-mm-dd hh:mm:ss</DUE-LATEST>?
<DUE-DAYS>weekday,..</DUE-DAYS>?
<DUE>yyyy-mm-dd hh:mm:ss</DUE>
<PRIORITY>priority_as_a_number_btwn_0_and_100</PRIORITY>
<PERCENT>percent_as_a_number_between_0_and_100</PERCENT>
<EFFORT>effort_as_a_number_between_0_and_100</EFFORT>
<BENEFIT>benefit_as_a_number_between_0_and_100</BENEFIT>
<POINTS>points_as_a_number_between_0_and_10000000</POINTS>
<CONTENT type="text/..." encoded="utf-8|base64">
description</CONTENT>
<ATTENDEE>attendee_as_name_or_email</ATTENDEE>...
<RESOURCE>resource_as_name_or_email</RESOURCE>...
<CATEGORY>a category</CATEGORY>...
<PARENT>TASK_UID_parent_task</PARENT>
<SUBTASK>TASK_UID_subtask</SUBTASK>...
<GLUE link="start-start|start-due|due-start|due-due"
delay="+-seconds">UID_task</GLUE>...
<ALARM signal='audio|popup|email' email='email@address,...'>
yyyy-mm-dd hh:mm:ss</ALARM>
<JOURNAL>path_to_jrnl_folder</JOURNAL>...
</TASK>
Figure 25
Example:
<TASK>
<UID>TASK-UIDx1234:author@domain</UID>
<VERSION>1</VERSION>
<AUTHOR>author@domain</AUTHOR>
<SUBJECT>To improve the draft for AGAP</SUBJECT>
<STATUS>IN-PROGRESS</STATUS>
<LOCATION>Wien</LOCATION>
<START-EARLIEST>2014-01-01 09:00:00</START-EARLIEST>
<START-LATEST>2014-06-01 09:00:00</START-LATEST>
<START-DAYS>MO,TU,WE,TH,FR</START-DAYS>
<START>2014-02-15 10:40:00</START>
<DUE-LATEST>2014-06-30 17:59:59</DUE-LATEST>
<DUE>2014-03-25 15:59:59</DUE>
<PRIORITY>80</PRIORITY>
<PERCENT>15</PERCENT>
<EFFORT>50</EFFORT>
<BENEFIT>100</BENEFIT>
<POINTS>400000</POINTS>
<CONTENT type="text/plain" encoded="utf-8">
Improved AGAP</CONTENT>
<ATTENDEE>iulian.radu@gmx.at</ATTENDEE>
<RESOURCE>PC</RESOURCE>
<CATEGORY>IETF_Drafts</CATEGORY>
<GLUE type="due-start" delay="86400">UIDNextDraftVersion</GLUE>
<ALARM type='popup'>-300</ALARM>
<JOURNAL>/journal/projectX</JOURNAL>
</TASK>
Figure 26
There is defined a virtual property DURATION which returns the difference in seconds between DUE and START.
This type of folder allows for specifying a time zone and a title for it.
Example:
<TIME-LOCATION>
<SUBJECT>Vienna, Austria</SUBJECT>
<TIMEZONE>Europe/Vienna</TIMEZONE>
</TIME-LOCATION>
Figure 27
This type of folder allows for specifying a location and a title for it.
Example:
<WEATHER>
<SUBJECT>Vienna, Austria</SUBJECT>
<LOCATION>Vienna</LOCATION>
...
</WEATHER>
Figure 28
This is the default state when a new connection is made to the server. The client becomes a welcome message.
From this state the client can use the command 'AUTH mechanism' to move in the 'Pre-authentication State'. This is the only other state in which the server can go.
The client can use the command 'STLS' for commuting in the encrypted mode of the channel. After STLS the server remains in the 'Not-authenticated State'. There is no command for switching back to clear-text communication.
The client can use the command 'SGZP' for commuting in the compressed mode of the channel. After SGZP the server remains in the 'Not-authenticated State'. There is no command for switching back to not-compressed communication.
A client can use at the same time the both modes (encrypted and compressed).
The client can use the command 'QUIT' for terminating the connection.
For finding what extensions are installed in server, the client can use the 'CAPA' command.
This is the state where a client authenticate itself and move to the 'Authenticated State' or returns to the 'Not-authenticated State'.
This standard defines only one method for AUTH: PLAIN. Following is a description of the commands flow used by this authentication mechanism.
The client must send a 'USER account' followed by a 'PASS password' (if the server confirms the acceptance of the account name). If the pair account and password is accepted then the server move to the state 'Authenticated State' and the folder INBOX is selected by server. If this folder does not exist then the server moves in the 'Not-Selected State' and the client must to select an existing folder for operating with this account. If this pair is rejected then the server returns to the 'Not-authenticated State'. That means that the client must to send a new 'AUTH mechanism' for trying a new authentication.
The client can use the command 'QUIT' for terminating the connection.
A client can enter into this state only after a successful 'AUTH' command in 'Not-authenticated State'.
This is the state from which a client operates with the content of an account.
From this state the client can use the command 'EXIT' to move in the 'Not-authenticated State'. After an unsuccessful SLCT, the server goes in 'Not-selected State'.
The client can use the command 'QUIT' for terminating the connection.
Check the following chapter for finding which commands can be performed from this state.
A client can enter into this state only after a successful authentication in the 'Pre-authenticated State' or after a successful 'SLCT' command in the 'Authenticated State' or 'Not-selected State'.
This is the state from which a client must to select a folder for performing further operations.
From this state the client must use the command 'SLCT' to select a folder and to move in the 'Authenticated State'. This is the only other state in which the server can go.
The client CAN use the command 'LIST' for finding valid folder names that eventually CAN be selected with 'SLCT' command.
The client CAN use the command 'QUIT' for terminating the connection.
A client CAN enter into this state only after an unsuccessful 'SLCT' command or if the INBOX folder does not exists and it cannot be selected automatically after a successful authentication.
This is the state in which a client can only ask information about the presence of an user/account.
In this state the client can use only the command 'PGET' to ask for presence information of an account (inclusive finding when a meeting can be scheduled) and the command 'QUIT' for terminating the connection.
This is the state in which a client can only add items (for example: messages, events) in an account which it is not his/her.
In this state the client can use only the command 'FSTO' to find and store the item into a folder of specified type from specified user and the command 'QUIT' for terminating the connection.
Each command has its name from 4 letters and it is matched case-insensitive.
Each command is separated by its arguments by a 0x20 character. Also, each argument is separated from its adjacent arguments by a 0x20 character.
The minimal response has only the return code without any text.
A list of elements is enclosed between parentheses (round brackets).
A tag list is used by the following commands: FTAG, GTAG, SFTG and STAG.
A tag list defines what action to be done with its tags.
Syntax: ACTION TAG TAG=VALUE ...
ACTION:
Note: When it is used the delete tags action and for a tag is set a value then the tag is deleted only if the current value match the value found in the delete command. If in delete command is specified a value for a tag which actually has no value set then this tag is not deleted. If in delete command is specified only the name of a tag without a value and the tag has a value assigned then the tag is deleted.
Example:
C: STAG UIDx1234 = SEEN SPAM=YES
C: STAG UIDx1234 + SEEN FLAG=RED OWNER=RAI
C: STAG UIDx1234 - FLAG JUNK OWNER=JOHN SEEN=
Figure 29
A filter of this type is used by the following commands: FCPY, FDEL, FTAG, FIND and FMOV.
A filter defines rules for matching items. It is defined as lines with rules and it is ended by an empty line.
The keywords of the filter are case insensitive matched (ex.: UID and Uid are the same).
A rule must be completely defined in the same line (exception are grouping, AND, OR, and NOT rules).
Accepted rules:
The field_path is a PATH as it is returned by RETR and must point to a not binary end leaf. It contains only tag names separated with /. Example: /MESSAGE/HEADER/subject, /MESSAGE/HEADER/received, /MESSAGE/TEXT, /MESSAGE/HTML, /MESSAGE/ATTACHMENT-1/HEADER/type, /MESSAGE/ATTACHMENT-1/BODY. There is an exception, for FILT folder types the path /FILTER/FOLDERS returns the list of folders with a folder path per line and the path /FILTER/FOLDERS/FOLDER is invalid.
Searching for a TAG without associating and a value to it will match all items having this tag, even if it have values set for it.
It can be searched only in the body of attachments that have a content type of type 'text/*'.
Example 1: These filters find all messages with the UID between UIDx0001:UIDx1000 and that were seen and marked as being spam or having a virus (the AND is redundant in the second case). Both filter definitions are equivalent.
C: UID UIDx0001:UIDx1000 ( OR TAG SPAM TAG HAS=VIRUS ) TAG SEEN
C: UID UIDx0001:UIDx1000 (AND ( OR TAG SPAM TAG HAS=VIRUS ) TAG SEEN)
Figure 30
Example 2:
C: AND and1 and2 OR and3or1 and3or2 OR and3or3 and3or4
C: AND and1 and2 OR and3or1 and3or2 AND and3or3and1 and3or3and2
C: OR or1 or2 AND or3and1 or3and2 AND or3and3 or3and4
C: OR or1 or2 AND or3and1 or3and2 OR or3and3or1 or3and3or2
C: AND and1 and2 (OR and3or1 and3or2) and4 and5
C: OR or1 or2 (AND or3and1 or3and2) or4 or5
Figure 31
Example 3:
C: IS /MESSAGE/HEADER/subject = 'From University'
C: REGEXP /MESSAGE/HEADER/FROM != '[^0-9]+@example\.com$'
C: IS /VCARD/FN = 'Anonymous'
C: REGEXP /VCARD/ORG = '^[A-Za-z]+[0-9]$'
Figure 32
A filter of this type is used by the following command: STOR.
A filter defines rules for matching the different messages from different folders. It is defined as an XML with target folders and rules.
The keywords of the filter are case sensitive matched (ex.: UID and Uid are not the same). They are always lowercase.
Accepted rules:
The field_path is a PATH as it is returned by RETR and must point to a not binary end leaf. It contains only tag names separated with /. Example: /MESSAGE/HEADER/subject, /MESSAGE/HEADER/received, /MESSAGE/TEXT, /MESSAGE/HTML, /MESSAGE/ATTACHMENT-1/BODY. There is an exception, for FILT folder types the path /FILTER/FOLDERS returns the list of folders with a folder path per line and the path /FILTER/FOLDERS/FOLDER is invalid.
Searching for a TAG without associating and a value to it will match all items that have this tag even if it have values set for it (the empty string is also considered matched).
The following two examples corresponds to the two examples from the previous chapter:
<FILTER>
<FOLDERS>
<FOLDER>/INBOX</FOLDER>
</FOLDERS>
<RULES>
<AND>
<UID>UIDx0001:UIDx0010</UID>
<OR>
<TAG>SPAM</TAG>
<TAG>HAS=VIRUS</TAG>
</OR>
<TAG>SEEN</TAG>
</AND>
</RULES>
</FILTER>
Figure 33
Example 2:
<FILTER>
<FOLDERS>
<FOLDER>/INBOX</FOLDER>
</FOLDERS>
<RULES>
<OR>
<IS path="/MESSAGE/HEADER/subject" op="=">From University</IS>
<REGEXP path="/MESSAGE/HEADER/FROM" op="!=">
[^0-9]+@example\.com$</REGEXP>
<IS path="/VCARD/FN" op="=">Anonymous</IS>
<REGEXP path="/VCARD/ORG" op="=">^[A-Za-z]+[0-9]$</REGEXP>
</OR>
</RULES>
</FILTER>
Figure 34
Results: 200 401 410 531
Result 200 - the client is accepted for sending commands;
Result 401 - there was an internal error;
Result 410 - too many connections;
Result 531 - the client is rejected permanently.
Description: When a client connects to the server it receives a welcome message. This message begins with a response code that shows if the client is accepted for sending commands.
Examples:
S: 200 Welcome localhost [127.0.0.1]
Figure 35
S: 401 Internal error, please contact our administrator
Figure 36
S: 410 Sorry, too many connections, please retry later
Figure 37
S: 531 Your hostname/IP (localhost:127.0.0.1) is blacklisted
Figure 38
Name: quit
Arguments: none
Result: 200
Description: The QUIT command close the connection between the client and server.
Example:
C: QUIT
S: 200 OK Bye
Figure 39
Name: authenticate
Argument: mechanism
Results: 200 510 511
Result 200 - the mechanism is known and accepted.
Result 510 - unknown command.
Result 511 - the mechanism is unknown/unsupported.
Description: Choose an authentication method. The name of the mechanism can contain only latin letters (A-Z), digits (0-9), the signs minus (-) and underscore (_). It is case insensitive. All supported mechanisms must to be advertised in CAPA's list of capabilities as AUTH-MechanismNameInUpperCase.
The PLAIN Authentication Mechanism: the client send the username and password in clear text using the commands USER and PASS.
The MD5 and SHA1 Authentication Mechanisms: the server send an additional line starting with a dot and providing a prefix that will gone be used by the client to send back to the server an MD5 or SHA-1 value computed on the string build from this prefix and user's password. This prefix can have between 1 and 256 characters. Allowed characters are any UTF-8 characters having a code bigger the decimal value 31 (first valid character is space). The initial dot is not part of the prefix. The client send the username and the computed hash using the commands USER and HASH.
The PRESENCE Authentication Mechanism: this mechanism is used by a client to query the presence of an user having an account on the server. If the server knows to forward the request to other servers (in case that requested account in not local) then it can return the answer from the remote server. The client send the username and password in clear text using the commands USER and PASS. For an anonymous access the server can accept as username anonymous and as password the email address of the connecting user. Once the username and password are accepted, the server enters in the presence state and the client can execute only the commands PGET and QUIT.
The PRESENCE-MD5 and PRESENCE-SHA1 Authentication Mechanisms: these mechanisms are working similar with MD5 and SHA1 authentication mechanisms, only that move the server in the same status as PRESENCE authentication mechanism.
The STORING Authentication Mechanism: this mechanism is used by a client to store items in accounts which are not his/hers. The client send the username and password in clear text using the commands USER and PASS. For an anonymous access the server can accept as username anonymous and as password the email address of the connecting user. Once the username and password are accepted, the server enters in the storing state and the client can execute only the commands FSTO and QUIT.
The STORING-MD5 and STORING-SHA1 Authentication Mechanisms: these mechanisms are working similar with MD5 and SHA1 authentication mechanisms, only that move the server in the same status as STORING authentication mechanism.
Examples:
C: AUTH PLAIN
S: 200 OK Send USER
C: USER anonymous
S: 200 OK Send PASS
C: PASS email@example.com
S: 200 OK User anonymous authenticated
Figure 40
C: AUTH MD5
S: .Hash prefix ... for user's password
S: 200 OK Send USER
C: USER anonymous
S: 200 OK Send HASH
C: HASH 79054025255fb1a26e4bc422aef54eb1
S: 200 OK Authenticated
Figure 41
C: AUTH SHA1
S: .Hash prefix ... for user's password
S: 200 OK Send USER
C: USER anonymous
S: 200 OK Send HASH
C: HASH de9f2c7fd25e1b3afad3e85a0bd17d9b100db4b4
S: 200 OK Authenticated
Figure 42
C: AUTH PRESENCE
S: 200 OK Send USER
C: USER anonymous
S: 200 OK Send PASS
C: PASS email@example.com
S: 200 OK User anonymous authenticated
Figure 43
C: AUTH PRESENCE-MD5
S: .Hash prefix ... for user's password
S: 200 OK Send USER
C: USER anonymous
S: 200 OK Send HASH
C: HASH 79054025255fb1a26e4bc422aef54eb1
S: 200 OK User anonymous authenticated
Figure 44
C: AUTH PRESENCE-SHA1
S: .Hash prefix ... for user's password
S: 200 OK Send USER
C: USER anonymous
S: 200 OK Send HASH
C: HASH de9f2c7fd25e1b3afad3e85a0bd17d9b100db4b4
S: 200 OK User anonymous authenticated
Figure 45
C: AUTH STORING
S: 200 OK Send USER
C: USER anonymous
S: 200 OK Send PASS
C: PASS email@example.com
S: 200 OK User anonymous authenticated
Figure 46
C: AUTH STORING-MD5
S: .Hash prefix ... for user's password
S: 200 OK Send USER
C: USER anonymous
S: 200 OK Send HASH
C: HASH 79054025255fb1a26e4bc422aef54eb1
S: 200 OK User anonymous authenticated
Figure 47
C: AUTH STORING-SHA1
S: .Hash prefix ... for user's password
S: 200 OK Send USER
C: USER anonymous
S: 200 OK Send HASH
C: HASH de9f2c7fd25e1b3afad3e85a0bd17d9b100db4b4
S: 200 OK User anonymous authenticated
Figure 48
C: AUTH
S: 510 UNKNOWN command
Figure 49
C: AUTH unknown
S: 511 UNKNWON method
Figure 50
Name: capabilities
Arguments: none
Result: 200
Description: Ask for the parts of this standards or extensions supported by the server.
Following is a list with all capabilities defined and covered by this document. If the server do no present an item from the following list then the client must assume that the sever is unable to do the associated operations of the missing item.
spwdFlags indicate the format for the password. After each flag can be specified a number indicating the minimum amount of characters which must correspond to this flag. If a flag is present then it is assumed that at least one character must correspond to it. The order of flags did not impose to keep that order in the new password. The following SPWD flag are defined by this draft:
Example:
C: CAPA
S: .GZIP
S: .TLS
S: .SPWD A1a7-1.1
S: .Extension1
S: .Extension.2 argument1
S: .Extension-3 argument1 argument2
S: 200 OK CAPA completed
Figure 51
Name: start using GZip
Arguments: none
Results: 200 510
Result 200 - the communication is now compressed.
Result 510 - unknown/unsupported command.
Description: Change the communication in compressed mode using GZIP [RFC1952] as compression method. If this command is executed from the compression mode then it simply returns a 200 response code. The response to this command is using still the not-compressed mode of the channel. The compression becomes effective only after a 200 response line was send by the server.
Note: With GZIP the data is compressed using the LZ77 algorithm and Huffman coding. Starting using this mode is like starting to write clear texts into a GZIP format archive and reading texts from a GZIP format archive. The compression is used both by the client and the server and they start to use it with the next line they send after the 200 response line received from the server.
Examples:
C: SGZP
S: 200 OK Using GZIP
Figure 52
C: SGZP
S: 510 UNKNOWN command
Figure 53
Name: start using TLS
Arguments: none
Results: 200 510
Result 200 - the communication is now encrypted.
Result 510 - unknown/unsupported command.
Description: Change the communication in mode TLS. If this command is executed from the encrypted mode then it simply returns a 200 response code. The response to this command is using still the not-encrypted mode of the channel. The encryption becomes effective only after a 200 response line was send by the server.
Examples:
C: STLS
S: 200 OK Using TLS
Figure 54
C: STLS
S: 510 UNKNOWN command
Figure 55
Name: hash
Argument: hash_code
Result: 200 510 511 512
Result 200 - the pair user/hash was successfully authenticated.
Result 510 - unknown/unsupported command.
Result 511 - invalid hash.
Result 512 - first send USER and then HASH.
Description: Send the hash code associated to the previous authentication method (MD5 or SHA1), previous USER and provided prefix.
Examples:
C: AUTH MD5
S: .prefix is-here!
S: 200 OK Send USER
C: USER account
S: 200 OK Send HASH
C: HASH 79054025255fb1a26e4bc422aef54eb1
S: 200 OK Authenticated
Figure 56
C: USER account
S: 200 OK Send HASH
C: HASH
S: 510 UNKNOWN command
Figure 57
C: USER account
S: 200 OK Send HASH
C: HASH 79054025255fb1a26e4bc422aef54eb1
S: 511 WRONG user/hash pair
Figure 58
C: AUTH SHA1
S: .prefix is-here!
S: 200 OK Send USER
C: HASH de9f2c7fd25e1b3afad3e85a0bd17d9b100db4b3
S: 512 EXPECTED USER
Figure 59
Name: password
Argument: password
Result: 200 510 511 512
Result 200 - the pair user/password was successfully authenticated.
Result 510 - unknown/unsupported command.
Result 511 - invalid password.
Result 512 - first send USER and then PASS.
Description: Send the password associated to the previous USER.
Examples:
C: USER account
S: 200 OK Send PASS
C: PASS password
S: 200 OK Authenticated
Figure 60
C: USER account
S: 200 OK Send PASS
C: PASS
S: 510 UNKNOWN command
Figure 61
C: USER account
S: 200 OK Send PASS
C: PASS password
S: 511 WRONG user/password pair
Figure 62
C: AUTH PLAIN
S: 200 OK AUTH completed
C: PASS password
S: 512 EXPECTED USER
Figure 63
Name: user
Argument: account
Result: 200
Result: 200 510 511
Result 200 - the user is accepted and expecting the password.
Result 510 - unknown/unsupported command.
Result 511 - invalid account.
Description: Send an account name for authentication and authorization.
Examples:
C: AUTH PLAIN
S: 200 OK Send USER
C: USER account
S: 200 OK Send PASS
Figure 64
C: AUTH PLAIN
S: 200 OK Send USER
C: USER
S: 510 UNKNOWN command
Figure 65
C: AUTH PLAIN
S: 200 OK Send USER
C: USER account
S: 511 INVALID username
Figure 66
Name: add a ACL for selected folder
Arguments: rights account
Result: 200 510 511 541
Result 200 - the command was successful.
Result 510 - unknown/unsupported command.
Result 511 - the rights are incorrect or the account is missing.
Result 541 - the user does not have enough rights to change the ACL rights.
Description: Add a new ACL to the current list of ACLs for selected folder or replace the old rights if exists an item for this account.
Examples:
C: AACL ADR *@mydomain.com
S: 200 OK The ACL was successfully added
C: AACL R *@mydomain.com
S: 200 OK The ACL was successfully replaced
Figure 67
C: AACL
S: 510 UNKNOWN command
Figure 68
C: AACL GR user@domain.com
S: 511 UNKNOWN right G
Figure 69
Name: set currently selected folder as public folder for its type
Arguments: none
Result: 200 410 510
Result 200 - the command was successful.
Result 410 - for the moment the selected folder cannot be added to the list of public folders.
Result 510 - unknown/unsupported command.
Description: Add currently selected folder to the list of public folders.
Note: If there was already set a folder for this type then the previously folder is removed from the list.
Examples:
C: APBL
S: 200 OK Folder /MyCalendar was made PUBLIC for CALE
Figure 70
C: APBL
S: 410 Please retry to add it later
Figure 71
C: APBL
S: 510 UNKNOWN command
Figure 72
Name: report the FCID (Folder Change ID) for all folders
Arguments: path?
Result: 200 510 511
Result 200 - the command was successful.
Result 510 - unknown/unsupported command.
Result 511 - the path is invalid.
Description: Return a list with the FCID of all folders or of the specified path.
Note: For no path in the list is included and the root folder for all other folders as slash ('/').
Examples:
C: CHNG
S: .0BIH /
S: .0009 /Temporary
S: .0001 /Temporary/1980
S: .0BIG /INBOX
S: .0123 /ARCHIVE
S: .0003 /ARCHIVE/2010
S: .0003 /ARCHIVE/2011
S: .00aA /ARCHIVE/2010/OLD
S: 200 OK CHNG completed
C: CHNG /Temporary/1980
S: .0001 /Temporary/1980
S: 200 OK CHNG completed
Figure 73
Note: A change in /ARCHIVE/2010 will change the FCID of /ARCHIVE/2010, but not the FCID of /ARCHIVE nor /.
C: CHNG
S: 510 UNKNOWN command
Figure 74
C: CHNG /no/path
S: 511 UNKNOWN path
Figure 75
Name: copy item
Arguments: UID_source path_destination_folder
Result: 200 510 511
Result 200 - the copy was successful.
Result 510 - unknown/unsupported command.
Result 511 - unknown uid, invalid destination folder or path not absolute.
Result 541 - the user does not have enough rights to read items from source or write in destination folder.
Description: Copy an item from currently selected folder into another folder (by UID).
Note: For copying a folder the client must use CPYF or CPFC.
Examples:
C: COPY UIDx1234 /ARCHIVE_FOLDER/TODAY
S: 200 OK COPY completed
Figure 76
C: COPY
S: 510 UNKNOWN command
Figure 77
C: COPY UIDx1234 ARCHIVE_FOLDER/TODAY
S: 511 INVALID UID
C: COPY MSGx1234 ARCHIVE_FOLDER/1970
S: 511 INVALID Destination
Figure 78
Name: copy folder content
Argument: path_destination_folder
Result: 200 510 511
Result 200 - the copy was successful.
Result 510 - unknown/unsupported command.
Result 511 - invalid destination folder, destination is not an absolute path or destination does not exists.
Result 541 - the user does not have enough rights to read items from source or write in destination folder.
Description: Copy the non-folder content of a folder into another folder.
Examples (in TODAY are copied only the messages from INBOX):
C: SLCT /INBOX
S: 200 Selected /INBOX
C: CPFC /ARCHIVE_FOLDER/TODAY
S: 200 OK CPFC completed (100 items)
Figure 79
C: CPFC
S: 510 UNKNOWN command
Figure 80
C: CPFC NoAbsolutePath
S: 511 INVALID Destination
C: CPFC /IDoNotExist
S: 511 Destination folder not found
Figure 81
Name: copy folder and its content and subfolders
Argument: path_destination_folder/new_folder_name
Result: 200 510 511
Result 200 - the copy was successful.
Result 510 - unknown/unsupported command.
Result 511 - invalid destination folder, destination is not an absolute path or destination exists.
Result 541 - the user does not have enough rights to read items from source or to create the destination folder.
Description: Copy a folder together with its content and subfolders into another new folder.
Examples:
C: SLCT /INBOX
S: 200 Selected /INBOX
C: CPYF /ARCHIVE_FOLDER/TODAY
S: 200 OK CPYF completed (100 items, 5 subfolders)
Figure 82
C: CPYF
S: 510 UNKNOWN command
Figure 83
C: CPYF NoAbsolutePath
S: 511 INVALID destination
C: CPYF /IAlreadyExist
S: 511 Destination folder exists
Figure 84
Name: delete an ACL from selected folder
Argument: account
Result: 200 220 510 511
Result 200 - the command was successful and the account was removed from ACL.
Result 220 - the command was successful, but the account was not found in ACL.
Result 510 - unknown/unsupported command.
Result 511 - the account is missing or incorrect.
Result 541 - the user does not have enough rights to change the ACL rights.
Description: Delete an ACL from currently selected folder ACLs.
Examples:
C: DACL *@mydomain.com
S: 200 OK The ACL was successfully deleted
Figure 85
C: DACL user@domain.com
S: 220 Entry not found
Figure 86
C: DACL
S: 510 UNKNOWN command
Figure 87
C: DACL @domain.com
S: 511 UNKNOWN item format
Figure 88
Name: delete item
Argument: UID path?
Result: 200 510 511
Result 200 - the item was successfully deleted.
Result 510 - unknown/unsupported command.
Result 511 - unknown uid.
Result 541 - the user does not have enough rights to delete the item.
Description: Delete an item by uid or a value based on path in this uid.
Note: It cannot be undone.
Examples:
C: DELE UIDx1234
S: 200 OK Message deleted
Figure 89
C: DELE
S: 510 UNKNOWN command
Figure 90
C: DELE 1234
S: 511 INVALID UID
Figure 91
Name: delete folder
Arguments: none
Result: 200 510 511
Result 200 - the folder was successfully deleted.
Result 510 - unknown/unsupported command.
Result 511 - no folder was selected or the user do not have the ACL right to delete from currently selected folder.
Result 541 - the user does not have enough rights to delete the folder.
Description: Delete currently selected folder and all its content and subfolders. If the operation is successful then after it no folder is selected.
Note: It cannot be undone.
Examples:
C: DELF
S: 200 OK Folder '/delete/me' was deleted
Figure 92
C: DELF
S: 510 UNKNOWN command
Figure 93
C: DELF
S: 511 Please select first a folder
C: DELF
S: 511 /INBOX cannot be deleted
Figure 94
Name: remove currently selected folder from the list of public folders
Arguments: none
Result: 200 220 410 510
Result 200 - the command was successful and currently selected folder was removed from the list of public folders.
Result 220 - the command was successful, but currently selected folder was not in the list of public folders.
Result 410 - for the moment the selected folder cannot be removed from the list of public folders.
Result 510 - unknown/unsupported command.
Description: Remove currently selected folder from the list of public folders (if it is already there).
Examples:
C: DPBL
S: 200 OK Folder /MyCalendar is no longer public
Figure 95
C: DPBL
S: 220 OK Folder /MyCalendar was not in the list
Figure 96
C: DPBL
S: 410 Please retry to remove it later
Figure 97
C: DPBL
S: 510 UNKNOWN command
Figure 98
Name: exit
Arguments: none
Result: 200
Description: Return the server to the Not-authenticated State.
Example:
C: EXIT
S: 200 OK EXIT completed
Figure 99
Name: find items and returns how many items matched the filter
Argument: filter*
Result: 110 200 220 511
Result 110 - the client can send the filter.
Result 200 - the find was successful.
Result 220 - no item matching the filter was found.
Result 511 - wrong filter.
Result 541 - the user does not have enough rights to read items.
Description: Search for items only from currently selected folder (no subfolders) that correspond to a filter and return the number of matched items. If the search is done for a filter folder then the server does not expect any filter and apply the current filter (if any). If there is no filter in the filter folder then it is returned 0 and the 220 code. If there is no match for the filter then it is returned 0 and the 220 code.
Note: For not FILT folders, the filter is delivered after the acceptance of the command. An empty filter matches all items from that folder.
Examples:
C: SLCT /MESG-Folder
C: FCNT
S: 110 OK SEND filter definition (end it with an empty line)
C: UID UIDx0001:UIDx9000 TAG SPAM
C:
S: .3
S: 200 OK FCNT completed (3 matches)
C: SLCT /FILT-Folder
C: FCNT
S: .3
S: 200 OK FCNT completed (3 matches)
Figure 100
C: FCNT
S: 110 OK SEND filter definition (end it with an empty line)
C: UID UIDx0001:UIDx9000 TAG SPAM
C:
S: .0
S: 220 OK FCNT completed (no matches)
Figure 101
C: FCNT
S: 110 OK SEND filter definition (end it with an empty line)
C: LATER
C:
S: 511 INVALID filter definition
Figure 102
Name: find and copy items
Arguments: path_destination_folder filter*
Result: 110 200 210 220 510 511 541
Result 110 - the client can send the filter.
Result 200 - the find and copy was successful for all found UIDs.
Result 210 - the find and copy was successful but not for all found UIDs.
Result 220 - no item matching the filter was found.
Result 510 - unknown/unsupported command.
Result 511 - invalid destination folder or wrong filter.
Result 541 - the user does not have enough rights to read items from source or write in destination folder.
Description: Search for items only in currently selected folder (no subfolders) that correspond to a filter and copy them to a new folder. The tags are also copied. If there is no match for the filter then it is returned a 200 code.
Note: The filter is delivered after the acceptance of the command (response code 110).
Examples:
C: FCPY /ARCHIVE/SPAM
S: 110 OK SEND filter definition (end it with an empty line)
C: UID 00000001:00001000 AND TAG SPAM
C:
S: 200 OK FCPY completed (10 matches)
Figure 103
C: FCPY /ARCHIVE/SPAM
S: 110 OK SEND filter definition (end it with an empty line)
C: UID 00000001:00001000 AND TAG SPAM
C:
S: 210 OK FCPY completed (8 from 10 were copied - out of space)
Figure 104
C: FCPY /ARCHIVE/SPAM
S: 110 OK SEND filter definition (end it with an empty line)
C: UID UIDx0001:UIDx9000 TAG SPAM
C:
S: 220 OK FCPY completed (no matches)
Figure 105
C: FCPY
S: 510 UNKNOWN command
Figure 106
C: FCPY MISSING
S: 511 INVALID folder or path not absolute
C: FCPY SEND
S: 110 OK SEND filter definition (end it with an empty line)
C: LATER
C:
S: 511 INVALID filter definition
Figure 107
Name: find and delete items
Argument: path? filter*
Result: 110 200 210 220 511
Result 110 - the client can send the filter.
Result 200 - the find and delete was successful for all found UIDs.
Result 210 - the find and delete was successful but not for all found UIDs.
Result 220 - no item matching the filter was found or the path was not found in any found item.
Result 511 - wrong filter (inclusive empty filter) or no ACL right to delete.
Result 541 - the user does not have enough rights to delete items.
Description: Search for items only in currently selected folder (no subfolders) that correspond to a filter and delete them (no copy in TRASH) or a value based on path in founded uids. If there is no match for the filter then it is returned a 200 code.
Note: The filter is delivered after the acceptance of the command (response code 110). No filter remove all items.
Examples:
C: FDEL
S: 110 OK SEND filter definition (end it with an empty line)
C: UID 00000001:00001000 AND TAG SPAM
C:
S: 200 OK FDEL completed (10 matches)
C: FDEL /MESSAGE/ATTACHMENT-1
S: 110 OK SEND filter definition (end it with an empty line)
C: UID 00000001:00001000 AND TAG SPAM
C:
S: 200 OK FDEL completed (all 10 attachments deleted)
Figure 108
C: FDEL
S: 110 OK SEND filter definition (end it with an empty line)
C: UID 00000001:00001000 AND TAG SPAM
C:
S: 210 OK FDEL completed (only 8 from 10 matches were deleted)
C: FDEL /MESSAGE/ATTACHMENT-1
S: 110 OK SEND filter definition (end it with an empty line)
C: UID 00000001:00001000 AND TAG SPAM
C:
S: 210 OK FDEL completed (only 8 from 10 attachments were deleted)
Figure 109
C: FDEL
S: 110 OK SEND filter definition (end it with an empty line)
C: UID UIDx0001:UIDx9000 TAG SPAM
C:
S: 220 OK FDEL completed (no matches)
C: FDEL /MESSAGE/ATTACHMENT-1
S: 110 OK SEND filter definition (end it with an empty line)
C: UID UIDx0001:UIDx9000 TAG SPAM
C:
S: 220 OK FDEL completed (no attachments found in 10 items)
Figure 110
C: FDEL
S: 110 OK SEND filter definition (end it with an empty line)
C: LATER
C:
S: 511 INVALID filter definition
Figure 111
Name: find items
Argument: filter*
Result: 110 200 220 511
Result 110 - the client can send the filter.
Result 200 - the find was successful.
Result 220 - no item matching the filter was found.
Result 511 - wrong filter.
Result 541 - the user does not have enough rights to read items.
Description: Search for items only from currently selected folder (no subfolders) that correspond to a filter and return their UIDs. If the search is done for a filter folder then the server does not expect any filter and apply the current filter (if any). If there is no filter in the filter folder then it is returned only the return code. The answer consists of the UIDs and, for a filter folder, they are followed by a 0x20 character and the absolute path for which are the corresponding UID. If there is no match for the filter then it is returned a 220 code.
Note: For not FILT folders, the filter is delivered after the acceptance of the command. An empty filter matches all items from that folder.
Examples:
C: SLCT /MESG-Folder
C: FIND
S: 110 OK SEND filter definition (end it with an empty line)
C: UID UIDx0001:UIDx9000 TAG SPAM
C:
S: .UIDx1234
S: .UIDx1235
S: .UIDx2340
S: 200 OK FIND completed (3 matches)
C: SLCT /FILT-Folder
C: FIND
S: .UIDx1234 /INBOX
S: .UIDx1234 /Trash
S: .UIDx1235 /Trash
S: 200 OK FIND completed (3 matches)
Figure 112
C: FIND
S: 110 OK SEND filter definition (end it with an empty line)
C: UID UIDx0001:UIDx9000 TAG SPAM
C:
S: 220 OK FIND completed (no matches)
Figure 113
C: FIND
S: 110 OK SEND filter definition (end it with an empty line)
C: LATER
C:
S: 511 INVALID filter definition
Figure 114
Name: find and move
Arguments: path_destination_folder filter*
Result: 110 200 210 220 510 511 541
Result 110 - the client can send the filter.
Result 200 - the find and move was successful for all found UIDs.
Result 210 - the find and move was successful but not for all found UIDs.
Result 220 - no item matching the filter was found.
Result 510 - unknown/unsupported command.
Result 511 - invalid destination folder, wrong filter, or no right to move.
Result 541 - the user does not have enough rights to read items from source or write in destination folder.
Description: Search for items only from currently selected folder (no subfolders) that correspond to a filter and move them to a new folder. The tags are also moved. If there is no match for the filter then it is returned a 200 code.
Note: The filter is delivered after the acceptance of the command (response code 110).
Examples:
C: FMOV /ARCHIVE/SPAM
S: 110 OK SEND filter definition (end it with an empty line)
C: UID 00000001:00001000 AND TAG SPAM
C:
S: 200 OK FMOV completed (10 matches)
Figure 115
C: FMOV /ARCHIVE/SPAM
S: 110 OK SEND filter definition (end it with an empty line)
C: UID 00000001:00001000 AND TAG SPAM
C:
S: 210 OK FMOV completed (8 from 10 moved - out of space)
Figure 116
C: FMOV /ARCHIVE/SPAM
S: 110 OK SEND filter definition (end it with an empty line)
C: UID UIDx0001:UIDx9000 TAG SPAM
C:
S: 220 OK FMOV completed (no matches)
Figure 117
C: FMOV
S: 510 UNKNOWN command
Figure 118
C: FMOV MISSING
S: 511 INVALID folder or not absolute path
C: FMOV /SEND
S: 110 OK SEND filter definition (end it with an empty line)
C: LATER
C:
S: 511 INVALID filter definition
Figure 119
Name: find items and retrieve fields
Argument: filter* part*
Result: 110 200 220 511
Result 110 - the client can send the filter and the items parts.
Result 200 - the find was successful.
Result 220 - no item matching the filter was found.
Result 511 - wrong filter or items parts.
Result 541 - the user does not have enough rights to read items.
Description: Search for items only from currently selected folder (no subfolders) that correspond to a filter and return their UIDs together with the requested parts from them. If the search is done for a filter folder then the server does not expect any filter and apply the current filter (if any). If there is no filter in the filter folder then it is returned only the return code. If there are no parts specified then only the UIDs are returned. Each requested part becomes a number starting with 1 and being assigned in the same order as the fields. It is defined a special part named TAGS which returns all tags associated to a UID. Each tag is returned on its own line prefixed with the starting number.
Note: The number 0 is reserved for the UID. The answer consists of the UIDs and, for a filter folder, they are followed by a 0x20 character and the absolute path for which are the corresponding UID. If the item is marked as new then the UID is prefixed with a multiplication sign (*). The item is then marked as no longer being new. If there is no match for the filter then it is returned a 220 code.
Note: For not FILT folders, the filter is delivered after the acceptance of the command. An empty filter matches all items from that folder.
Examples: The first message has only a value in To, the second has two, and the last one none. The second message has no subject.
C: SLCT /MESG-Folder
C: FRTR
S: 110 OK SEND filter&parts definition (end each with an empty line)
C: UID UIDx0001:UIDx9000 TAG SPAM
C:
C: /MESSAGE/HEADER/subject
C: /MESSAGE/HEADER/from
C: /MESSAGE/HEADER/to
C: TAGS
C:
S: .0 UIDx1234
S: .1 Not so important
S: .2 contact@win.com
S: .3 you@example.com
S: .0 *UIDx1235
S: .2 spam@ultimate-spam.com
S: .3 you@example.com
S: .3 your_boss@example.com
S: .0 UIDx2340
S: .1 Please respond
S: .2 office@example.com
S: .4 SEEN
S: .4 EXPIRED=NO
S: 200 OK FRTR completed (3 matches)
C: FRTR
S: 110 OK SEND filter&parts definition (end each with an empty line)
C: UID UIDx0001:UIDx9000 TAG SPAM
C:
C:
S: .0 UIDx1234
S: .0 UIDx1235
S: .0 UIDx2340
S: 200 OK FRTR completed (3 matches)
C: SLCT /FILT-Folder
C: FRTR
S: 110 OK SEND the parts definition (end it with an empty line)
C: /MESSAGE/HEADER/subject
C: /MESSAGE/HEADER/from
C:
S: .0 UIDx1234 /INBOX
S: .1 Please respond
S: .2 office@example.com
S: .0 UIDx1234 /Trash
S: .1 Very urgent
S: .2 spam@ultimate-spam.com
S: .0 *UIDx1235 /Trash
S: .1 Not so important
S: .2 contact@win.com
S: 200 OK FRTR completed (3 matches)
Figure 120
C: FRTR
S: 110 OK SEND filter&parts definition (end each with an empty line)
C: UID UIDx0001:UIDx9000 TAG SPAM
C:
C: /MESSAGE/HEADER
C:
S: 220 OK FRTR completed (no matches)
Figure 121
C: FRTR
S: 110 OK SEND filter&parts definition (end each with an empty line)
C: LATER
C:
S: 511 INVALID filter definition
C: FRTR
S: 110 OK SEND filter&parts definition (end each with an empty line)
C: UID UIDx0001:UIDx9000
C:
C: INVALID/PATH
C:
S: 511 INVALID part definition
Figure 122
Name: find and write an item into a folder with a specified type from a certain user
Arguments: FolderType Account
Result: 110 200 410 510 511 541
Result 110 - the requested folder was found and the client can send the item.
Result 200 - the item was successfully stored or there was no content sent by the client.
Result 410 - if the item cannot be stored.
Result 510 - unknown/unsupported command.
Result 511 - invalid folder type, unknown account, the data is not a valid XML or its schema does not correspond to the type of the destination folder.
Result 541 - the user does not have enough rights to write items.
Description: Locate a folder with a specified type in an user account for receiving items from other users and store there the item sent by the client. It behaves like STOR.
Note: Do not send a message content using CDATA as it can hold empty lines and an empty line means for the server the end of the message to be stored.
Examples:
C: FSTO MESG kontakt@agap.at
S: 110 Send the message ended with an empty line
C: <MESSAGE><HEADER>...</HEADER><TEXT>...</TEXT></MESSAGE>
C:
S: 200 OK Message stored with UID UIDx1234 into INBOX
Figure 123
C: FSTO
S: 510 UNKNOWN command
C: FSTO MESG
S: 510 UNKNOWN command
Figure 124
C: FSTO -1 kontakt@agap.at
S: 511 INVALID folder type
C: FSTO MESG nouser@agap.at
S: 511 UNKNOWN account name
Figure 125
C: FSTO MESG kontakt@agap.at
S: 541 Not enough rights. Please contact your administrator.
Figure 126
Name: find and tag items
Arguments: tag_list filter*
Result: 110 200 210 220 510 511
Result 110 - the client can send the filter.
Result 200 - the find and set of tag(s) was successful for all found UIDs.
Result 210 - the find and set of tag(s) was successful but not for all found UIDs.
Result 220 - no item matching the filter was found.
Result 510 - unknown/unsupported command.
Result 511 - invalid tag list, wrong filter, or no right to tag.
Result 541 - the user does not have enough rights to tag items.
Description: Search for items only from currently selected folder (no subfolders) that correspond to a filter and change their tags. If there is no match for the filter then it is returned a 200 code.
Note: The filter is delivered after the acceptance of the command (response code 110).
Examples:
C: FTAG + SEEN
S: 110 OK SEND filter definition (end it with an empty line)
C: UID 00000001:00001000 AND NEW
C:
S: 200 OK FTAG completed (10 matches)
Figure 127
C: FTAG + SEEN
S: 110 OK SEND filter definition (end it with an empty line)
C: UID 00000001:00001000 AND NEW
C:
S: 210 OK FTAG completed (only 8 from 10 matches taged)
Figure 128
C: FTAG + SEEN
S: 110 OK SEND filter definition (end it with an empty line)
C: UID UIDx0001:UIDx9000 TAG SPAM
C:
S: 220 OK FIND completed (no matches)
Figure 129
C: FTAG
S: 510 UNKNOWN command
Figure 130
C: FTAG SEEN
S: 511 INVALID tag list
C: FTAG + SEEN
S: 110 OK SEND filter definition (end it with an empty line)
C: LATER
C:
S: 511 INVALID filter definition
Figure 131
Name: get all ACLs for selected folder
Arguments: none
Result: 200
Result 200 - the command was successful.
Description: It returns a list with all defined ACLs for currently selected folder. If the user do not have the ACL right C then it receives only the entries matching his account.
Examples:
C: GACL
S: 200 OK No ACL were defined
C: GACL
S: .CR anonymous
S: .RAD *@mydomain.com
S: .A partner@extdomain.com
S: 200 OK The ACL list for anonymous
C: GACL
S: .A partner@extdomain.com
S: 200 OK The ACL list for partner
Figure 132
Name: get tags of currently selected folder
Arguments: none
Result: 200 510 511
Result 200 - the tags for UID were successful displayed.
Result 510 - unknown/unsupported command.
Description: Return the tags associated to currently selected folder.
Examples:
C: GFTG
S: .SYNC
S: .HIDDEN=NO
S: 200 OK GFTG completed
Figure 133
C: GFTG
S: 510 UNKNOWN command
Figure 134
Name: get the list of public folders
Arguments: none
Results: 200 510
Result 200 - the list was successful delivered (even if it is empty).
Result 510 - unknown command.
Description: Return the list of all folders declared PUBLIC together with their type.
Note: There should be only one folder for each type.
Examples:
C: GPBL
S: .MESG /INBOX
S: .CALE /CALENDAR
S: .ADBK /Public/CONTACT
S: .FILE /Project X/Public Files
S: .JRNL /JOURNAL
S: .TASK /Project X/Tasks
S: 200 OK GPBL completed
Figure 135
C: GPBL
S: 510 UNKNOWN command
Figure 136
Name: get tag of an item
Arguments: UID
Result: 200 510 511
Result 200 - the tags for UID were successful displayed.
Result 510 - unknown/unsupported command.
Result 511 - invalid UID.
Description: Return the tags associated to an item.
Examples:
C: GTAG UIDx1000
S: .SEEN
S: .SPAM
S: 200 OK GTAG completed
C: GTAG UIDx1001
S: 200 OK GTAG completed
Figure 137
C: GTAG
S: 510 UNKNOWN command
Figure 138
C: GTAG -1
S: 511 INVALID UID
Figure 139
Name: list folders
Arguments: path/filter?
Results: 200 220 511
Result 200 - the list was successful delivered.
Result 220 - the list it is empty.
Result 511 - filter is invalid, the specified path (that has no wildcard) does not exist, or the specified path before last folder name (which has an wildcard) does not exist.
Result 541 - the user does not have enough rights to list the folders. (it is returned only for version without arguments)
Description: List all folders that correspond to the filter (if it is provided), otherwise all direct children of currently selected folder together with their types. All returned folder names are prefixed with the type of the corresponding folder (as it is used by the MAKE command) followed by a white space and the absolute path to the folder.
Filter's path': It is a relative (does not begins with /) or an absolute (begins with /) path. The slash sign (/) is used to delimit folders in the hierarchy. There can be only a star (*) and must to be located in the name of the last folder. Or two stars which must be the last characters of the filter and means that each folder matching the filter is listed together with all its direct and indirect subfolders. The server can return 511 if it founds '.' or '..' as folder names or '\' in the filter definition.
Examples:
C: LIST
S: .MESG YESTERDAY
S: .MESG YEAR-2000
S: 200 OK LIST completed (2 matches)
C: LIST /*
S: .FOLD /
S: .MESG /INBOX
S: .MESG /TRASH
S: .CALE /CALENDAR
S: 200 OK LIST completed (4 matches)
C: LIST YEAR-2010/J*
S: .MESG /WORK/YEAR-2010/JUN
S: .MESG /WORK/YEAR-2010/JUL
S: 200 OK LIST completed (2 matches)
Figure 140
C: LIST /archive*
S: 220 OK LIST completed (0 matches)
Figure 141
C: LIST */*
S: 511 ERROR path filter can contain only one * in last folder name
C: LIST /ARCHIVE/2000
S: 511 ERROR The specified folder does not exist
C: LIST /ARCHIVE/2000/Documents *.doc
S: 511 ERROR The folder '/ARCHIVE/2000' does not exist
Figure 142
Name: list folders
Arguments: path/filter?
Results: 200 220 511
Result 200 - the list was successful delivered.
Result 220 - the list it is empty.
Result 511 - filter is invalid, the specified path (that has no wildcard) does not exist, or the specified path before last folder name (which has an wildcard) does not exist.
Result 541 - the user does not have enough rights to list the subfolders. (it is only for the version without arguments)
Description: List all folders that correspond to the filter (if it is provided), otherwise all direct children of currently selected folder together with their types. All returned folder names are prefixed with the type of the corresponding folder (as it is used by the MAKE command) followed by a flag indicating some information about that folder, its FCID [FCID] and ECID [ECID], the number of new and total items, and the absolute path to that folder. Between each arguments are exactly only one white space.
Note: If a folder does not have a ECID, it must to return always the same value, which must be in a valid UID format.
Filter's path': It is a relative (does not begins with /) or an absolute (begins with /) path. The slash sign (/) is used to delimit folders in the hierarchy. There can be only a star (*) and must to be located in the name of the last folder. Or two stars which must be the last characters of the filter and means that each folder matching the filter is listed together with all its direct and indirect subfolders. The server can return 511 if it founds '.' or '..' as folder names or '\' in the filter definition.
The flag is a single char and can be only a digit (0-9) or a latin letter in lower (a-z) or upper case (A-Z) case-sensitive. This document defines the following flags:
Examples:
C: LSTX
S: .MESG 1 FCIDx012 ECIDx001 2 7 YESTERDAY
S: .MESG 3 FCIDx123 ECIDx001 0 2 YEAR-2000
S: 200 OK LSTX completed (2 matches)
C: LSTX /*
S: .FOLD 2 FCIDx041 ECIDx000 0 0 /
S: .MESG 2 FCIDx321 ECIDx001 0 0 /INBOX
S: .MESG 0 FCIDx001 ECIDx001 0 0 /TRASH
S: .CALE 0 FCIDx222 ECIDx001 0 3 /CALENDAR
S: 200 OK LSTX completed (4 matches)
C: LSTX YEAR-2010/J*
S: .MESG 1 FCIDx009 ECIDx001 0 0 /WORK/YEAR-2010/JUN
S: .MESG 2 FCIDx309 ECIDx001 0 0 /WORK/YEAR-2010/JUL
S: 200 OK LSTX completed (2 matches)
Figure 143
C: LSTX /archive*
S: 220 OK LSTX completed (0 matches)
Figure 144
C: LSTX */*
S: 511 ERROR path filter can contain only one * in last folder name
C: LSTX /ARCHIVE/2000
S: 511 ERROR The specified folder does not exist
C: LSTX /ARCHIVE/2000/Documents *.doc
S: 511 ERROR The folder '/ARCHIVE/2000' does not exist
Figure 145
Name: make folder
Arguments: type path
Result: 200 510 511
Result 200 - the folder was successfully created.
Result 510 - unknown/unsupported command.
Result 511 - invalid path, unknown/unsupported type or the parent.
Result 541 - the user does not have enough rights to create subfolders in path.
Description: Create a folder of a certain type.
Types: They are case insensitive
Note: If it requires parents that does not exist then the server will not create them for the client but it will return a 511 response code.
Examples:
C: MAKE MESG /ARCHIVE/2010
S: 200 OK Folder created
Figure 146
C: MAKE
S: 510 UNKNOWN command
Figure 147
C: MAKE 1234
S: 511 ERROR Missing folder name
C: MAKE new 1234
S: 511 ERROR Unknown folder type
C: MAKE MESG /INBOX/1234
S: 511 ERROR The parent folder does not accept subfolders.
Figure 148
Name: move item
Arguments: UID_source path_destination_folder
Result: 200 510 511
Result 200 - the move was successful.
Result 510 - unknown/unsupported command.
Result 511 - unknown uid, invalid destination folder or no ACL right to move items.
Result 541 - the user does not have enough rights to read or delete items from source or write in destination folder.
Description: Move an item into another folder (by UID).
Note: For moving a folder the client must use MOVF or MVFC.
Examples:
C: MOVE UIDx1234 ARCHIVE_FOLDER/TODAY
S: 200 OK MOVE completed
Figure 149
C: MOVE
S: 510 UNKNOWN command
Figure 150
C: MOVE UIDx1234 ARCHIVE_FOLDER/TODAY
S: 511 INVALID UID
C: MOVE MSGx1234 ARCHIVE_FOLDER/1970
S: 511 INVALID Destination
Figure 151
Name: move folder and its content and subfolders
Argument: path_destination_folder/new_folder_name
Result: 200 510 511 541
Result 200 - the move was successful.
Result 510 - unknown/unsupported command.
Result 511 - invalid destination folder, destination is not an absolute path or destination exists.
Result 541 - the user does not have enough rights to read or delete items from source or write in destination folder.
Description: Move folder together with its content and subfolders into another new folder.
Examples:
C: SLCT /INBOX
S: 200 Selected /INBOX
C: MOVF /ARCHIVE_FOLDER/TODAY
S: 200 OK MOVF completed (100 items, 5 subfolders)
Figure 152
C: MOVF
S: 510 UNKNOWN command
Figure 153
C: MOVF NotAnAbsolutePath
S: 511 INVALID destination
C: MOVF /IAlreadyExist
S: 511 Destination folder exists
Figure 154
Name: move folder content
Argument: path_destination_folder
Result: 200 510 511 541
Result 200 - the move was successful.
Result 510 - unknown/unsupported command.
Result 511 - invalid destination folder, destination is not an absolute path or destination does not exists.
Result 541 - the user does not have enough rights to read or delete items from source or write in destination folder.
Description: Move only the non-folder content of a folder into another folder.
Examples:
C: SLCT /INBOX
S: 200 Selected /INBOX
C: MVFC /ARCHIVE_FOLDER/TODAY
S: 200 OK MVFC completed (100 items)
Figure 155
C: MVFC
S: 510 UNKNOWN command
Figure 156
C: MVFC NotAnAbsolutePath
S: 511 INVALID destination
C: MVFC /IDoNotExist
S: 511 Destination folder not found
Figure 157
Name: rename folder
Arguments: new_name
Results: 200 510 511
Result 200 - the rename was successful.
Result 510 - unknown/unsupported command.
Result 511 - invalid new_name or trying to rename a folder name without having the ACL right to rename the folder.
Result 541 - the user does not have enough rights to rename it.
Description: Rename a folder. The currently selected folder remains selected even if the name was changed.
Note: The new_name does not hold any path hierarchy.
Examples:
C: SLCT /ARCHIVE/2001
S: 200 OK
C: NAME OLD-2001
S: 200 OK NAME completed
Figure 158
C: NAME
S: 510 UNKNOWN command
Figure 159
C: SLCT /INBOX
S: 200 OK
C: NAME InBox
S: 511 ERROR The folder cannot be renamed (reserved name)
C: NAME /A/new-folder
S: 511 ERROR The argument must not be a path
Figure 160
Name: noop
Arguments: none
Result: 200
Description: It does nothing (eventually announce what changes was done in current folder).
Example:
C: NOOP
S: 200 OK NOOP completed
Figure 161
Name: fetch presence information
Arguments: USER user|BUSY user|FREE user|UID uid user
Result: 110 200 510 511
Result 110 - the client can send the list of timestamps and locations.
Result 200 - the presence information for the user were found and returned or the uid was found and returned.
Result 510 - unknown/unsupported command or not found uid.
Result 511 - unknown/unsupported/missing arguments.
Description: Fetch information about an user current availability, checks when an user is busy or free and returns the event items.
Note: If there is present an argument USER then the user wants to obtain information about the status of an other user or himself. If the server does not know how to obtain the information about this user then it returns an UNKNOWN as argument. Otherways can return a list with all set texts. After an HERE and AWAY is present when was this set, for an IDLE is the timestamp corresponding to the starting point of idle period. In answer can be present only one of these three. For a PSET FOR is returned an HERE for a PGET USER.
Note: If there is present an argument BUSY or FREE then it is expected a list with timestamp periods and locations for which to be returned the list of busy, respectively free time frames. The end of list is marked by sending an empty line to server. Each list line has three fields: a start and inclusive end timestamp and a location. Between each argument is exactly only one space character (0x20). A timestamp has the format: YYYY-MM-DD hh:mm:ss and represents the time in UTC. The meaning of the timestamp fields could be found in Date and Time on the Internet: Timestamps [RFC3339]. A location is a string or the star character (*) for matching any location. The command returns a list with all available busy or free time frames for specified period and location. If there cannot be found any busy or free time frame then no list is returned, but only a 200 return code. The location name is compared which what was stored by the user, so there someone can write Vienna and someone else Wien, so the two of them cannot be found with a list having only one line and specifing a location. The answer is made of pairs of start and inclusive end timestamps followed by the UID correspondig to the event associated with this time period. In case there is no time period specified a 511 error is returned by server.
Note: If there is present an argument UID then it is returned its associated content only if it is of type VEVENT.
Examples:
C: PGET USER user@example.com
S: .IDLE 2011-05-27 18:00:00 +1000
S: .STATUS Today I am doing HomeOffice
S: .AT Headquarter, 1010 Vienna, Austria
S: 200 OK USER found
C: PGET USER user2@example.com
S: .HERE 2011-05-27 18:00:00 +1000
S: .STATUS Today I am in Austria
S: .AT Headquarter, 1010 Vienna, Austria
S: 200 OK USER found
C: PGET USER user3@example.com
S: .AWAY 2011-05-27 18:00:00 +1000
S: 200 OK USER found
C: PGET USER user@domain.com
S: .UNKNOWN
S: 200 OK USER not found
C: PGET USER user@domain.com
S: .UNKNOWN
S: 200 OK USER not found
C: PGET BUSY user@domain.com
S: 110 Send the time periods and location ended with an empty line
C: 2012-01-01 09:00:00 2012-01-03 17:30:00 Vienna/AT
C: 2012-01-01 09:00:00 2012-01-03 17:30:00 Wien
C:
S: .2012-01-01 10:00:00 2012-01-02 23:59:59 UIDx1234
S: .2012-01-03 14:00:00 2012-01-03 16:30:00 UIDx1289
S: 200 OK 2 BUSY time periods found
C: PGET FREE user@domain.com
S: 110 Send the time periods and location ended with an empty line
C: 2012-01-01 09:00:00 2012-01-03 17:30:00 Vienna/AT
C: 2012-01-01 09:00:00 2012-01-03 17:30:00 Wien
C:
S: .2012-01-01 09:00:00 2012-01-01 09:59:59 UIDx234
S: .2012-01-03 00:00:00 2012-01-03 13:59:59 UIDx345
S: .2012-01-03 16:30:01 2012-01-03 17:30:00 UIDx456
S: 200 OK 3 FREE time periods found
C: PGET UID UIDx1234 user@domain.com
S: .<VEVENT>
S: .<UID>20110531T114600Z-123456@agap.at</UID>
S: .<DTSTAMP>2011-05-31T12:10:00Z</DTSTAMP>
S: .<DTSTART>2011-06-07T18:00:00Z</DTSTART>
S: .<DTEND>2011-06-07T24:00:00Z</DTEND>
S: .<SUMMARY>AGAP RFC Party</SUMMARY>
S: .<DESCRIPTION>Celebration of a new revision!
S: .0.4</DESCRIPTION>
S: .</VEVENT>
Figure 162
C: PGET USER user@domain.com
S: 510 Presence is not supported
C: PGET UID uid user
S: 510 Uid not found
Figure 163
C: PGET
S: 511 Missing argument
C: PGET WRONG
S: 511 UNKNOWN argument WRONG
C: PGET USER
S: 511 Missing argument
C: PGET BUSY user
C:
S: 511 There must be defined at least one time period and location
C: PGET BUSY user
C: yyyy-01-01 09:00:00 2012-01-03 17:30:00 *
C:
S: 511 Invalid time period definition
C: PGET BUSY user
C: yyyy-01-01 09:00:00 2012-01-03 17:30:00
C:
S: 511 Missing location
C: PGET UID user
S: 511 Missing uid
Figure 164
Name: announce presence
Arguments: HERE|AWAY|FOR number unit_of_time|IDLE number unit_of_time|STATUS text|AT text
Result: 200 510 511
Result 200 - the presence of the user was updated or requested information returned.
Result 510 - unknown/unsupported command.
Result 511 - unknown/unsupported/missing arguments.
Description: Announce that the logged user is still online, eventually since when is idle. A QUIT command or disconnection means that the user is no longer online. In state PRESENCE only the "USER user" arguments are accepted.
If there is present an argument HERE then that means the user is no longer idle. As there is no information for how long this status is valid, then it will remain valid until comes a new command which change it.
If there is present an argument AWAY then that means the user is no longer connected. As there is no information for how long this status is valid, then it will remain valid until comes a new command which change it.
If there is present an argument FOR then that means the user is suppose to be considered present for the given amount of time. The client is expected to send its updated status in this period. If comes no command to change the state in the specified time, then after this period the presence will be reported as unknown. The arguments are as by IDLE.
If there is present an argument IDLE then that means the user is idle and the arguments must be: IDLE number unit_of_time. The number must be a positive number and the unit_of_time must be one of the following: sec, min, hour, day, year. As there is no information for how long this status is valid, then it will remain valid until comes a new command which change it.
If there is present an argument STATUS then the user want to change the text that is associated with its presence online. After STATUS can follow any text. The text ends to the end of line. If there is no text then any previous text is deleted and no text is displayed as status text.
If there is present an argument AT then that user want to change the text that is associated with its present location. After AT can follow any text. The text ends to the end of line. If there is no text then any previous text is deleted and no text is displayed as location text.
Examples:
C: PSET HERE
S: 200 OK You are online and not idle
C: PSET AWAY
S: 200 OK You are no more online
C: PSET FOR 5 min
S: 200 OK You are now online. Expecting an update in 5 minutes.
C: PSET IDLE 5 min
S: 200 OK You are idle since 5 minutes
C: PSET STATUS Today I am doing HomeOffice
S: 200 OK You changed your status text
C: PSET AT Headquarter, 1010 Vienna, Austria
S: 200 OK You changed your location text
Figure 165
C: PSET HERE
S: 510 Unknown command
Figure 166
C: PSET
S: 511 Missing argument
C: PSET WRONG
S: 511 UNKNOWN argument WRONG
C: PSET AT
S: 511 Missing argument
Figure 167
Name: set a listening point of a client for push announcements
Arguments: ip port sec filter?
Result: 200 410 510 511
Result 200 - the listening point was registered.
Result 410 - listening point is unreachable or ip is different from current connection.
Result 510 - unknown/unsupported command.
Result 511 - unknown/unsupported/missing arguments.
Description: Register an IP and port on client for announcing the client when there are new items received. If there was already a record for this listening point then the old information are replaced with the new one. The server will not send notification for AGAP folder of the following types: FILT, FOLD. When it is noticed a change in a monitored folder then the server will send a line to registered listening point holding the new FCID of that folder and the path of changed folder.
The ip and port are on client. The server can check if the client is accessible on this port and if the ip is the same which the one from which comes the current connection. If these checks fails then it returns an 410.
The sec indicate how long should the server send notification on this listening point. It must be a positive value, otherweis the server answers with 511.
The filter is a set of AGAP folder types delimited with a white space or comma. The server will gone send notifications only for changes in folders of this type. Even if there are no notification send for FILT or FOLD they are accepted in the filter. If the filter is missing then there are sent notification for all folder types except FILT and FOLD.
Examples:
C: PSHA 192.168.100.4 12345 900 MESG,CALE
S: 200 OK We notify you for 15 min
Figure 168
S: FCIDx1234 /INBOX/new messages folder
S: FCIDx2345 /SPAM
Figure 169
C: PSHA 192.168.100.4 12345 900
S: 410 The ip is not same as current connection
Figure 170
C: PSHA 192.168.100.4 12345 900
S: 510 Unknown command
Figure 171
C: PSHA 192.168.100.4 12345
S: 511 Missing timespan
C: PSHA 192.168.100.4 12345 0
S: 511 The notification timespan is invalid
C: PSHA 192.168.100.4
S: 511 Missing arguments
Figure 172
Name: set a listening point of a client for push announcements
Arguments: ip port
Result: 200 510 511
Result 200 - the listening point was unregistered.
Result 510 - unknown/unsupported command.
Result 511 - unknown/unsupported/missing arguments.
Description: Unregister an IP and port on client for announcing the client when there are new items received.
Examples:
C: PSHD 192.168.100.4 12345
S: 200 OK We removed it
Figure 173
C: PSHD 192.168.100.4 12345 900
S: 510 Unknown command
Figure 174
C: PSHD 192.168.100.4 0
S: 511 Invalid port
C: PSHD 192.168.100.4 12345 900
S: 511 Too many arguments
Figure 175
Name: retrieve
Argument: UID
Results: 200 510 511
Result 200 - the message was found.
Result 510 - unknown/unsupported command.
Result 511 - invalid UID or folder is not of type MESG or FILE.
Result 541 - the user does not have enough rights to read the item.
Description: Fetch from server information about the message, a file or a japp item with the given UID. Each line of answer is prefixed with a dot that it is not part of the returned object. RETC returns for an attachment its name and size in bytes instead of its content as RETR. RETC do not returns for a file or japp its content as RETR did.
Examples:
C: RETC UIDx1234
S: .<MESSAGE><HEADER>...</HEADER>
S: .<ATTACHMENT-1>
S: .<NAME>cid:A12</NAME>
S: .<SIZE>123456</SIZE>
S: .</ATTACHMENT-1>
S: .</MESSAGE>
S: 200 OK RETC completed
Figure 176
C: RETC UIDx1234
S: .<FILE>
S: .<NAME>file-test.txt</NAME>
S: .<SIZE>123456</SIZE>
S: .</MESSAGE>
S: 200 OK RETC completed
Figure 177
C: RETC
S: 510 UNKNOWN command
Figure 178
C: RETC WrongUID
S: 511 INVALID UID
C: RETC UIDx1234
S: 511 RETC is allowed only for MESG or FILE folders
Figure 179
Name: retrieve
Arguments for a FILT folder: none
Arguments for other types: UID part?
Results: 200 510 511
Result 200 - the item was found or filter content was delivered.
Result 510 - unknown/unsupported command.
Result 511 - invalid UID or part name.
Result 541 - the user does not have enough rights to read the item.
Description: Fetch from server the item with the given UID. For a filter folder, it must be called without an UID and it returns the content of the filter. Each line of answer is prefixed with a dot that it is not part of the returned object.
Part: It is a PATH as it is returned by RETR or RETC and must point to a not binary end leaf. It contains only tag names separated with /. Example: /MESSAGE/HEADER/subject, /MESSAGE/HEADER/received, /MESSAGE/HTML, /MESSAGE/ATTACHMENT-1/BODY. For an item in the header with a multivalue are returned each value on its own line.
Examples:
C: RETR UIDx1234
S: .<MESSAGE><HEADER>...</HEADER><TEXT>...</TEXT></MESSAGE>
S: 200 OK RETR completed
C: RETR UIDx1234 /MESSAGE/HEADER/subject
S: .Message's subject
S: 200 OK RETR completed
C: RETR UIDx1234 /MESSAGE/HEADER/received
S: .from s0001.srv.example.com [10.11.12.13] by mx.example.com
S: . (Postfix) with ESMTP id 01234567890 for <user@example.com>;
S: . Thu, 19 Nov 2009 01\:02\:03 +0100 (CET)
S: . by userpc (192.168.192.168) id 20091119010204A;
S: . Thu, 19 Nov 2009 01\:02\:04 +0100 (CET)
S: 200 OK RETR completed
C: RETR
S: .<FILTER>
S: .<FOLDERS><FOLDER>/Spam</FOLDER></FOLDERS>
S: .<RULES></RULES>
S: .</FILTER>
S: 200 OK RETR completed
Figure 180
C: RETR
S: 510 UNKNOWN command (only FILT folders do not needs arguments)
Figure 181
C: RETR WrongUID
S: 511 INVALID UID
C: RETR UIDx1234 ABC
S: 511 UNKNOWN part name
C: RETR UIDx1234
S: 511 RETR with UID is not allowed for a FILT folder
Figure 182
Name: replace an item
Arguments: UID (utf-8|base64 path)?
Result: 110 200 410 511
Result 110 - the client can send the item.
Result 200 - the item was successfully stored, the old uid (if present) was removed or there was no content sent by the client.
Result 210 - the new item was stored but the old one was not deleted.
Result 410 - if the item cannot be stored.
Result 511 - if the data is not a valid XML or its schema does not correspond to the type of the destination folder.
Result 541 - the user does not have enough rights to write or delete items.
Description: Store a new item/filter into a folder and remove the item with provided UID if it is present. If it is written a new filter into a FILT folder, then the previous filter is deleted. If the new filter has an invalid XML structure or cannot be saved then the folder remains with the old filter (if any). The server can send a 410 or 511 respons before the empty line is send, so the client must check after each sended line of content if the server had rejected the content. If the old item cannot be removed the new item remais saved and a 210 return code instead of a 200 return code is produced.
If there is present a path then the value of the corresponding path is changed. The utf-8 or base64 announce how is the new content delivered from client and an empty line marks the end of the new content. If this type of replace is supported than the server returns a 110 before waiting for the new content.
Note: Do not send a message content using CDATA as it can hold empty lines and an empty line means for the server the end of the message to be stored. It is the atomic equivalent of STOR followed by DELE UID.
Examples:
C: RPLC UIDx1212
S: 110 Send the message ended with an empty line
C: <MESSAGE><HEADER>...</HEADER><TEXT>...</TEXT></MESSAGE>
C:
S: 200 OK Message stored (UID is UIDx1234), UIDx1212 removed
C: RPLC UIDx1212
S: 110 Send the message ended with an empty line
C:
S: 200 OK Message not stored and UIDx1212 not removed
Figure 183
C: RPLC UIDx1212
S: 110 Send the message ended with an empty line
C: <MESSAGE><HEADER>...</HEADER><TEXT>...</TEXT></MESSAGE>
C:
S: 210 OK Message stored as UIDx1234, UIDx1212 not removed
Figure 184
C: RPLC UIDx1212
S: 110 Send the message ended with an empty line
C: <MESSAGE><HEADER>...</HEADER><HTML>...</HTML></MESSAGE>
C:
S: 410 Not enough space, UIDx1212 not removed
Figure 185
C: RPLC UIDx1212
S: 110 Send the message ended with an empty line
C: msg
C:
S: 511 Cannot store it, the message has an incorrect format
C: RPLC
S: 511 Missing UID
Figure 186
Name: set the tags of currently selected folder
Arguments: tag_list
Result: 200 210 410 510 511 541
Result 200 - all tags for current folder were successful set.
Result 210 - not all tags for current folder were successful set.
Result 410 - for the moment the flags cannot be saved.
Result 510 - unknown/unsupported command.
Result 511 - invalid tag list.
Result 541 - the tag FIX-TAGS does not allow to change the already set tags or the user does not have enough rights to tag the folder.
Description: Set or delete tags of currently selected folder. The FCID of the folder is increased to mark the change.
Note: Setting the tag FIX-TAGS makes the tags of currently selected folder unchangable after this command. The tags can only be changed on the server.
Note: A return code 210 is returned even when no flag could be set if the tag list is correct.
Examples:
C: SFTG + SYNC
S: 200 OK SFTG completed
Figure 187
C: SFTG - SYNC TEST
S: 210 OK SFTG did not removed TEST
C: SFTG - TEST
S: 210 OK SFTG did not removed TEST
Figure 188
C: SFTG + SYNC
S: 410 Please retry to set them later
Figure 189
C: SFTG
S: 510 UNKNOWN command
C: SFTG + SYNC
S: 510 Please select a folder first
Figure 190
C: SFTG SYNC
S: 511 INVALID tag list
Figure 191
C: SFTG + SYNC
S: 541 Tag FIX-TAGS prevents the change of tags
Figure 192
Name: select a folder
Argument: path
Result: 200 510 511
Result 200 - the folder was successfully selected.
Result 510 - unknown/unsupported command.
Result 511 - unknown path or '/'.
Description: Select a folder. If the selection was not successful then no folder remains selected and the server switch in the 'Not-selected State'.
Examples:
C: SLCT /INBOX
S: 200 OK Folder selected
C: SLCT ARCHIVE/2000
S: 200 OK Folder selected
Figure 193
C: SLCT
S: 510 UNKNOWN command
Figure 194
C: SLCT 1234
S: 511 INVALID folder
C: SLCT /
S: 511 You cannot select /
Figure 195
Name: change password
Argument: old-password new-password
Result: 110 200 511 541
Result 110 - the client can send the passwords.
Result 200 - the password was successfully changed.
Result 511 - the old password was wrong or the new password did not respect the rules imposed for new passwords.
Result 541 - the user cannot change the password.
Description: If the old-password corresponds with current password then the new-password will be replace the old one.
Note: Th return code 541 is returned and if the server cannot change the password because it can only read or validate it.
Examples:
C: SPWD
S: 110 OK SEND old and new passwords
C: old-password
C: new-password
S: 200 OK SPWD changed the password
Figure 196
C: SPWD
S: 110 OK SEND old and new passwords
C: old-password
C: new-password
S: 511 Old password don't match
Figure 197
C: SPWD
S: 541 Server cannot change password on your behalf
C: SPWD
S: 110 OK SEND old and new passwords
C: old-password
C: new-password
S: 541 Server cannot change password on your behalf
Figure 198
Name: set tags of items
Arguments: UID tag_list
Result: 200 410 510 511
Result 200 - the tags for UID were successful set.
Result 410 - for the moment the flags cannot be saved.
Result 510 - unknown/unsupported command.
Result 511 - invalid UID.
Result 541 - the user does not have enough rights to tag the item.
Description: Set or delete tags associated to an item.
Examples:
C: STAG UIDx1000 + SEEN SYNC DAY=2012
S: 200 OK STAG completed
Figure 199
C: STAG UIDx1000 + SEEN SYNC DAY=2012
S: 410 Please retry to set them later
Figure 200
C: STAG
S: 510 UNKNOWN command
Figure 201
C: STAG -1
S: 511 INVALID UID
C: STAG 0x1 + SEEN
S: 511 UID not found
C: STAG UIDx1234 SEEN
S: 511 INVALID tag list (missing operator)
Figure 202
Name: status
Arguments: none
Result: 200 512
Result 200 - the status of the folder was successfully delivered.
Result 512 - no folder is selected.
Description: Return the absolute path of currently selected folder (PATH), its type (TYPE), its FCID, its ECID (only for folders with can hold items), the tags (TAGS) and eventually additional information associated with this type of folder. A change in a folder means that its structure was changed or there was a change of its items (like new messages, an event was canceled and automatically removed from a calender).
Additional information:
Examples:
C: STAT
S: .PATH /INBOX
S: .TYPE MESG
S: .FCID 1
S: .TAGS RESERVED
S: .TOTAL 10
S: .NEW 2
S: 200 OK Folder status displayed
Figure 203
C: STAT
S: 512 ERROR First select a folder
Figure 204
Name: store
Arguments: none
Result: 110 200 410 511
Result 110 - the client can send the item.
Result 200 - the item was successfully stored or there was no content sent by the client.
Result 410 - if the item cannot be stored.
Result 511 - if the data is not a valid XML or its schema does not correspond to the type of the destination folder.
Result 541 - the user does not have enough rights to write items.
Description: Store a new item/filter into a folder. If it is written a new filter into a FILT folder, then the previous filter is deleted. If the new filter has an invalid XML structure or cannot be saved then the folder remains with the old filter (if any). The server can send a 410 or 511 respons before the empty line is send, so the client must check after each sended line of content if the server had rejected the content.
Note: Do not send a message content using CDATA as it can hold empty lines and an empty line means for the server the end of the message to be stored.
Examples:
C: STOR
S: 110 Send the message ended with an empty line
C: <MESSAGE><HEADER>...</HEADER><TEXT>...</TEXT></MESSAGE>
C:
S: 200 OK Message stored (UID is UIDx1234)
C: STOR
S: 110 Send the message ended with an empty line
C:
S: 200 OK Message not stored as it was empty
Figure 205
C: STOR
S: 110 Send the message ended with an empty line
C: <MESSAGE><HEADER>...</HEADER><HTML>...</HTML></MESSAGE>
C:
S: 410 Cannot store it, not enough space
Figure 206
C: STOR
S: 110 Send the message ended with an empty line
C: msg
C:
S: 511 Cannot store it, the message has an incorrect format
Figure 207
Name: last UID returned by STOR, COPY, MOVE or RPLC
Arguments: none
Results: 200 511
Result 200 - the command was accepted and eventually an UID was returned.
Result 511 - the command is not accepted in the actual state.
Description: This command returns the last UID generated by a STOR, COPY, MOVE or RPLC command in the currently selected folder since it was last time selected. Selecting an other folder or leaving the actual state makes to forget last generated UID. By selecting a folder, storing an item and then reselecting the same folder makes the UID to be forgot. If there is no UID stored then is returned a 200 without any line holding an UID. A failling STOR, COPY, MOVE or RPLC also makes no UID to be remembered.
Examples:
C: SLCT /Mbox
S: 200 Selected /Mbox
C: SUID
S: 200 OK There was no STOR since last SLCT
C: STOR
...
S: 200 OK STOR completed with UID UIDx1234
C: SUID
S: .UIDx1234
S: 200 OK SUID completed; found UIDx1234
C: SLCT /Mbox
S: 200 Selected /Mbox
C: SUID
S: 200 OK There was no STOR since last SLCT
C: STOR
...
S: 511 ERROR STOR ompleted with error
C: SUID
S: 200 OK There was no successfull STOR since last SLCT
Figure 208
C: SUID
S: 511 ERROR SUID is not accepted in this state
Figure 209
The Response-Code element is a 3-digit integer result code of the attempt to understand and satisfy the request. These codes are fully defined in the following section.
After the Response-Code, can follow a 0x20 character and then a Reason-Phrase intended to give a short textual description of the returned code. The Response-Code is intended for automatic use. The Reason-Phrase is intended for humane persons that debug the connection.
The first digit of the Response-Code defines the class of response. The last two digits do not have any categorization role. There are 4 values for the first digit:
There are commands that return a multi-line response. These are: CAPA, FIND, GTAG, LIST, RETR, and STAT. In this cases, the response code is at the beginning of the last line of the response. All other lines start with a dot (.).
Reserved.
The client SHOULD continue sending the rest of this request. This response informs the client that the server accepted the initial part of the request and it is waiting for the next part of the request. The server sends a final response after the request has been completely received and processed.
The request was successfully processed.
The request was successfully applied for at least one item but not for all requested items. (see FCPY, FDEL, FMOV, and FTAG)
The request was successful, but none of the arguments were found. (see DACL, DPBL)
Reserved.
The request could not be processed because it was an internal error (ex.: something is wrong configured).
The operation must to be retried later. This return code is used when the data cannot be stored because there was an error (ex.: not enough space on disk) or the operation faild now but can succeed later (ex.: the client listen on proposed IP and port).
Reserved.
The request could not be processed because this command is unknown or its syntax is wrong.
The request could not be processed because the command has an invalid parameter.
This answer can be returned even in the case when more than one 0x20 character were present between command and its arguments or between arguments.
This command has a valid syntax but must to be send after other command required by the logic of the server. (Ex.: PASS after USER in Pre-authenticated State.)
This command has a valid syntax but the searched argument does not exist or cannot be accessed.
The client is not allowed to interact with the server. (Ex.: the client's IP is blacklisted.)
The client is not allowed to do the command because of insufficient rights. If it had enough rights then the command would have been successful. (Ex.: the client cannot store a message with FSTO.)
The Welcome Message: 200 401 410 531
AUTH: 510 511
AUTH mechanism: 200 511
CAPA: 200
QUIT: 200
SGZP: 200 510
STLS: 200 510
other: 510
PASS: 510 511 512
PASS password: 200 511 512
QUIT: 200
USER: 510 511
USER account: 200 511
other: 510
HASH: 510 511 512
HASH hashcode: 200 511 512
QUIT: 200
USER: 510 511
USER account: 200 511
other: 510
AACL: 510
AACL arguments: 200 511 541
APBL: 200 410
CHNG: 200 510
CHNG arguments: 200 511
COPY: 510 511
COPY arguments: 200 511 541
CPFC: 510 511
CPFC arguments: 200 511 541
CPYF: 510 511
CPYF arguments: 200 511 541
DACL: 510
DACL arguments: 200 220 511 541
DPBL: 200 220 410
DELE: 510 511
DELE arguments: 200 511 541
DELF: 510 511
DELF arguments: 200 511 541
EXIT: 200
FCNT: 110
FCNT arguments: 200 220 511 541
FCPY: 110
FCPY arguments: 200 210 220 511 541
FDEL: 110
FDEL arguments: 200 210 220 511 541
FIND: 110
FIND arguments: 200 220 511 541
FMOV: 110
FMOV arguments: 200 210 511 541
FRTR: 110
FRTR arguments: 200 220 511 541
FTAG: 510
FTAG arguments: 110 200 210 220 511 541
GACL: 200
GFTG: 200
GPBL: 200
GTAG: 510
GTAG arguments: 200 511
LIST: 200 220
LIST arguments: 200 220 511 541
LSTX: 200 220
LSTX arguments: 200 220 511 541
MAKE: 510 511
MAKE arguments: 200 511 541
MOVE: 510 511
MOVE arguments: 200 511 541
MOVF: 510 511
MOVF arguments: 200 511 541
MVFC: 510 511
MVFC arguments: 200 511 541
NAME: 510 511
NAME arguments: 200 511 541
NOOP: 200
PGET: 510 511
PGET arguments: 110 200 510 511
PSET: 510 511
PSET arguments: 200 510 511
PSHA: 510 511
PSHA arguments: 200 410 510 511
PSHD: 510 511
PSHD arguments: 200 510 511
QUIT: 200
RETC: 510
RETC arguments: 200 511 541
RETR: 510 511
RETR arguments: 200 511 541
RPLC: 510 511
RPLC argument: 110 200 210 410 511 541
SLCT: 510 511
SLCT arguments: 200 511
SFTG: 510 511
SFTG arguments: 200 410 511 541
SPWD: 110 200 511 541
STAG: 510 511
STAG arguments: 200 410 511 541
STAT: 200 512
STOR: 110 200 410 511 541
SUID: 200 511
other: 510
CHNG: 200 510
CHNG arguments: 200 511
GPBL: 200
LIST: 200
LIST arguments: 200 511
PSET: 510 511
PSET arguments: 200 510 511
SLCT: 510 511
SLCT arguments: 200 511
SPWD: 110 200 511 541
other: 510
PGET: 510 511
PGET arguments: 200 510 511
QUIT: 200
other: 510
FSTO: 510
FSTO arguments: 110 200 410 510 511 541
QUIT: 200
other: 510
S: 200 Welcome
C: AUTH PLAIN
S: 200 OK Send USER
C: USER account
S: 200 OK Send PASS
C: PASS password
S: 200 OK Authenticated
C: STAT
S: .PATH /INBOX
S: .TYPE MESG
S: .TAGS RESERVED
S: .TOTAL 10
S: .NEW 2
S: 200 OK Folder status displayed
Figure 210
S: 200 Welcome
C: AUTH MD5
S: .Use this as prefix, please!
S: 200 OK Send USER
C: USER account
S: 200 OK Send HASH
C: HASH 79054025255fb1a26e4bc422aef54eb1
S: 200 OK Authenticated
C: STAT
S: .PATH /INBOX
S: .TYPE MESG
S: .TAGS RESERVED
S: .TOTAL 10
S: .NEW 2
S: 200 OK Folder status displayed
Figure 211
S: 200 Welcome
C: AUTH PLAIN
S: 200 OK Send USER
C: USER account
S: 200 OK Send PASS
C: PASS password
S: 511 WRONG user/password pair
Figure 212
S: 531 Your IP is blacklisted
Figure 213
S: 410 Too many connections, please retry later
Figure 214
S: 401 Internal error, the server has an error in its configuration
Figure 215
C: LIST /*
S: .MESG /INBOX
S: .MESG /TRASH
S: .CALE /CALENDAR
S: 200 OK LIST completed (3 matches)
Figure 216
C: SLCT /INBOX
S: 200 OK Folder selected
C: FIND
S: 110 OK SEND filter definition (end it with an empty line)
C:
S: .UIDx1230
S: .UIDx1231
S: .UIDx1234
S: .UIDx1235
S: .UIDx2340
S: 200 OK FIND completed (5 matches)
Figure 217
C: SLCT /INBOX
S: 200 OK Folder selected
C: FIND
S: 110 OK SEND filter definition (end it with an empty line)
C: NEW IS /HEADER/subject = 'Newsletter from Example.com'
C:
S: .UIDx1234
S: .UIDx1235
S: .UIDx2340
S: 200 OK FIND completed (3 matches)
C: RETR UIDx1234
S: .<MESSAGE><HEADER>
S: .<from>HCCP<news@example.com></from>
S: .<to>newsletter@localhost.localdomain</to>
S: .<subject>Newsletter from Example.com</subject>
S: .</HEADER>
S: .<TEXT>This is your weekly newsletter.</TEXT>
S: .</MESSAGE>
S: 200 OK RETR completed
Figure 218
C: SLCT /CONTACT
S: 200 OK Folder selected
C: FIND
S: 110 OK SEND filter definition (end it with an empty line)
C: OR REGEXP /VCARD/FN = 'RADU.*?'
C: REGEXP /VCARD/FN = '.*? Iulian'
C:
S: .CONx0001
S: 200 OK FIND completed (1 match)
C: RETR CONx0001
S: .<VCARD>
S: . <VERSION>3.0</VERSION>
S: . <FN>Iulian Radu</FN>
S: . <N>Radu;Iulian;;Dipl.Ing.;</N>
S: . <ORG>Example Com;European Division</ORG>
S: . <EMAIL TYPE="internet,home">iulian.radu@gmx.at</EMAIL>
S: . <TZ>+01:00</TZ>
S: . <REV>2011-05-31T18:46:00Z</REV>
S: .</VCARD>
S: 200 OK RETR completed
Figure 219
C: SLCT /CALENDAR
S: 200 OK Folder selected
C: FIND
S: 110 OK SEND filter definition (end it with an empty line)
C: IS /VEVENT/SUMMARY = '*RFC*'
C:
S: .EVNx0001
S: 200 OK FIND completed (1 match)
C: RETR EVNx0001
S: .<VEVENT>
S: . <UID>20110531T114600Z-123456@agap.at</UID>
S: . <DTSTAMP>2011-05-31T12:10:00Z</DTSTAMP>
S: . <DTSTART>2011-06-07T18:00:00Z</DTSTART>
S: . <DTEND>2011-06-07T24:00:00Z</DTEND>
S: . <SUMMARY>AGAP RFC Party</SUMMARY>
S: . <DESCRIPTION>Celebration of a new revision!
S: .0.4</DESCRIPTION>
S: . <ALARM>
S: . 20110607T170000Z-20110531T114600Z-123456@agap.at</ALARM>
S: .</VEVENT>
S: 200 OK RETR completed
Figure 220
C: SLCT /OUTBOX
S: 200 OK Folder selected
C: STOR
S: 110 Send the message ended with an empty line
C: <MESSAGE><HEADER>
C: <from>HCCP<news@example.com></from>
C: <to>newsletter@localhost.localdomain</to>
C: <subject>HCCP Newsletter</subject>
C: </HEADER>
C: <TEXT>This is your weekly newsletter.</TEXT>
C: </MESSAGE>
C:
S: 200 OK Message stored (UID is UIDx1234)
Figure 221
C: SLCT /CONTACT
S: 200 OK Folder selected
C: STOR
S: 110 Send the contact info ended with an empty line
C: <VCARD>
C: <VERSION>3.0</VERSION>
C: <FN>Iulian Radu</FN>
C: <N>Radu;Iulian;;Dipl.Ing.;</N>
C: <ORG>Example Com;European Division</ORG>
C: <EMAIl TYPE="internet,home">iulian.radu@gmx.at</EMAIL>
C: <TZ>+01:00</TZ>
C: <REV>2011-05-31T18:46:00Z</REV>
C: </VCARD>
C:
S: 200 OK Contact stored (UID is UIDx1234)
Figure 222
C: SLCT /CALENDAR
S: 200 OK Folder selected
C: STOR
S: 110 Send the contact info ended with an empty line
C: <VEVENT>
C: <UID>20110531T114600Z-123456@agap.at</UID>
C: <DTSTAMP>2011-05-31T12:10:00Z</DTSTAMP>
C: <DTSTART>2011-06-07T18:00:00Z</DTSTART>
C: <DTEND>2011-06-07T24:00:00Z</DTEND>
C: <SUMMARY>AGAP RFC Party</SUMMARY>
C: <DESCRIPTION>Celebration of a new revision!
C: 0.4</DESCRIPTION>
C: <ALARM>
C: 20110607T170000Z-20110531T114600Z-123456@agap.at</ALARM>
C: </VEVENT>
C:
S: 200 OK Event stored (UID is UIDx1234)
Figure 223
C: STAG UIDx1000 + SPAM
S: 200 OK STAG completed
C: MAKE MESG /Archive-SPAM
S: 200 OK Folder created
C: FMOV /Archive-SPAM
S: 110 OK SEND filter definition (end it with an empty line)
C: TAG SPAM
C:
S: 200 OK FMOV completed (19 matches)
Figure 224
C: MAKE FILT /New-messages
S: 200 OK Folder created
C: STOR
S: 110 Send the filter content ended with an empty line
C: <FILTER>
C: <FOLDERS><FOLDER>/INBOX</FOLDER></FOLDERS>
C: <RULES>
C: <AND><NOT><TAG>SEEN</TAG></NOT></AND>
C: </RULES>
C: </FILTER>
C:
S: 200 OK Filter stored
C: SLCT /New-messages
S: 200 OK Folder selected
C: FIND
S: .UIDx1234 /INBOX
S: .UIDx1234 /Trash
S: .UIDx1235 /Trash
S: 200 OK FIND completed (3 matches)
C: RETR
S: .<FILTER>
S: .<FOLDERS><FOLDER>/INBOX</FOLDER></FOLDERS>
S: .<RULES><NOT><TAG>SEEN</TAG></NOT></RULES>
S: .</FILTER>
S: 200 OK RETR completed
Figure 225
C: MAKE MESG /My/NewFolder
S: 200 OK Folder created
C: NOOP
S: 200 NOOP OK
C: SLCT /My/NewFolder
S: 200 OK Selected /My/NewFolder
C: NAME AFolder
S: 200 OK /My/NewFolder --> /My/AFolder
Figure 226
C: LIST /*
S: .MESG /INBOX
S: .MESG /TRASH
S: .CALE /CALENDAR
S: 200 OK LIST completed (3 matches)
C: SLCT /INBOX
S: 200 OK SELECT completed
C: STAT
S: .PATH /INBOX
S: .TYPE MESG
S: .TAGS RESERVED
S: .TOTAL 10
S: .NEW 5
S: 200 OK Folder status displayed
Figure 227
C: STAG UIDx1000 + SEEN
S: 200 OK STAG completed
C: GTAG UIDx1000
S: .SPAM
S: .FLAG=RED
S: .SEEN
S: 200 OK GTAG completed
Figure 228
C: FTAG + SPAM
S: 110 OK SEND filter definition (end it with an empty line)
C: REGEXP header/subject = '[Vv][i1]agra'
C:
S: 200 OK FTAG completed (10 matches)
C: FDEL
S: 110 OK SEND filter definition (end it with an empty line)
C: UID 00000001:00001000 AND TAG SPAM
C:
S: 200 OK FDEL completed (10 matches)
Figure 229
C: PSET FOR 15 min
S: 200 Nice to se you back
C: PSET AT At Home
S: 200 So you are there
C: PSET STATUS Today I am doing HomeOffice
S: 200 So kind to share your thoughts with us
C: PGET USER coworker
S: .AWAY 2011-05-27 18:00:00 +1000
S: 200 Sorry, your buddy is not here
C: PSET AWAY
S: 200 Oh, so soon
Figure 230
| [RFC2119] | Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997. |
| [RFC2629] | Rose, M., "Writing I-Ds and RFCs using XML", RFC 2629, June 1999. |
| [RFC3552] | Rescorla, E. and B. Korver, "Guidelines for Writing RFC Text on Security Considerations", BCP 72, RFC 3552, July 2003. |