]<> - The text of a particular body section. The section - specification is a set of zero or more part specifiers - delimited by periods. A part specifier is either a part number - or one of the following: HEADER, HEADER.FIELDS, - HEADER.FIELDS.NOT, MIME, and TEXT. An empty section - specification refers to the entire message, including the - header. - - Every message has at least one part number. Non-[MIME-IMB] - messages, and non-multipart [MIME-IMB] messages with no - encapsulated message, only have a part 1. - - Multipart messages are assigned consecutive part numbers, as - they occur in the message. If a particular part is of type - message or multipart, its parts MUST be indicated by a period - followed by the part number within that nested multipart part. - - A part of type MESSAGE/RFC822 also has nested part numbers, - referring to parts of the MESSAGE part's body. - - The HEADER, HEADER.FIELDS, HEADER.FIELDS.NOT, and TEXT part - specifiers can be the sole part specifier or can be prefixed by - one or more numeric part specifiers, provided that the numeric - part specifier refers to a part of type MESSAGE/RFC822. The - MIME part specifier MUST be prefixed by one or more numeric - part specifiers. - - The HEADER, HEADER.FIELDS, and HEADER.FIELDS.NOT part - specifiers refer to the [RFC-2822] header of the message or of - an encapsulated [MIME-IMT] MESSAGE/RFC822 message. - HEADER.FIELDS and HEADER.FIELDS.NOT are followed by a list of - field-name (as defined in [RFC-2822]) names, and return a - - - -Crispin Standards Track [Page 55] - -RFC 3501 IMAPv4 March 2003 - - - subset of the header. The subset returned by HEADER.FIELDS - contains only those header fields with a field-name that - matches one of the names in the list; similarly, the subset - returned by HEADER.FIELDS.NOT contains only the header fields - with a non-matching field-name. The field-matching is - case-insensitive but otherwise exact. Subsetting does not - exclude the [RFC-2822] delimiting blank line between the header - and the body; the blank line is included in all header fetches, - except in the case of a message which has no body and no blank - line. - - The MIME part specifier refers to the [MIME-IMB] header for - this part. - - The TEXT part specifier refers to the text body of the message, - omitting the [RFC-2822] header. - - Here is an example of a complex message with some of its - part specifiers: - - HEADER ([RFC-2822] header of the message) - TEXT ([RFC-2822] text body of the message) MULTIPART/MIXED - 1 TEXT/PLAIN - 2 APPLICATION/OCTET-STREAM - 3 MESSAGE/RFC822 - 3.HEADER ([RFC-2822] header of the message) - 3.TEXT ([RFC-2822] text body of the message) MULTIPART/MIXED - 3.1 TEXT/PLAIN - 3.2 APPLICATION/OCTET-STREAM - 4 MULTIPART/MIXED - 4.1 IMAGE/GIF - 4.1.MIME ([MIME-IMB] header for the IMAGE/GIF) - 4.2 MESSAGE/RFC822 - 4.2.HEADER ([RFC-2822] header of the message) - 4.2.TEXT ([RFC-2822] text body of the message) MULTIPART/MIXED - 4.2.1 TEXT/PLAIN - 4.2.2 MULTIPART/ALTERNATIVE - 4.2.2.1 TEXT/PLAIN - 4.2.2.2 TEXT/RICHTEXT - - - It is possible to fetch a substring of the designated text. - This is done by appending an open angle bracket ("<"), the - octet position of the first desired octet, a period, the - maximum number of octets desired, and a close angle bracket - (">") to the part specifier. If the starting octet is beyond - the end of the text, an empty string is returned. - - - - -Crispin Standards Track [Page 56] - -RFC 3501 IMAPv4 March 2003 - - - Any partial fetch that attempts to read beyond the end of the - text is truncated as appropriate. A partial fetch that starts - at octet 0 is returned as a partial fetch, even if this - truncation happened. - - Note: This means that BODY[]<0.2048> of a 1500-octet message - will return BODY[]<0> with a literal of size 1500, not - BODY[]. - - Note: A substring fetch of a HEADER.FIELDS or - HEADER.FIELDS.NOT part specifier is calculated after - subsetting the header. - - The \Seen flag is implicitly set; if this causes the flags to - change, they SHOULD be included as part of the FETCH responses. - - BODY.PEEK[

]<> - An alternate form of BODY[

] that does not implicitly - set the \Seen flag. - - BODYSTRUCTURE - The [MIME-IMB] body structure of the message. This is computed - by the server by parsing the [MIME-IMB] header fields in the - [RFC-2822] header and [MIME-IMB] headers. - - ENVELOPE - The envelope structure of the message. This is computed by the - server by parsing the [RFC-2822] header into the component - parts, defaulting various fields as necessary. - - FLAGS - The flags that are set for this message. - - INTERNALDATE - The internal date of the message. - - RFC822 - Functionally equivalent to BODY[], differing in the syntax of - the resulting untagged FETCH data (RFC822 is returned). - - RFC822.HEADER - Functionally equivalent to BODY.PEEK[HEADER], differing in the - syntax of the resulting untagged FETCH data (RFC822.HEADER is - returned). - - RFC822.SIZE - The [RFC-2822] size of the message. - - - - -Crispin Standards Track [Page 57] - -RFC 3501 IMAPv4 March 2003 - - - RFC822.TEXT - Functionally equivalent to BODY[TEXT], differing in the syntax - of the resulting untagged FETCH data (RFC822.TEXT is returned). - - UID - The unique identifier for the message. - - - Example: C: A654 FETCH 2:4 (FLAGS BODY[HEADER.FIELDS (DATE FROM)]) - S: * 2 FETCH .... - S: * 3 FETCH .... - S: * 4 FETCH .... - S: A654 OK FETCH completed - - -6.4.6. STORE Command - - Arguments: sequence set - message data item name - value for message data item - - Responses: untagged responses: FETCH - - Result: OK - store completed - NO - store error: can't store that data - BAD - command unknown or arguments invalid - - The STORE command alters data associated with a message in the - mailbox. Normally, STORE will return the updated value of the - data with an untagged FETCH response. A suffix of ".SILENT" in - the data item name prevents the untagged FETCH, and the server - SHOULD assume that the client has determined the updated value - itself or does not care about the updated value. - - Note: Regardless of whether or not the ".SILENT" suffix - was used, the server SHOULD send an untagged FETCH - response if a change to a message's flags from an - external source is observed. The intent is that the - status of the flags is determinate without a race - condition. - - - - - - - - - - - -Crispin Standards Track [Page 58] - -RFC 3501 IMAPv4 March 2003 - - - The currently defined data items that can be stored are: - - FLAGS - Replace the flags for the message (other than \Recent) with the - argument. The new value of the flags is returned as if a FETCH - of those flags was done. - - FLAGS.SILENT - Equivalent to FLAGS, but without returning a new value. - - +FLAGS - Add the argument to the flags for the message. The new value - of the flags is returned as if a FETCH of those flags was done. - - +FLAGS.SILENT - Equivalent to +FLAGS, but without returning a new value. - - -FLAGS - Remove the argument from the flags for the message. The new - value of the flags is returned as if a FETCH of those flags was - done. - - -FLAGS.SILENT - Equivalent to -FLAGS, but without returning a new value. - - - Example: C: A003 STORE 2:4 +FLAGS (\Deleted) - S: * 2 FETCH (FLAGS (\Deleted \Seen)) - S: * 3 FETCH (FLAGS (\Deleted)) - S: * 4 FETCH (FLAGS (\Deleted \Flagged \Seen)) - S: A003 OK STORE completed - - -6.4.7. COPY Command - - Arguments: sequence set - mailbox name - - Responses: no specific responses for this command - - Result: OK - copy completed - NO - copy error: can't copy those messages or to that - name - BAD - command unknown or arguments invalid - - - - - - - -Crispin Standards Track [Page 59] - -RFC 3501 IMAPv4 March 2003 - - - The COPY command copies the specified message(s) to the end of the - specified destination mailbox. The flags and internal date of the - message(s) SHOULD be preserved, and the Recent flag SHOULD be set, - in the copy. - - If the destination mailbox does not exist, a server SHOULD return - an error. It SHOULD NOT automatically create the mailbox. Unless - it is certain that the destination mailbox can not be created, the - server MUST send the response code "[TRYCREATE]" as the prefix of - the text of the tagged NO response. This gives a hint to the - client that it can attempt a CREATE command and retry the COPY if - the CREATE is successful. - - If the COPY command is unsuccessful for any reason, server - implementations MUST restore the destination mailbox to its state - before the COPY attempt. - - Example: C: A003 COPY 2:4 MEETING - S: A003 OK COPY completed - - -6.4.8. UID Command - - Arguments: command name - command arguments - - Responses: untagged responses: FETCH, SEARCH - - Result: OK - UID command completed - NO - UID command error - BAD - command unknown or arguments invalid - - The UID command has two forms. In the first form, it takes as its - arguments a COPY, FETCH, or STORE command with arguments - appropriate for the associated command. However, the numbers in - the sequence set argument are unique identifiers instead of - message sequence numbers. Sequence set ranges are permitted, but - there is no guarantee that unique identifiers will be contiguous. - - A non-existent unique identifier is ignored without any error - message generated. Thus, it is possible for a UID FETCH command - to return an OK without any data or a UID COPY or UID STORE to - return an OK without performing any operations. - - In the second form, the UID command takes a SEARCH command with - SEARCH command arguments. The interpretation of the arguments is - the same as with SEARCH; however, the numbers returned in a SEARCH - response for a UID SEARCH command are unique identifiers instead - - - -Crispin Standards Track [Page 60] - -RFC 3501 IMAPv4 March 2003 - - - of message sequence numbers. For example, the command UID SEARCH - 1:100 UID 443:557 returns the unique identifiers corresponding to - the intersection of two sequence sets, the message sequence number - range 1:100 and the UID range 443:557. - - Note: in the above example, the UID range 443:557 - appears. The same comment about a non-existent unique - identifier being ignored without any error message also - applies here. Hence, even if neither UID 443 or 557 - exist, this range is valid and would include an existing - UID 495. - - Also note that a UID range of 559:* always includes the - UID of the last message in the mailbox, even if 559 is - higher than any assigned UID value. This is because the - contents of a range are independent of the order of the - range endpoints. Thus, any UID range with * as one of - the endpoints indicates at least one message (the - message with the highest numbered UID), unless the - mailbox is empty. - - The number after the "*" in an untagged FETCH response is always a - message sequence number, not a unique identifier, even for a UID - command response. However, server implementations MUST implicitly - include the UID message data item as part of any FETCH response - caused by a UID command, regardless of whether a UID was specified - as a message data item to the FETCH. - - - Note: The rule about including the UID message data item as part - of a FETCH response primarily applies to the UID FETCH and UID - STORE commands, including a UID FETCH command that does not - include UID as a message data item. Although it is unlikely that - the other UID commands will cause an untagged FETCH, this rule - applies to these commands as well. - - Example: C: A999 UID FETCH 4827313:4828442 FLAGS - S: * 23 FETCH (FLAGS (\Seen) UID 4827313) - S: * 24 FETCH (FLAGS (\Seen) UID 4827943) - S: * 25 FETCH (FLAGS (\Seen) UID 4828442) - S: A999 OK UID FETCH completed - - - - - - - - - - -Crispin Standards Track [Page 61] - -RFC 3501 IMAPv4 March 2003 - - -6.5. Client Commands - Experimental/Expansion - - -6.5.1. X Command - - Arguments: implementation defined - - Responses: implementation defined - - Result: OK - command completed - NO - failure - BAD - command unknown or arguments invalid - - Any command prefixed with an X is an experimental command. - Commands which are not part of this specification, a standard or - standards-track revision of this specification, or an - IESG-approved experimental protocol, MUST use the X prefix. - - Any added untagged responses issued by an experimental command - MUST also be prefixed with an X. Server implementations MUST NOT - send any such untagged responses, unless the client requested it - by issuing the associated experimental command. - - Example: C: a441 CAPABILITY - S: * CAPABILITY IMAP4rev1 XPIG-LATIN - S: a441 OK CAPABILITY completed - C: A442 XPIG-LATIN - S: * XPIG-LATIN ow-nay eaking-spay ig-pay atin-lay - S: A442 OK XPIG-LATIN ompleted-cay - -7. Server Responses - - Server responses are in three forms: status responses, server data, - and command continuation request. The information contained in a - server response, identified by "Contents:" in the response - descriptions below, is described by function, not by syntax. The - precise syntax of server responses is described in the Formal Syntax - section. - - The client MUST be prepared to accept any response at all times. - - Status responses can be tagged or untagged. Tagged status responses - indicate the completion result (OK, NO, or BAD status) of a client - command, and have a tag matching the command. - - Some status responses, and all server data, are untagged. An - untagged response is indicated by the token "*" instead of a tag. - Untagged status responses indicate server greeting, or server status - - - -Crispin Standards Track [Page 62] - -RFC 3501 IMAPv4 March 2003 - - - that does not indicate the completion of a command (for example, an - impending system shutdown alert). For historical reasons, untagged - server data responses are also called "unsolicited data", although - strictly speaking, only unilateral server data is truly - "unsolicited". - - Certain server data MUST be recorded by the client when it is - received; this is noted in the description of that data. Such data - conveys critical information which affects the interpretation of all - subsequent commands and responses (e.g., updates reflecting the - creation or destruction of messages). - - Other server data SHOULD be recorded for later reference; if the - client does not need to record the data, or if recording the data has - no obvious purpose (e.g., a SEARCH response when no SEARCH command is - in progress), the data SHOULD be ignored. - - An example of unilateral untagged server data occurs when the IMAP - connection is in the selected state. In the selected state, the - server checks the mailbox for new messages as part of command - execution. Normally, this is part of the execution of every command; - hence, a NOOP command suffices to check for new messages. If new - messages are found, the server sends untagged EXISTS and RECENT - responses reflecting the new size of the mailbox. Server - implementations that offer multiple simultaneous access to the same - mailbox SHOULD also send appropriate unilateral untagged FETCH and - EXPUNGE responses if another agent changes the state of any message - flags or expunges any messages. - - Command continuation request responses use the token "+" instead of a - tag. These responses are sent by the server to indicate acceptance - of an incomplete client command and readiness for the remainder of - the command. - -7.1. Server Responses - Status Responses - - Status responses are OK, NO, BAD, PREAUTH and BYE. OK, NO, and BAD - can be tagged or untagged. PREAUTH and BYE are always untagged. - - Status responses MAY include an OPTIONAL "response code". A response - code consists of data inside square brackets in the form of an atom, - possibly followed by a space and arguments. The response code - contains additional information or status codes for client software - beyond the OK/NO/BAD condition, and are defined when there is a - specific action that a client can take based upon the additional - information. - - - - - -Crispin Standards Track [Page 63] - -RFC 3501 IMAPv4 March 2003 - - - The currently defined response codes are: - - ALERT - - The human-readable text contains a special alert that MUST be - presented to the user in a fashion that calls the user's - attention to the message. - - BADCHARSET - - Optionally followed by a parenthesized list of charsets. A - SEARCH failed because the given charset is not supported by - this implementation. If the optional list of charsets is - given, this lists the charsets that are supported by this - implementation. - - CAPABILITY - - Followed by a list of capabilities. This can appear in the - initial OK or PREAUTH response to transmit an initial - capabilities list. This makes it unnecessary for a client to - send a separate CAPABILITY command if it recognizes this - response. - - PARSE - - The human-readable text represents an error in parsing the - [RFC-2822] header or [MIME-IMB] headers of a message in the - mailbox. - - PERMANENTFLAGS - - Followed by a parenthesized list of flags, indicates which of - the known flags the client can change permanently. Any flags - that are in the FLAGS untagged response, but not the - PERMANENTFLAGS list, can not be set permanently. If the client - attempts to STORE a flag that is not in the PERMANENTFLAGS - list, the server will either ignore the change or store the - state change for the remainder of the current session only. - The PERMANENTFLAGS list can also include the special flag \*, - which indicates that it is possible to create new keywords by - attempting to store those flags in the mailbox. - - - - - - - - - -Crispin Standards Track [Page 64] - -RFC 3501 IMAPv4 March 2003 - - - READ-ONLY - - The mailbox is selected read-only, or its access while selected - has changed from read-write to read-only. - - READ-WRITE - - The mailbox is selected read-write, or its access while - selected has changed from read-only to read-write. - - TRYCREATE - - An APPEND or COPY attempt is failing because the target mailbox - does not exist (as opposed to some other reason). This is a - hint to the client that the operation can succeed if the - mailbox is first created by the CREATE command. - - UIDNEXT - - Followed by a decimal number, indicates the next unique - identifier value. Refer to section 2.3.1.1 for more - information. - - UIDVALIDITY - - Followed by a decimal number, indicates the unique identifier - validity value. Refer to section 2.3.1.1 for more information. - - UNSEEN - - Followed by a decimal number, indicates the number of the first - message without the \Seen flag set. - - Additional response codes defined by particular client or server - implementations SHOULD be prefixed with an "X" until they are - added to a revision of this protocol. Client implementations - SHOULD ignore response codes that they do not recognize. - -7.1.1. OK Response - - Contents: OPTIONAL response code - human-readable text - - The OK response indicates an information message from the server. - When tagged, it indicates successful completion of the associated - command. The human-readable text MAY be presented to the user as - an information message. The untagged form indicates an - - - - -Crispin Standards Track [Page 65] - -RFC 3501 IMAPv4 March 2003 - - - information-only message; the nature of the information MAY be - indicated by a response code. - - The untagged form is also used as one of three possible greetings - at connection startup. It indicates that the connection is not - yet authenticated and that a LOGIN command is needed. - - Example: S: * OK IMAP4rev1 server ready - C: A001 LOGIN fred blurdybloop - S: * OK [ALERT] System shutdown in 10 minutes - S: A001 OK LOGIN Completed - - -7.1.2. NO Response - - Contents: OPTIONAL response code - human-readable text - - The NO response indicates an operational error message from the - server. When tagged, it indicates unsuccessful completion of the - associated command. The untagged form indicates a warning; the - command can still complete successfully. The human-readable text - describes the condition. - - Example: C: A222 COPY 1:2 owatagusiam - S: * NO Disk is 98% full, please delete unnecessary data - S: A222 OK COPY completed - C: A223 COPY 3:200 blurdybloop - S: * NO Disk is 98% full, please delete unnecessary data - S: * NO Disk is 99% full, please delete unnecessary data - S: A223 NO COPY failed: disk is full - - -7.1.3. BAD Response - - Contents: OPTIONAL response code - human-readable text - - The BAD response indicates an error message from the server. When - tagged, it reports a protocol-level error in the client's command; - the tag indicates the command that caused the error. The untagged - form indicates a protocol-level error for which the associated - command can not be determined; it can also indicate an internal - server failure. The human-readable text describes the condition. - - - - - - - -Crispin Standards Track [Page 66] - -RFC 3501 IMAPv4 March 2003 - - - Example: C: ...very long command line... - S: * BAD Command line too long - C: ...empty line... - S: * BAD Empty command line - C: A443 EXPUNGE - S: * BAD Disk crash, attempting salvage to a new disk! - S: * OK Salvage successful, no data lost - S: A443 OK Expunge completed - - -7.1.4. PREAUTH Response - - Contents: OPTIONAL response code - human-readable text - - The PREAUTH response is always untagged, and is one of three - possible greetings at connection startup. It indicates that the - connection has already been authenticated by external means; thus - no LOGIN command is needed. - - Example: S: * PREAUTH IMAP4rev1 server logged in as Smith - - -7.1.5. BYE Response - - Contents: OPTIONAL response code - human-readable text - - The BYE response is always untagged, and indicates that the server - is about to close the connection. The human-readable text MAY be - displayed to the user in a status report by the client. The BYE - response is sent under one of four conditions: - - 1) as part of a normal logout sequence. The server will close - the connection after sending the tagged OK response to the - LOGOUT command. - - 2) as a panic shutdown announcement. The server closes the - connection immediately. - - 3) as an announcement of an inactivity autologout. The server - closes the connection immediately. - - 4) as one of three possible greetings at connection startup, - indicating that the server is not willing to accept a - connection from this client. The server closes the - connection immediately. - - - - -Crispin Standards Track [Page 67] - -RFC 3501 IMAPv4 March 2003 - - - The difference between a BYE that occurs as part of a normal - LOGOUT sequence (the first case) and a BYE that occurs because of - a failure (the other three cases) is that the connection closes - immediately in the failure case. In all cases the client SHOULD - continue to read response data from the server until the - connection is closed; this will ensure that any pending untagged - or completion responses are read and processed. - - Example: S: * BYE Autologout; idle for too long - -7.2. Server Responses - Server and Mailbox Status - - These responses are always untagged. This is how server and mailbox - status data are transmitted from the server to the client. Many of - these responses typically result from a command with the same name. - -7.2.1. CAPABILITY Response - - Contents: capability listing - - The CAPABILITY response occurs as a result of a CAPABILITY - command. The capability listing contains a space-separated - listing of capability names that the server supports. The - capability listing MUST include the atom "IMAP4rev1". - - In addition, client and server implementations MUST implement the - STARTTLS, LOGINDISABLED, and AUTH=PLAIN (described in [IMAP-TLS]) - capabilities. See the Security Considerations section for - important information. - - A capability name which begins with "AUTH=" indicates that the - server supports that particular authentication mechanism. - - The LOGINDISABLED capability indicates that the LOGIN command is - disabled, and that the server will respond with a tagged NO - response to any attempt to use the LOGIN command even if the user - name and password are valid. An IMAP client MUST NOT issue the - LOGIN command if the server advertises the LOGINDISABLED - capability. - - Other capability names indicate that the server supports an - extension, revision, or amendment to the IMAP4rev1 protocol. - Server responses MUST conform to this document until the client - issues a command that uses the associated capability. - - Capability names MUST either begin with "X" or be standard or - standards-track IMAP4rev1 extensions, revisions, or amendments - registered with IANA. A server MUST NOT offer unregistered or - - - -Crispin Standards Track [Page 68] - -RFC 3501 IMAPv4 March 2003 - - - non-standard capability names, unless such names are prefixed with - an "X". - - Client implementations SHOULD NOT require any capability name - other than "IMAP4rev1", and MUST ignore any unknown capability - names. - - A server MAY send capabilities automatically, by using the - CAPABILITY response code in the initial PREAUTH or OK responses, - and by sending an updated CAPABILITY response code in the tagged - OK response as part of a successful authentication. It is - unnecessary for a client to send a separate CAPABILITY command if - it recognizes these automatic capabilities. - - Example: S: * CAPABILITY IMAP4rev1 STARTTLS AUTH=GSSAPI XPIG-LATIN - - -7.2.2. LIST Response - - Contents: name attributes - hierarchy delimiter - name - - The LIST response occurs as a result of a LIST command. It - returns a single name that matches the LIST specification. There - can be multiple LIST responses for a single LIST command. - - Four name attributes are defined: - - \Noinferiors - It is not possible for any child levels of hierarchy to exist - under this name; no child levels exist now and none can be - created in the future. - - \Noselect - It is not possible to use this name as a selectable mailbox. - - \Marked - The mailbox has been marked "interesting" by the server; the - mailbox probably contains messages that have been added since - the last time the mailbox was selected. - - \Unmarked - The mailbox does not contain any additional messages since the - last time the mailbox was selected. - - - - - - -Crispin Standards Track [Page 69] - -RFC 3501 IMAPv4 March 2003 - - - If it is not feasible for the server to determine whether or not - the mailbox is "interesting", or if the name is a \Noselect name, - the server SHOULD NOT send either \Marked or \Unmarked. - - The hierarchy delimiter is a character used to delimit levels of - hierarchy in a mailbox name. A client can use it to create child - mailboxes, and to search higher or lower levels of naming - hierarchy. All children of a top-level hierarchy node MUST use - the same separator character. A NIL hierarchy delimiter means - that no hierarchy exists; the name is a "flat" name. - - The name represents an unambiguous left-to-right hierarchy, and - MUST be valid for use as a reference in LIST and LSUB commands. - Unless \Noselect is indicated, the name MUST also be valid as an - argument for commands, such as SELECT, that accept mailbox names. - - Example: S: * LIST (\Noselect) "/" ~/Mail/foo - - -7.2.3. LSUB Response - - Contents: name attributes - hierarchy delimiter - name - - The LSUB response occurs as a result of an LSUB command. It - returns a single name that matches the LSUB specification. There - can be multiple LSUB responses for a single LSUB command. The - data is identical in format to the LIST response. - - Example: S: * LSUB () "." #news.comp.mail.misc - - -7.2.4 STATUS Response - - Contents: name - status parenthesized list - - The STATUS response occurs as a result of an STATUS command. It - returns the mailbox name that matches the STATUS specification and - the requested mailbox status information. - - Example: S: * STATUS blurdybloop (MESSAGES 231 UIDNEXT 44292) - - - - - - - - -Crispin Standards Track [Page 70] - -RFC 3501 IMAPv4 March 2003 - - -7.2.5. SEARCH Response - - Contents: zero or more numbers - - The SEARCH response occurs as a result of a SEARCH or UID SEARCH - command. The number(s) refer to those messages that match the - search criteria. For SEARCH, these are message sequence numbers; - for UID SEARCH, these are unique identifiers. Each number is - delimited by a space. - - Example: S: * SEARCH 2 3 6 - - -7.2.6. FLAGS Response - - Contents: flag parenthesized list - - The FLAGS response occurs as a result of a SELECT or EXAMINE - command. The flag parenthesized list identifies the flags (at a - minimum, the system-defined flags) that are applicable for this - mailbox. Flags other than the system flags can also exist, - depending on server implementation. - - The update from the FLAGS response MUST be recorded by the client. - - Example: S: * FLAGS (\Answered \Flagged \Deleted \Seen \Draft) - - -7.3. Server Responses - Mailbox Size - - These responses are always untagged. This is how changes in the size - of the mailbox are transmitted from the server to the client. - Immediately following the "*" token is a number that represents a - message count. - -7.3.1. EXISTS Response - - Contents: none - - The EXISTS response reports the number of messages in the mailbox. - This response occurs as a result of a SELECT or EXAMINE command, - and if the size of the mailbox changes (e.g., new messages). - - The update from the EXISTS response MUST be recorded by the - client. - - Example: S: * 23 EXISTS - - - - -Crispin Standards Track [Page 71] - -RFC 3501 IMAPv4 March 2003 - - -7.3.2. RECENT Response - - Contents: none - - The RECENT response reports the number of messages with the - \Recent flag set. This response occurs as a result of a SELECT or - EXAMINE command, and if the size of the mailbox changes (e.g., new - messages). - - Note: It is not guaranteed that the message sequence - numbers of recent messages will be a contiguous range of - the highest n messages in the mailbox (where n is the - value reported by the RECENT response). Examples of - situations in which this is not the case are: multiple - clients having the same mailbox open (the first session - to be notified will see it as recent, others will - probably see it as non-recent), and when the mailbox is - re-ordered by a non-IMAP agent. - - The only reliable way to identify recent messages is to - look at message flags to see which have the \Recent flag - set, or to do a SEARCH RECENT. - - The update from the RECENT response MUST be recorded by the - client. - - Example: S: * 5 RECENT - - -7.4. Server Responses - Message Status - - These responses are always untagged. This is how message data are - transmitted from the server to the client, often as a result of a - command with the same name. Immediately following the "*" token is a - number that represents a message sequence number. - -7.4.1. EXPUNGE Response - - Contents: none - - The EXPUNGE response reports that the specified message sequence - number has been permanently removed from the mailbox. The message - sequence number for each successive message in the mailbox is - immediately decremented by 1, and this decrement is reflected in - message sequence numbers in subsequent responses (including other - untagged EXPUNGE responses). - - - - - -Crispin Standards Track [Page 72] - -RFC 3501 IMAPv4 March 2003 - - - The EXPUNGE response also decrements the number of messages in the - mailbox; it is not necessary to send an EXISTS response with the - new value. - - As a result of the immediate decrement rule, message sequence - numbers that appear in a set of successive EXPUNGE responses - depend upon whether the messages are removed starting from lower - numbers to higher numbers, or from higher numbers to lower - numbers. For example, if the last 5 messages in a 9-message - mailbox are expunged, a "lower to higher" server will send five - untagged EXPUNGE responses for message sequence number 5, whereas - a "higher to lower server" will send successive untagged EXPUNGE - responses for message sequence numbers 9, 8, 7, 6, and 5. - - An EXPUNGE response MUST NOT be sent when no command is in - progress, nor while responding to a FETCH, STORE, or SEARCH - command. This rule is necessary to prevent a loss of - synchronization of message sequence numbers between client and - server. A command is not "in progress" until the complete command - has been received; in particular, a command is not "in progress" - during the negotiation of command continuation. - - Note: UID FETCH, UID STORE, and UID SEARCH are different - commands from FETCH, STORE, and SEARCH. An EXPUNGE - response MAY be sent during a UID command. - - The update from the EXPUNGE response MUST be recorded by the - client. - - Example: S: * 44 EXPUNGE - - -7.4.2. FETCH Response - - Contents: message data - - The FETCH response returns data about a message to the client. - The data are pairs of data item names and their values in - parentheses. This response occurs as the result of a FETCH or - STORE command, as well as by unilateral server decision (e.g., - flag updates). - - The current data items are: - - BODY - A form of BODYSTRUCTURE without extension data. - - - - - -Crispin Standards Track [Page 73] - -RFC 3501 IMAPv4 March 2003 - - - BODY[

]<> - A string expressing the body contents of the specified section. - The string SHOULD be interpreted by the client according to the - content transfer encoding, body type, and subtype. - - If the origin octet is specified, this string is a substring of - the entire body contents, starting at that origin octet. This - means that BODY[]<0> MAY be truncated, but BODY[] is NEVER - truncated. - - Note: The origin octet facility MUST NOT be used by a server - in a FETCH response unless the client specifically requested - it by means of a FETCH of a BODY[

]<> data - item. - - 8-bit textual data is permitted if a [CHARSET] identifier is - part of the body parameter parenthesized list for this section. - Note that headers (part specifiers HEADER or MIME, or the - header portion of a MESSAGE/RFC822 part), MUST be 7-bit; 8-bit - characters are not permitted in headers. Note also that the - [RFC-2822] delimiting blank line between the header and the - body is not affected by header line subsetting; the blank line - is always included as part of header data, except in the case - of a message which has no body and no blank line. - - Non-textual data such as binary data MUST be transfer encoded - into a textual form, such as BASE64, prior to being sent to the - client. To derive the original binary data, the client MUST - decode the transfer encoded string. - - BODYSTRUCTURE - A parenthesized list that describes the [MIME-IMB] body - structure of a message. This is computed by the server by - parsing the [MIME-IMB] header fields, defaulting various fields - as necessary. - - For example, a simple text message of 48 lines and 2279 octets - can have a body structure of: ("TEXT" "PLAIN" ("CHARSET" - "US-ASCII") NIL NIL "7BIT" 2279 48) - - Multiple parts are indicated by parenthesis nesting. Instead - of a body type as the first element of the parenthesized list, - there is a sequence of one or more nested body structures. The - second element of the parenthesized list is the multipart - subtype (mixed, digest, parallel, alternative, etc.). - - - - - - -Crispin Standards Track [Page 74] - -RFC 3501 IMAPv4 March 2003 - - - For example, a two part message consisting of a text and a - BASE64-encoded text attachment can have a body structure of: - (("TEXT" "PLAIN" ("CHARSET" "US-ASCII") NIL NIL "7BIT" 1152 - 23)("TEXT" "PLAIN" ("CHARSET" "US-ASCII" "NAME" "cc.diff") - "<960723163407.20117h@cac.washington.edu>" "Compiler diff" - "BASE64" 4554 73) "MIXED") - - Extension data follows the multipart subtype. Extension data - is never returned with the BODY fetch, but can be returned with - a BODYSTRUCTURE fetch. Extension data, if present, MUST be in - the defined order. The extension data of a multipart body part - are in the following order: - - body parameter parenthesized list - A parenthesized list of attribute/value pairs [e.g., ("foo" - "bar" "baz" "rag") where "bar" is the value of "foo", and - "rag" is the value of "baz"] as defined in [MIME-IMB]. - - body disposition - A parenthesized list, consisting of a disposition type - string, followed by a parenthesized list of disposition - attribute/value pairs as defined in [DISPOSITION]. - - body language - A string or parenthesized list giving the body language - value as defined in [LANGUAGE-TAGS]. - - body location - A string list giving the body content URI as defined in - [LOCATION]. - - Any following extension data are not yet defined in this - version of the protocol. Such extension data can consist of - zero or more NILs, strings, numbers, or potentially nested - parenthesized lists of such data. Client implementations that - do a BODYSTRUCTURE fetch MUST be prepared to accept such - extension data. Server implementations MUST NOT send such - extension data until it has been defined by a revision of this - protocol. - - The basic fields of a non-multipart body part are in the - following order: - - body type - A string giving the content media type name as defined in - [MIME-IMB]. - - - - - -Crispin Standards Track [Page 75] - -RFC 3501 IMAPv4 March 2003 - - - body subtype - A string giving the content subtype name as defined in - [MIME-IMB]. - - body parameter parenthesized list - A parenthesized list of attribute/value pairs [e.g., ("foo" - "bar" "baz" "rag") where "bar" is the value of "foo" and - "rag" is the value of "baz"] as defined in [MIME-IMB]. - - body id - A string giving the content id as defined in [MIME-IMB]. - - body description - A string giving the content description as defined in - [MIME-IMB]. - - body encoding - A string giving the content transfer encoding as defined in - [MIME-IMB]. - - body size - A number giving the size of the body in octets. Note that - this size is the size in its transfer encoding and not the - resulting size after any decoding. - - A body type of type MESSAGE and subtype RFC822 contains, - immediately after the basic fields, the envelope structure, - body structure, and size in text lines of the encapsulated - message. - - A body type of type TEXT contains, immediately after the basic - fields, the size of the body in text lines. Note that this - size is the size in its content transfer encoding and not the - resulting size after any decoding. - - Extension data follows the basic fields and the type-specific - fields listed above. Extension data is never returned with the - BODY fetch, but can be returned with a BODYSTRUCTURE fetch. - Extension data, if present, MUST be in the defined order. - - The extension data of a non-multipart body part are in the - following order: - - body MD5 - A string giving the body MD5 value as defined in [MD5]. - - - - - - -Crispin Standards Track [Page 76] - -RFC 3501 IMAPv4 March 2003 - - - body disposition - A parenthesized list with the same content and function as - the body disposition for a multipart body part. - - body language - A string or parenthesized list giving the body language - value as defined in [LANGUAGE-TAGS]. - - body location - A string list giving the body content URI as defined in - [LOCATION]. - - Any following extension data are not yet defined in this - version of the protocol, and would be as described above under - multipart extension data. - - ENVELOPE - A parenthesized list that describes the envelope structure of a - message. This is computed by the server by parsing the - [RFC-2822] header into the component parts, defaulting various - fields as necessary. - - The fields of the envelope structure are in the following - order: date, subject, from, sender, reply-to, to, cc, bcc, - in-reply-to, and message-id. The date, subject, in-reply-to, - and message-id fields are strings. The from, sender, reply-to, - to, cc, and bcc fields are parenthesized lists of address - structures. - - An address structure is a parenthesized list that describes an - electronic mail address. The fields of an address structure - are in the following order: personal name, [SMTP] - at-domain-list (source route), mailbox name, and host name. - - [RFC-2822] group syntax is indicated by a special form of - address structure in which the host name field is NIL. If the - mailbox name field is also NIL, this is an end of group marker - (semi-colon in RFC 822 syntax). If the mailbox name field is - non-NIL, this is a start of group marker, and the mailbox name - field holds the group name phrase. - - If the Date, Subject, In-Reply-To, and Message-ID header lines - are absent in the [RFC-2822] header, the corresponding member - of the envelope is NIL; if these header lines are present but - empty the corresponding member of the envelope is the empty - string. - - - - - -Crispin Standards Track [Page 77] - -RFC 3501 IMAPv4 March 2003 - - - Note: some servers may return a NIL envelope member in the - "present but empty" case. Clients SHOULD treat NIL and - empty string as identical. - - Note: [RFC-2822] requires that all messages have a valid - Date header. Therefore, the date member in the envelope can - not be NIL or the empty string. - - Note: [RFC-2822] requires that the In-Reply-To and - Message-ID headers, if present, have non-empty content. - Therefore, the in-reply-to and message-id members in the - envelope can not be the empty string. - - If the From, To, cc, and bcc header lines are absent in the - [RFC-2822] header, or are present but empty, the corresponding - member of the envelope is NIL. - - If the Sender or Reply-To lines are absent in the [RFC-2822] - header, or are present but empty, the server sets the - corresponding member of the envelope to be the same value as - the from member (the client is not expected to know to do - this). - - Note: [RFC-2822] requires that all messages have a valid - From header. Therefore, the from, sender, and reply-to - members in the envelope can not be NIL. - - FLAGS - A parenthesized list of flags that are set for this message. - - INTERNALDATE - A string representing the internal date of the message. - - RFC822 - Equivalent to BODY[]. - - RFC822.HEADER - Equivalent to BODY[HEADER]. Note that this did not result in - \Seen being set, because RFC822.HEADER response data occurs as - a result of a FETCH of RFC822.HEADER. BODY[HEADER] response - data occurs as a result of a FETCH of BODY[HEADER] (which sets - \Seen) or BODY.PEEK[HEADER] (which does not set \Seen). - - RFC822.SIZE - A number expressing the [RFC-2822] size of the message. - - - - - - -Crispin Standards Track [Page 78] - -RFC 3501 IMAPv4 March 2003 - - - RFC822.TEXT - Equivalent to BODY[TEXT]. - - UID - A number expressing the unique identifier of the message. - - - Example: S: * 23 FETCH (FLAGS (\Seen) RFC822.SIZE 44827) - - -7.5. Server Responses - Command Continuation Request - - The command continuation request response is indicated by a "+" token - instead of a tag. This form of response indicates that the server is - ready to accept the continuation of a command from the client. The - remainder of this response is a line of text. - - This response is used in the AUTHENTICATE command to transmit server - data to the client, and request additional client data. This - response is also used if an argument to any command is a literal. - - The client is not permitted to send the octets of the literal unless - the server indicates that it is expected. This permits the server to - process commands and reject errors on a line-by-line basis. The - remainder of the command, including the CRLF that terminates a - command, follows the octets of the literal. If there are any - additional command arguments, the literal octets are followed by a - space and those arguments. - - Example: C: A001 LOGIN {11} - S: + Ready for additional command text - C: FRED FOOBAR {7} - S: + Ready for additional command text - C: fat man - S: A001 OK LOGIN completed - C: A044 BLURDYBLOOP {102856} - S: A044 BAD No such command as "BLURDYBLOOP" - - - - - - - - - - - - - - -Crispin Standards Track [Page 79] - -RFC 3501 IMAPv4 March 2003 - - -8. Sample IMAP4rev1 connection - - The following is a transcript of an IMAP4rev1 connection. A long - line in this sample is broken for editorial clarity. - -S: * OK IMAP4rev1 Service Ready -C: a001 login mrc secret -S: a001 OK LOGIN completed -C: a002 select inbox -S: * 18 EXISTS -S: * FLAGS (\Answered \Flagged \Deleted \Seen \Draft) -S: * 2 RECENT -S: * OK [UNSEEN 17] Message 17 is the first unseen message -S: * OK [UIDVALIDITY 3857529045] UIDs valid -S: a002 OK [READ-WRITE] SELECT completed -C: a003 fetch 12 full -S: * 12 FETCH (FLAGS (\Seen) INTERNALDATE "17-Jul-1996 02:44:25 -0700" - RFC822.SIZE 4286 ENVELOPE ("Wed, 17 Jul 1996 02:23:25 -0700 (PDT)" - "IMAP4rev1 WG mtg summary and minutes" - (("Terry Gray" NIL "gray" "cac.washington.edu")) - (("Terry Gray" NIL "gray" "cac.washington.edu")) - (("Terry Gray" NIL "gray" "cac.washington.edu")) - ((NIL NIL "imap" "cac.washington.edu")) - ((NIL NIL "minutes" "CNRI.Reston.VA.US") - ("John Klensin" NIL "KLENSIN" "MIT.EDU")) NIL NIL - "") - BODY ("TEXT" "PLAIN" ("CHARSET" "US-ASCII") NIL NIL "7BIT" 3028 - 92)) -S: a003 OK FETCH completed -C: a004 fetch 12 body[header] -S: * 12 FETCH (BODY[HEADER] {342} -S: Date: Wed, 17 Jul 1996 02:23:25 -0700 (PDT) -S: From: Terry Gray -S: Subject: IMAP4rev1 WG mtg summary and minutes -S: To: imap@cac.washington.edu -S: cc: minutes@CNRI.Reston.VA.US, John Klensin -S: Message-Id: -S: MIME-Version: 1.0 -S: Content-Type: TEXT/PLAIN; CHARSET=US-ASCII -S: -S: ) -S: a004 OK FETCH completed -C: a005 store 12 +flags \deleted -S: * 12 FETCH (FLAGS (\Seen \Deleted)) -S: a005 OK +FLAGS completed -C: a006 logout -S: * BYE IMAP4rev1 server terminating connection -S: a006 OK LOGOUT completed - - - -Crispin Standards Track [Page 80] - -RFC 3501 IMAPv4 March 2003 - - -9. Formal Syntax - - The following syntax specification uses the Augmented Backus-Naur - Form (ABNF) notation as specified in [ABNF]. - - In the case of alternative or optional rules in which a later rule - overlaps an earlier rule, the rule which is listed earlier MUST take - priority. For example, "\Seen" when parsed as a flag is the \Seen - flag name and not a flag-extension, even though "\Seen" can be parsed - as a flag-extension. Some, but not all, instances of this rule are - noted below. - - Note: [ABNF] rules MUST be followed strictly; in - particular: - - (1) Except as noted otherwise, all alphabetic characters - are case-insensitive. The use of upper or lower case - characters to define token strings is for editorial clarity - only. Implementations MUST accept these strings in a - case-insensitive fashion. - - (2) In all cases, SP refers to exactly one space. It is - NOT permitted to substitute TAB, insert additional spaces, - or otherwise treat SP as being equivalent to LWSP. - - (3) The ASCII NUL character, %x00, MUST NOT be used at any - time. - -address = "(" addr-name SP addr-adl SP addr-mailbox SP - addr-host ")" - -addr-adl = nstring - ; Holds route from [RFC-2822] route-addr if - ; non-NIL - -addr-host = nstring - ; NIL indicates [RFC-2822] group syntax. - ; Otherwise, holds [RFC-2822] domain name - -addr-mailbox = nstring - ; NIL indicates end of [RFC-2822] group; if - ; non-NIL and addr-host is NIL, holds - ; [RFC-2822] group name. - ; Otherwise, holds [RFC-2822] local-part - ; after removing [RFC-2822] quoting - - - - - - -Crispin Standards Track [Page 81] - -RFC 3501 IMAPv4 March 2003 - - -addr-name = nstring - ; If non-NIL, holds phrase from [RFC-2822] - ; mailbox after removing [RFC-2822] quoting - -append = "APPEND" SP mailbox [SP flag-list] [SP date-time] SP - literal - -astring = 1*ASTRING-CHAR / string - -ASTRING-CHAR = ATOM-CHAR / resp-specials - -atom = 1*ATOM-CHAR - -ATOM-CHAR = - -atom-specials = "(" / ")" / "{" / SP / CTL / list-wildcards / - quoted-specials / resp-specials - -authenticate = "AUTHENTICATE" SP auth-type *(CRLF base64) - -auth-type = atom - ; Defined by [SASL] - -base64 = *(4base64-char) [base64-terminal] - -base64-char = ALPHA / DIGIT / "+" / "/" - ; Case-sensitive - -base64-terminal = (2base64-char "==") / (3base64-char "=") - -body = "(" (body-type-1part / body-type-mpart) ")" - -body-extension = nstring / number / - "(" body-extension *(SP body-extension) ")" - ; Future expansion. Client implementations - ; MUST accept body-extension fields. Server - ; implementations MUST NOT generate - ; body-extension fields except as defined by - ; future standard or standards-track - ; revisions of this specification. - -body-ext-1part = body-fld-md5 [SP body-fld-dsp [SP body-fld-lang - [SP body-fld-loc *(SP body-extension)]]] - ; MUST NOT be returned on non-extensible - ; "BODY" fetch - - - - - - -Crispin Standards Track [Page 82] - -RFC 3501 IMAPv4 March 2003 - - -body-ext-mpart = body-fld-param [SP body-fld-dsp [SP body-fld-lang - [SP body-fld-loc *(SP body-extension)]]] - ; MUST NOT be returned on non-extensible - ; "BODY" fetch - -body-fields = body-fld-param SP body-fld-id SP body-fld-desc SP - body-fld-enc SP body-fld-octets - -body-fld-desc = nstring - -body-fld-dsp = "(" string SP body-fld-param ")" / nil - -body-fld-enc = (DQUOTE ("7BIT" / "8BIT" / "BINARY" / "BASE64"/ - "QUOTED-PRINTABLE") DQUOTE) / string - -body-fld-id = nstring - -body-fld-lang = nstring / "(" string *(SP string) ")" - -body-fld-loc = nstring - -body-fld-lines = number - -body-fld-md5 = nstring - -body-fld-octets = number - -body-fld-param = "(" string SP string *(SP string SP string) ")" / nil - -body-type-1part = (body-type-basic / body-type-msg / body-type-text) - [SP body-ext-1part] - -body-type-basic = media-basic SP body-fields - ; MESSAGE subtype MUST NOT be "RFC822" - -body-type-mpart = 1*body SP media-subtype - [SP body-ext-mpart] - -body-type-msg = media-message SP body-fields SP envelope - SP body SP body-fld-lines - -body-type-text = media-text SP body-fields SP body-fld-lines - -capability = ("AUTH=" auth-type) / atom - ; New capabilities MUST begin with "X" or be - ; registered with IANA as standard or - ; standards-track - - - - -Crispin Standards Track [Page 83] - -RFC 3501 IMAPv4 March 2003 - - -capability-data = "CAPABILITY" *(SP capability) SP "IMAP4rev1" - *(SP capability) - ; Servers MUST implement the STARTTLS, AUTH=PLAIN, - ; and LOGINDISABLED capabilities - ; Servers which offer RFC 1730 compatibility MUST - ; list "IMAP4" as the first capability. - -CHAR8 = %x01-ff - ; any OCTET except NUL, %x00 - -command = tag SP (command-any / command-auth / command-nonauth / - command-select) CRLF - ; Modal based on state - -command-any = "CAPABILITY" / "LOGOUT" / "NOOP" / x-command - ; Valid in all states - -command-auth = append / create / delete / examine / list / lsub / - rename / select / status / subscribe / unsubscribe - ; Valid only in Authenticated or Selected state - -command-nonauth = login / authenticate / "STARTTLS" - ; Valid only when in Not Authenticated state - -command-select = "CHECK" / "CLOSE" / "EXPUNGE" / copy / fetch / store / - uid / search - ; Valid only when in Selected state - -continue-req = "+" SP (resp-text / base64) CRLF - -copy = "COPY" SP sequence-set SP mailbox - -create = "CREATE" SP mailbox - ; Use of INBOX gives a NO error - -date = date-text / DQUOTE date-text DQUOTE - -date-day = 1*2DIGIT - ; Day of month - -date-day-fixed = (SP DIGIT) / 2DIGIT - ; Fixed-format version of date-day - -date-month = "Jan" / "Feb" / "Mar" / "Apr" / "May" / "Jun" / - "Jul" / "Aug" / "Sep" / "Oct" / "Nov" / "Dec" - -date-text = date-day "-" date-month "-" date-year - - - - -Crispin Standards Track [Page 84] - -RFC 3501 IMAPv4 March 2003 - - -date-year = 4DIGIT - -date-time = DQUOTE date-day-fixed "-" date-month "-" date-year - SP time SP zone DQUOTE - -delete = "DELETE" SP mailbox - ; Use of INBOX gives a NO error - -digit-nz = %x31-39 - ; 1-9 - -envelope = "(" env-date SP env-subject SP env-from SP - env-sender SP env-reply-to SP env-to SP env-cc SP - env-bcc SP env-in-reply-to SP env-message-id ")" - -env-bcc = "(" 1*address ")" / nil - -env-cc = "(" 1*address ")" / nil - -env-date = nstring - -env-from = "(" 1*address ")" / nil - -env-in-reply-to = nstring - -env-message-id = nstring - -env-reply-to = "(" 1*address ")" / nil - -env-sender = "(" 1*address ")" / nil - -env-subject = nstring - -env-to = "(" 1*address ")" / nil - -examine = "EXAMINE" SP mailbox - -fetch = "FETCH" SP sequence-set SP ("ALL" / "FULL" / "FAST" / - fetch-att / "(" fetch-att *(SP fetch-att) ")") - -fetch-att = "ENVELOPE" / "FLAGS" / "INTERNALDATE" / - "RFC822" [".HEADER" / ".SIZE" / ".TEXT"] / - "BODY" ["STRUCTURE"] / "UID" / - "BODY" section ["<" number "." nz-number ">"] / - "BODY.PEEK" section ["<" number "." nz-number ">"] - - - - - - -Crispin Standards Track [Page 85] - -RFC 3501 IMAPv4 March 2003 - - -flag = "\Answered" / "\Flagged" / "\Deleted" / - "\Seen" / "\Draft" / flag-keyword / flag-extension - ; Does not include "\Recent" - -flag-extension = "\" atom - ; Future expansion. Client implementations - ; MUST accept flag-extension flags. Server - ; implementations MUST NOT generate - ; flag-extension flags except as defined by - ; future standard or standards-track - ; revisions of this specification. - -flag-fetch = flag / "\Recent" - -flag-keyword = atom - -flag-list = "(" [flag *(SP flag)] ")" - -flag-perm = flag / "\*" - -greeting = "*" SP (resp-cond-auth / resp-cond-bye) CRLF - -header-fld-name = astring - -header-list = "(" header-fld-name *(SP header-fld-name) ")" - -list = "LIST" SP mailbox SP list-mailbox - -list-mailbox = 1*list-char / string - -list-char = ATOM-CHAR / list-wildcards / resp-specials - -list-wildcards = "%" / "*" - -literal = "{" number "}" CRLF *CHAR8 - ; Number represents the number of CHAR8s - -login = "LOGIN" SP userid SP password - -lsub = "LSUB" SP mailbox SP list-mailbox - - - - - - - - - - - -Crispin Standards Track [Page 86] - -RFC 3501 IMAPv4 March 2003 - - -mailbox = "INBOX" / astring - ; INBOX is case-insensitive. All case variants of - ; INBOX (e.g., "iNbOx") MUST be interpreted as INBOX - ; not as an astring. An astring which consists of - ; the case-insensitive sequence "I" "N" "B" "O" "X" - ; is considered to be INBOX and not an astring. - ; Refer to section 5.1 for further - ; semantic details of mailbox names. - -mailbox-data = "FLAGS" SP flag-list / "LIST" SP mailbox-list / - "LSUB" SP mailbox-list / "SEARCH" *(SP nz-number) / - "STATUS" SP mailbox SP "(" [status-att-list] ")" / - number SP "EXISTS" / number SP "RECENT" - -mailbox-list = "(" [mbx-list-flags] ")" SP - (DQUOTE QUOTED-CHAR DQUOTE / nil) SP mailbox - -mbx-list-flags = *(mbx-list-oflag SP) mbx-list-sflag - *(SP mbx-list-oflag) / - mbx-list-oflag *(SP mbx-list-oflag) - -mbx-list-oflag = "\Noinferiors" / flag-extension - ; Other flags; multiple possible per LIST response - -mbx-list-sflag = "\Noselect" / "\Marked" / "\Unmarked" - ; Selectability flags; only one per LIST response - -media-basic = ((DQUOTE ("APPLICATION" / "AUDIO" / "IMAGE" / - "MESSAGE" / "VIDEO") DQUOTE) / string) SP - media-subtype - ; Defined in [MIME-IMT] - -media-message = DQUOTE "MESSAGE" DQUOTE SP DQUOTE "RFC822" DQUOTE - ; Defined in [MIME-IMT] - -media-subtype = string - ; Defined in [MIME-IMT] - -media-text = DQUOTE "TEXT" DQUOTE SP media-subtype - ; Defined in [MIME-IMT] - -message-data = nz-number SP ("EXPUNGE" / ("FETCH" SP msg-att)) - -msg-att = "(" (msg-att-dynamic / msg-att-static) - *(SP (msg-att-dynamic / msg-att-static)) ")" - -msg-att-dynamic = "FLAGS" SP "(" [flag-fetch *(SP flag-fetch)] ")" - ; MAY change for a message - - - -Crispin Standards Track [Page 87] - -RFC 3501 IMAPv4 March 2003 - - -msg-att-static = "ENVELOPE" SP envelope / "INTERNALDATE" SP date-time / - "RFC822" [".HEADER" / ".TEXT"] SP nstring / - "RFC822.SIZE" SP number / - "BODY" ["STRUCTURE"] SP body / - "BODY" section ["<" number ">"] SP nstring / - "UID" SP uniqueid - ; MUST NOT change for a message - -nil = "NIL" - -nstring = string / nil - -number = 1*DIGIT - ; Unsigned 32-bit integer - ; (0 <= n < 4,294,967,296) - -nz-number = digit-nz *DIGIT - ; Non-zero unsigned 32-bit integer - ; (0 < n < 4,294,967,296) - -password = astring - -quoted = DQUOTE *QUOTED-CHAR DQUOTE - -QUOTED-CHAR = / - "\" quoted-specials - -quoted-specials = DQUOTE / "\" - -rename = "RENAME" SP mailbox SP mailbox - ; Use of INBOX as a destination gives a NO error - -response = *(continue-req / response-data) response-done - -response-data = "*" SP (resp-cond-state / resp-cond-bye / - mailbox-data / message-data / capability-data) CRLF - -response-done = response-tagged / response-fatal - -response-fatal = "*" SP resp-cond-bye CRLF - ; Server closes connection immediately - -response-tagged = tag SP resp-cond-state CRLF - -resp-cond-auth = ("OK" / "PREAUTH") SP resp-text - ; Authentication condition - - - - - -Crispin Standards Track [Page 88] - -RFC 3501 IMAPv4 March 2003 - - -resp-cond-bye = "BYE" SP resp-text - -resp-cond-state = ("OK" / "NO" / "BAD") SP resp-text - ; Status condition - -resp-specials = "]" - -resp-text = ["[" resp-text-code "]" SP] text - -resp-text-code = "ALERT" / - "BADCHARSET" [SP "(" astring *(SP astring) ")" ] / - capability-data / "PARSE" / - "PERMANENTFLAGS" SP "(" - [flag-perm *(SP flag-perm)] ")" / - "READ-ONLY" / "READ-WRITE" / "TRYCREATE" / - "UIDNEXT" SP nz-number / "UIDVALIDITY" SP nz-number / - "UNSEEN" SP nz-number / - atom [SP 1*] - -search = "SEARCH" [SP "CHARSET" SP astring] 1*(SP search-key) - ; CHARSET argument to MUST be registered with IANA - -search-key = "ALL" / "ANSWERED" / "BCC" SP astring / - "BEFORE" SP date / "BODY" SP astring / - "CC" SP astring / "DELETED" / "FLAGGED" / - "FROM" SP astring / "KEYWORD" SP flag-keyword / - "NEW" / "OLD" / "ON" SP date / "RECENT" / "SEEN" / - "SINCE" SP date / "SUBJECT" SP astring / - "TEXT" SP astring / "TO" SP astring / - "UNANSWERED" / "UNDELETED" / "UNFLAGGED" / - "UNKEYWORD" SP flag-keyword / "UNSEEN" / - ; Above this line were in [IMAP2] - "DRAFT" / "HEADER" SP header-fld-name SP astring / - "LARGER" SP number / "NOT" SP search-key / - "OR" SP search-key SP search-key / - "SENTBEFORE" SP date / "SENTON" SP date / - "SENTSINCE" SP date / "SMALLER" SP number / - "UID" SP sequence-set / "UNDRAFT" / sequence-set / - "(" search-key *(SP search-key) ")" - -section = "[" [section-spec] "]" - -section-msgtext = "HEADER" / "HEADER.FIELDS" [".NOT"] SP header-list / - "TEXT" - ; top-level or MESSAGE/RFC822 part - -section-part = nz-number *("." nz-number) - ; body part nesting - - - -Crispin Standards Track [Page 89] - -RFC 3501 IMAPv4 March 2003 - - -section-spec = section-msgtext / (section-part ["." section-text]) - -section-text = section-msgtext / "MIME" - ; text other than actual body part (headers, etc.) - -select = "SELECT" SP mailbox - -seq-number = nz-number / "*" - ; message sequence number (COPY, FETCH, STORE - ; commands) or unique identifier (UID COPY, - ; UID FETCH, UID STORE commands). - ; * represents the largest number in use. In - ; the case of message sequence numbers, it is - ; the number of messages in a non-empty mailbox. - ; In the case of unique identifiers, it is the - ; unique identifier of the last message in the - ; mailbox or, if the mailbox is empty, the - ; mailbox's current UIDNEXT value. - ; The server should respond with a tagged BAD - ; response to a command that uses a message - ; sequence number greater than the number of - ; messages in the selected mailbox. This - ; includes "*" if the selected mailbox is empty. - -seq-range = seq-number ":" seq-number - ; two seq-number values and all values between - ; these two regardless of order. - ; Example: 2:4 and 4:2 are equivalent and indicate - ; values 2, 3, and 4. - ; Example: a unique identifier sequence range of - ; 3291:* includes the UID of the last message in - ; the mailbox, even if that value is less than 3291. - -sequence-set = (seq-number / seq-range) *("," sequence-set) - ; set of seq-number values, regardless of order. - ; Servers MAY coalesce overlaps and/or execute the - ; sequence in any order. - ; Example: a message sequence number set of - ; 2,4:7,9,12:* for a mailbox with 15 messages is - ; equivalent to 2,4,5,6,7,9,12,13,14,15 - ; Example: a message sequence number set of *:4,5:7 - ; for a mailbox with 10 messages is equivalent to - ; 10,9,8,7,6,5,4,5,6,7 and MAY be reordered and - ; overlap coalesced to be 4,5,6,7,8,9,10. - -status = "STATUS" SP mailbox SP - "(" status-att *(SP status-att) ")" - - - - -Crispin Standards Track [Page 90] - -RFC 3501 IMAPv4 March 2003 - - -status-att = "MESSAGES" / "RECENT" / "UIDNEXT" / "UIDVALIDITY" / - "UNSEEN" - -status-att-list = status-att SP number *(SP status-att SP number) - -store = "STORE" SP sequence-set SP store-att-flags - -store-att-flags = (["+" / "-"] "FLAGS" [".SILENT"]) SP - (flag-list / (flag *(SP flag))) - -string = quoted / literal - -subscribe = "SUBSCRIBE" SP mailbox - -tag = 1* - -text = 1*TEXT-CHAR - -TEXT-CHAR = - -time = 2DIGIT ":" 2DIGIT ":" 2DIGIT - ; Hours minutes seconds - -uid = "UID" SP (copy / fetch / search / store) - ; Unique identifiers used instead of message - ; sequence numbers - -uniqueid = nz-number - ; Strictly ascending - -unsubscribe = "UNSUBSCRIBE" SP mailbox - -userid = astring - -x-command = "X" atom - -zone = ("+" / "-") 4DIGIT - ; Signed four-digit value of hhmm representing - ; hours and minutes east of Greenwich (that is, - ; the amount that the given time differs from - ; Universal Time). Subtracting the timezone - ; from the given time will give the UT form. - ; The Universal Time zone is "+0000". - - - - - - - - -Crispin Standards Track [Page 91] - -RFC 3501 IMAPv4 March 2003 - - -10. Author's Note - - This document is a revision or rewrite of earlier documents, and - supercedes the protocol specification in those documents: RFC 2060, - RFC 1730, unpublished IMAP2bis.TXT document, RFC 1176, and RFC 1064. - -11. Security Considerations - - IMAP4rev1 protocol transactions, including electronic mail data, are - sent in the clear over the network unless protection from snooping is - negotiated. This can be accomplished either by the use of STARTTLS, - negotiated privacy protection in the AUTHENTICATE command, or some - other protection mechanism. - -11.1. STARTTLS Security Considerations - - The specification of the STARTTLS command and LOGINDISABLED - capability in this document replaces that in [IMAP-TLS]. [IMAP-TLS] - remains normative for the PLAIN [SASL] authenticator. - - IMAP client and server implementations MUST implement the - TLS_RSA_WITH_RC4_128_MD5 [TLS] cipher suite, and SHOULD implement the - TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA [TLS] cipher suite. This is - important as it assures that any two compliant implementations can be - configured to interoperate. All other cipher suites are OPTIONAL. - Note that this is a change from section 2.1 of [IMAP-TLS]. - - During the [TLS] negotiation, the client MUST check its understanding - of the server hostname against the server's identity as presented in - the server Certificate message, in order to prevent man-in-the-middle - attacks. If the match fails, the client SHOULD either ask for - explicit user confirmation, or terminate the connection and indicate - that the server's identity is suspect. Matching is performed - according to these rules: - - The client MUST use the server hostname it used to open the - connection as the value to compare against the server name - as expressed in the server certificate. The client MUST - NOT use any form of the server hostname derived from an - insecure remote source (e.g., insecure DNS lookup). CNAME - canonicalization is not done. - - If a subjectAltName extension of type dNSName is present in - the certificate, it SHOULD be used as the source of the - server's identity. - - Matching is case-insensitive. - - - - -Crispin Standards Track [Page 92] - -RFC 3501 IMAPv4 March 2003 - - - A "*" wildcard character MAY be used as the left-most name - component in the certificate. For example, *.example.com - would match a.example.com, foo.example.com, etc. but would - not match example.com. - - If the certificate contains multiple names (e.g., more than - one dNSName field), then a match with any one of the fields - is considered acceptable. - - Both the client and server MUST check the result of the STARTTLS - command and subsequent [TLS] negotiation to see whether acceptable - authentication or privacy was achieved. - -11.2. Other Security Considerations - - A server error message for an AUTHENTICATE command which fails due to - invalid credentials SHOULD NOT detail why the credentials are - invalid. - - Use of the LOGIN command sends passwords in the clear. This can be - avoided by using the AUTHENTICATE command with a [SASL] mechanism - that does not use plaintext passwords, by first negotiating - encryption via STARTTLS or some other protection mechanism. - - A server implementation MUST implement a configuration that, at the - time of authentication, requires: - (1) The STARTTLS command has been negotiated. - OR - (2) Some other mechanism that protects the session from password - snooping has been provided. - OR - (3) The following measures are in place: - (a) The LOGINDISABLED capability is advertised, and [SASL] - mechanisms (such as PLAIN) using plaintext passwords are NOT - advertised in the CAPABILITY list. - AND - (b) The LOGIN command returns an error even if the password is - correct. - AND - (c) The AUTHENTICATE command returns an error with all [SASL] - mechanisms that use plaintext passwords, even if the password - is correct. - - A server error message for a failing LOGIN command SHOULD NOT specify - that the user name, as opposed to the password, is invalid. - - A server SHOULD have mechanisms in place to limit or delay failed - AUTHENTICATE/LOGIN attempts. - - - -Crispin Standards Track [Page 93] - -RFC 3501 IMAPv4 March 2003 - - - Additional security considerations are discussed in the section - discussing the AUTHENTICATE and LOGIN commands. - -12. IANA Considerations - - IMAP4 capabilities are registered by publishing a standards track or - IESG approved experimental RFC. The registry is currently located - at: - - http://www.iana.org/assignments/imap4-capabilities - - As this specification revises the STARTTLS and LOGINDISABLED - extensions previously defined in [IMAP-TLS], the registry will be - updated accordingly. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Crispin Standards Track [Page 94] - -RFC 3501 IMAPv4 March 2003 - - -Appendices - -A. Normative References - - The following documents contain definitions or specifications that - are necessary to understand this document properly: - [ABNF] Crocker, D. and P. Overell, "Augmented BNF for - Syntax Specifications: ABNF", RFC 2234, - November 1997. - - [ANONYMOUS] Newman, C., "Anonymous SASL Mechanism", RFC - 2245, November 1997. - - [CHARSET] Freed, N. and J. Postel, "IANA Character Set - Registration Procedures", RFC 2978, October - 2000. - - [DIGEST-MD5] Leach, P. and C. Newman, "Using Digest - Authentication as a SASL Mechanism", RFC 2831, - May 2000. - - [DISPOSITION] Troost, R., Dorner, S. and K. Moore, - "Communicating Presentation Information in - Internet Messages: The Content-Disposition - Header", RFC 2183, August 1997. - - [IMAP-TLS] Newman, C., "Using TLS with IMAP, POP3 and - ACAP", RFC 2595, June 1999. - - [KEYWORDS] Bradner, S., "Key words for use in RFCs to - Indicate Requirement Levels", BCP 14, RFC 2119, - March 1997. - - [LANGUAGE-TAGS] Alvestrand, H., "Tags for the Identification of - Languages", BCP 47, RFC 3066, January 2001. - - [LOCATION] Palme, J., Hopmann, A. and N. Shelness, "MIME - Encapsulation of Aggregate Documents, such as - HTML (MHTML)", RFC 2557, March 1999. - - [MD5] Myers, J. and M. Rose, "The Content-MD5 Header - Field", RFC 1864, October 1995. - - - - - - - - - -Crispin Standards Track [Page 95] - -RFC 3501 IMAPv4 March 2003 - - - [MIME-HDRS] Moore, K., "MIME (Multipurpose Internet Mail - Extensions) Part Three: Message Header - Extensions for Non-ASCII Text", RFC 2047, - November 1996. - - [MIME-IMB] Freed, N. and N. Borenstein, "MIME - (Multipurpose Internet Mail Extensions) Part - One: Format of Internet Message Bodies", RFC - 2045, November 1996. - - [MIME-IMT] Freed, N. and N. Borenstein, "MIME - (Multipurpose Internet Mail Extensions) Part - Two: Media Types", RFC 2046, November 1996. - - [RFC-2822] Resnick, P., "Internet Message Format", RFC - 2822, April 2001. - - [SASL] Myers, J., "Simple Authentication and Security - Layer (SASL)", RFC 2222, October 1997. - - [TLS] Dierks, T. and C. Allen, "The TLS Protocol - Version 1.0", RFC 2246, January 1999. - - [UTF-7] Goldsmith, D. and M. Davis, "UTF-7: A Mail-Safe - Transformation Format of Unicode", RFC 2152, - May 1997. - - The following documents describe quality-of-implementation issues - that should be carefully considered when implementing this protocol: - - [IMAP-IMPLEMENTATION] Leiba, B., "IMAP Implementation - Recommendations", RFC 2683, September 1999. - - [IMAP-MULTIACCESS] Gahrns, M., "IMAP4 Multi-Accessed Mailbox - Practice", RFC 2180, July 1997. - -A.1 Informative References - - The following documents describe related protocols: - - [IMAP-DISC] Austein, R., "Synchronization Operations for - Disconnected IMAP4 Clients", Work in Progress. - - [IMAP-MODEL] Crispin, M., "Distributed Electronic Mail - Models in IMAP4", RFC 1733, December 1994. - - - - - - -Crispin Standards Track [Page 96] - -RFC 3501 IMAPv4 March 2003 - - - [ACAP] Newman, C. and J. Myers, "ACAP -- Application - Configuration Access Protocol", RFC 2244, - November 1997. - - [SMTP] Klensin, J., "Simple Mail Transfer Protocol", - STD 10, RFC 2821, April 2001. - - The following documents are historical or describe historical aspects - of this protocol: - - [IMAP-COMPAT] Crispin, M., "IMAP4 Compatibility with - IMAP2bis", RFC 2061, December 1996. - - [IMAP-HISTORICAL] Crispin, M., "IMAP4 Compatibility with IMAP2 - and IMAP2bis", RFC 1732, December 1994. - - [IMAP-OBSOLETE] Crispin, M., "Internet Message Access Protocol - - Obsolete Syntax", RFC 2062, December 1996. - - [IMAP2] Crispin, M., "Interactive Mail Access Protocol - - Version 2", RFC 1176, August 1990. - - [RFC-822] Crocker, D., "Standard for the Format of ARPA - Internet Text Messages", STD 11, RFC 822, - August 1982. - - [RFC-821] Postel, J., "Simple Mail Transfer Protocol", - STD 10, RFC 821, August 1982. - -B. Changes from RFC 2060 - - 1) Clarify description of unique identifiers and their semantics. - - 2) Fix the SELECT description to clarify that UIDVALIDITY is required - in the SELECT and EXAMINE responses. - - 3) Added an example of a failing search. - - 4) Correct store-att-flags: "#flag" should be "1#flag". - - 5) Made search and section rules clearer. - - 6) Correct the STORE example. - - 7) Correct "BASE645" misspelling. - - 8) Remove extraneous close parenthesis in example of two-part message - with text and BASE64 attachment. - - - -Crispin Standards Track [Page 97] - -RFC 3501 IMAPv4 March 2003 - - - 9) Remove obsolete "MAILBOX" response from mailbox-data. - - 10) A spurious "<" in the rule for mailbox-data was removed. - - 11) Add CRLF to continue-req. - - 12) Specifically exclude "]" from the atom in resp-text-code. - - 13) Clarify that clients and servers should adhere strictly to the - protocol syntax. - - 14) Emphasize in 5.2 that EXISTS can not be used to shrink a mailbox. - - 15) Add NEWNAME to resp-text-code. - - 16) Clarify that the empty string, not NIL, is used as arguments to - LIST. - - 17) Clarify that NIL can be returned as a hierarchy delimiter for the - empty string mailbox name argument if the mailbox namespace is flat. - - 18) Clarify that addr-mailbox and addr-name have RFC-2822 quoting - removed. - - 19) Update UTF-7 reference. - - 20) Fix example in 6.3.11. - - 21) Clarify that non-existent UIDs are ignored. - - 22) Update DISPOSITION reference. - - 23) Expand state diagram. - - 24) Clarify that partial fetch responses are only returned in - response to a partial fetch command. - - 25) Add UIDNEXT response code. Correct UIDVALIDITY definition - reference. - - 26) Further clarification of "can" vs. "MAY". - - 27) Reference RFC-2119. - - 28) Clarify that superfluous shifts are not permitted in modified - UTF-7. - - 29) Clarify that there are no implicit shifts in modified UTF-7. - - - -Crispin Standards Track [Page 98] - -RFC 3501 IMAPv4 March 2003 - - - 30) Clarify that "INBOX" in a mailbox name is always INBOX, even if - it is given as a string. - - 31) Add missing open parenthesis in media-basic grammar rule. - - 32) Correct attribute syntax in mailbox-data. - - 33) Add UIDNEXT to EXAMINE responses. - - 34) Clarify UNSEEN, PERMANENTFLAGS, UIDVALIDITY, and UIDNEXT - responses in SELECT and EXAMINE. They are required now, but weren't - in older versions. - - 35) Update references with RFC numbers. - - 36) Flush text-mime2. - - 37) Clarify that modified UTF-7 names must be case-sensitive and that - violating the convention should be avoided. - - 38) Correct UID FETCH example. - - 39) Clarify UID FETCH, UID STORE, and UID SEARCH vs. untagged EXPUNGE - responses. - - 40) Clarify the use of the word "convention". - - 41) Clarify that a command is not "in progress" until it has been - fully received (specifically, that a command is not "in progress" - during command continuation negotiation). - - 42) Clarify envelope defaulting. - - 43) Clarify that SP means one and only one space character. - - 44) Forbid silly states in LIST response. - - 45) Clarify that the ENVELOPE, INTERNALDATE, RFC822*, BODY*, and UID - for a message is static. - - 46) Add BADCHARSET response code. - - 47) Update formal syntax to [ABNF] conventions. - - 48) Clarify trailing hierarchy delimiter in CREATE semantics. - - 49) Clarify that the "blank line" is the [RFC-2822] delimiting blank - line. - - - -Crispin Standards Track [Page 99] - -RFC 3501 IMAPv4 March 2003 - - - 50) Clarify that RENAME should also create hierarchy as needed for - the command to complete. - - 51) Fix body-ext-mpart to not require language if disposition - present. - - 52) Clarify the RFC822.HEADER response. - - 53) Correct missing space after charset astring in search. - - 54) Correct missing quote for BADCHARSET in resp-text-code. - - 55) Clarify that ALL, FAST, and FULL preclude any other data items - appearing. - - 56) Clarify semantics of reference argument in LIST. - - 57) Clarify that a null string for SEARCH HEADER X-FOO means any - message with a header line with a field-name of X-FOO regardless of - the text of the header. - - 58) Specifically reserve 8-bit mailbox names for future use as UTF-8. - - 59) It is not an error for the client to store a flag that is not in - the PERMANENTFLAGS list; however, the server will either ignore the - change or make the change in the session only. - - 60) Correct/clarify the text regarding superfluous shifts. - - 61) Correct typographic errors in the "Changes" section. - - 62) Clarify that STATUS must not be used to check for new messages in - the selected mailbox - - 63) Clarify LSUB behavior with "%" wildcard. - - 64) Change AUTHORIZATION to AUTHENTICATE in section 7.5. - - 65) Clarify description of multipart body type. - - 66) Clarify that STORE FLAGS does not affect \Recent. - - 67) Change "west" to "east" in description of timezone. - - 68) Clarify that commands which break command pipelining must wait - for a completion result response. - - 69) Clarify that EXAMINE does not affect \Recent. - - - -Crispin Standards Track [Page 100] - -RFC 3501 IMAPv4 March 2003 - - - 70) Make description of MIME structure consistent. - - 71) Clarify that date searches disregard the time and timezone of the - INTERNALDATE or Date: header. In other words, "ON 13-APR-2000" means - messages with an INTERNALDATE text which starts with "13-APR-2000", - even if timezone differential from the local timezone is sufficient - to move that INTERNALDATE into the previous or next day. - - 72) Clarify that the header fetches don't add a blank line if one - isn't in the [RFC-2822] message. - - 73) Clarify (in discussion of UIDs) that messages are immutable. - - 74) Add an example of CHARSET searching. - - 75) Clarify in SEARCH that keywords are a type of flag. - - 76) Clarify the mandatory nature of the SELECT data responses. - - 77) Add optional CAPABILITY response code in the initial OK or - PREAUTH. - - 78) Add note that server can send an untagged CAPABILITY command as - part of the responses to AUTHENTICATE and LOGIN. - - 79) Remove statement about it being unnecessary to issue a CAPABILITY - command more than once in a connection. That statement is no longer - true. - - 80) Clarify that untagged EXPUNGE decrements the number of messages - in the mailbox. - - 81) Fix definition of "body" (concatenation has tighter binding than - alternation). - - 82) Add a new "Special Notes to Implementors" section with reference - to [IMAP-IMPLEMENTATION]. - - 83) Clarify that an untagged CAPABILITY response to an AUTHENTICATE - command should only be done if a security layer was not negotiated. - - 84) Change the definition of atom to exclude "]". Update astring to - include "]" for compatibility with the past. Remove resp-text-atom. - - 85) Remove NEWNAME. It can't work because mailbox names can be - literals and can include "]". Functionality can be addressed via - referrals. - - - - -Crispin Standards Track [Page 101] - -RFC 3501 IMAPv4 March 2003 - - - 86) Move modified UTF-7 rationale in order to have more logical - paragraph flow. - - 87) Clarify UID uniqueness guarantees with the use of MUST. - - 88) Note that clients should read response data until the connection - is closed instead of immediately closing on a BYE. - - 89) Change RFC-822 references to RFC-2822. - - 90) Clarify that RFC-2822 should be followed instead of RFC-822. - - 91) Change recommendation of optional automatic capabilities in LOGIN - and AUTHENTICATE to use the CAPABILITY response code in the tagged - OK. This is more interoperable than an unsolicited untagged - CAPABILITY response. - - 92) STARTTLS and AUTH=PLAIN are mandatory to implement; add - recommendations for other [SASL] mechanisms. - - 93) Clarify that a "connection" (as opposed to "server" or "command") - is in one of the four states. - - 94) Clarify that a failed or rejected command does not change state. - - 95) Split references between normative and informative. - - 96) Discuss authentication failure issues in security section. - - 97) Clarify that a data item is not necessarily of only one data - type. - - 98) Clarify that sequence ranges are independent of order. - - 99) Change an example to clarify that superfluous shifts in - Modified-UTF7 can not be fixed just by omitting the shift. The - entire string must be recalculated. - - 100) Change Envelope Structure definition since [RFC-2822] uses - "envelope" to refer to the [SMTP] envelope and not the envelope data - that appears in the [RFC-2822] header. - - 101) Expand on RFC822.HEADER response data vs. BODY[HEADER]. - - 102) Clarify Logout state semantics, change ASCII art. - - 103) Security changes to comply with IESG requirements. - - - - -Crispin Standards Track [Page 102] - -RFC 3501 IMAPv4 March 2003 - - - 104) Add definition for body URI. - - 105) Break sequence range definition into three rules, with rewritten - descriptions for each. - - 106) Move STARTTLS and LOGINDISABLED here from [IMAP-TLS]. - - 107) Add IANA Considerations section. - - 108) Clarify valid client assumptions for new message UIDs vs. - UIDNEXT. - - 109) Clarify that changes to permanentflags affect concurrent - sessions as well as subsequent sessions. - - 110) Clarify that authenticated state can be entered by the CLOSE - command. - - 111) Emphasize that SELECT and EXAMINE are the exceptions to the rule - that a failing command does not change state. - - 112) Clarify that newly-appended messages have the Recent flag set. - - 113) Clarify that newly-copied messages SHOULD have the Recent flag - set. - - 114) Clarify that UID commands always return the UID in FETCH - responses. - -C. Key Word Index - - +FLAGS (store command data item) ............... 59 - +FLAGS.SILENT (store command data item) ........ 59 - -FLAGS (store command data item) ............... 59 - -FLAGS.SILENT (store command data item) ........ 59 - ALERT (response code) ...................................... 64 - ALL (fetch item) ........................................... 55 - ALL (search key) ........................................... 50 - ANSWERED (search key) ...................................... 50 - APPEND (command) ........................................... 45 - AUTHENTICATE (command) ..................................... 27 - BAD (response) ............................................. 66 - BADCHARSET (response code) ................................. 64 - BCC (search key) .................................. 51 - BEFORE (search key) ................................. 51 - BODY (fetch item) .......................................... 55 - BODY (fetch result) ........................................ 73 - BODY (search key) ................................. 51 - - - -Crispin Standards Track [Page 103] - -RFC 3501 IMAPv4 March 2003 - - - BODY.PEEK[

]<> (fetch item) ............... 57 - BODYSTRUCTURE (fetch item) ................................. 57 - BODYSTRUCTURE (fetch result) ............................... 74 - BODY[

]<> (fetch result) ............. 74 - BODY[

]<> (fetch item) .................... 55 - BYE (response) ............................................. 67 - Body Structure (message attribute) ......................... 12 - CAPABILITY (command) ....................................... 24 - CAPABILITY (response code) ................................. 64 - CAPABILITY (response) ...................................... 68 - CC (search key) ................................... 51 - CHECK (command) ............................................ 47 - CLOSE (command) ............................................ 48 - COPY (command) ............................................. 59 - CREATE (command) ........................................... 34 - DELETE (command) ........................................... 35 - DELETED (search key) ....................................... 51 - DRAFT (search key) ......................................... 51 - ENVELOPE (fetch item) ...................................... 57 - ENVELOPE (fetch result) .................................... 77 - EXAMINE (command) .......................................... 33 - EXISTS (response) .......................................... 71 - EXPUNGE (command) .......................................... 48 - EXPUNGE (response) ......................................... 72 - Envelope Structure (message attribute) ..................... 12 - FAST (fetch item) .......................................... 55 - FETCH (command) ............................................ 54 - FETCH (response) ........................................... 73 - FLAGGED (search key) ....................................... 51 - FLAGS (fetch item) ......................................... 57 - FLAGS (fetch result) ....................................... 78 - FLAGS (response) ........................................... 71 - FLAGS (store command data item) ................ 59 - FLAGS.SILENT (store command data item) ......... 59 - FROM (search key) ................................. 51 - FULL (fetch item) .......................................... 55 - Flags (message attribute) .................................. 11 - HEADER (part specifier) .................................... 55 - HEADER (search key) .................. 51 - HEADER.FIELDS (part specifier) ............... 55 - HEADER.FIELDS.NOT (part specifier) ........... 55 - INTERNALDATE (fetch item) .................................. 57 - INTERNALDATE (fetch result) ................................ 78 - Internal Date (message attribute) .......................... 12 - KEYWORD (search key) ................................ 51 - Keyword (type of flag) ..................................... 11 - LARGER (search key) .................................... 51 - LIST (command) ............................................. 40 - - - -Crispin Standards Track [Page 104] - -RFC 3501 IMAPv4 March 2003 - - - LIST (response) ............................................ 69 - LOGIN (command) ............................................ 30 - LOGOUT (command) ........................................... 25 - LSUB (command) ............................................. 43 - LSUB (response) ............................................ 70 - MAY (specification requirement term) ....................... 4 - MESSAGES (status item) ..................................... 45 - MIME (part specifier) ...................................... 56 - MUST (specification requirement term) ...................... 4 - MUST NOT (specification requirement term) .................. 4 - Message Sequence Number (message attribute) ................ 10 - NEW (search key) ........................................... 51 - NO (response) .............................................. 66 - NOOP (command) ............................................. 25 - NOT (search key) .............................. 52 - OK (response) .............................................. 65 - OLD (search key) ........................................... 52 - ON (search key) ..................................... 52 - OPTIONAL (specification requirement term) .................. 4 - OR

(search key) ................ 52 - PARSE (response code) ...................................... 64 - PERMANENTFLAGS (response code) ............................. 64 - PREAUTH (response) ......................................... 67 - Permanent Flag (class of flag) ............................. 12 - READ-ONLY (response code) .................................. 65 - READ-WRITE (response code) ................................. 65 - RECENT (response) .......................................... 72 - RECENT (search key) ........................................ 52 - RECENT (status item) ....................................... 45 - RENAME (command) ........................................... 37 - REQUIRED (specification requirement term) .................. 4 - RFC822 (fetch item) ........................................ 57 - RFC822 (fetch result) ...................................... 78 - RFC822.HEADER (fetch item) ................................. 57 - RFC822.HEADER (fetch result) ............................... 78 - RFC822.SIZE (fetch item) ................................... 57 - RFC822.SIZE (fetch result) ................................. 78 - RFC822.TEXT (fetch item) ................................... 58 - RFC822.TEXT (fetch result) ................................. 79 - SEARCH (command) ........................................... 49 - SEARCH (response) .......................................... 71 - SEEN (search key) .......................................... 52 - SELECT (command) ........................................... 31 - SENTBEFORE (search key) ............................. 52 - SENTON (search key) ................................. 52 - SENTSINCE (search key) .............................. 52 - SHOULD (specification requirement term) .................... 4 - SHOULD NOT (specification requirement term) ................ 4 - - - -Crispin Standards Track [Page 105] - -RFC 3501 IMAPv4 March 2003 - - - SINCE (search key) .................................. 52 - SMALLER (search key) ................................... 52 - STARTTLS (command) ......................................... 27 - STATUS (command) ........................................... 44 - STATUS (response) .......................................... 70 - STORE (command) ............................................ 58 - SUBJECT (search key) .............................. 53 - SUBSCRIBE (command) ........................................ 38 - Session Flag (class of flag) ............................... 12 - System Flag (type of flag) ................................. 11 - TEXT (part specifier) ...................................... 56 - TEXT (search key) ................................. 53 - TO (search key) ................................... 53 - TRYCREATE (response code) .................................. 65 - UID (command) .............................................. 60 - UID (fetch item) ........................................... 58 - UID (fetch result) ......................................... 79 - UID (search key) ............................ 53 - UIDNEXT (response code) .................................... 65 - UIDNEXT (status item) ...................................... 45 - UIDVALIDITY (response code) ................................ 65 - UIDVALIDITY (status item) .................................. 45 - UNANSWERED (search key) .................................... 53 - UNDELETED (search key) ..................................... 53 - UNDRAFT (search key) ....................................... 53 - UNFLAGGED (search key) ..................................... 53 - UNKEYWORD (search key) .............................. 53 - UNSEEN (response code) ..................................... 65 - UNSEEN (search key) ........................................ 53 - UNSEEN (status item) ....................................... 45 - UNSUBSCRIBE (command) ...................................... 39 - Unique Identifier (UID) (message attribute) ................ 8 - X (command) .......................................... 62 - [RFC-2822] Size (message attribute) ........................ 12 - \Answered (system flag) .................................... 11 - \Deleted (system flag) ..................................... 11 - \Draft (system flag) ....................................... 11 - \Flagged (system flag) ..................................... 11 - \Marked (mailbox name attribute) ........................... 69 - \Noinferiors (mailbox name attribute) ...................... 69 - \Noselect (mailbox name attribute) ......................... 69 - \Recent (system flag) ...................................... 11 - \Seen (system flag) ........................................ 11 - \Unmarked (mailbox name attribute) ......................... 69 - - - - - - - -Crispin Standards Track [Page 106] - -RFC 3501 IMAPv4 March 2003 - - -Author's Address - - Mark R. Crispin - Networks and Distributed Computing - University of Washington - 4545 15th Avenue NE - Seattle, WA 98105-4527 - - Phone: (206) 543-5762 - - EMail: MRC@CAC.Washington.EDU - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Crispin Standards Track [Page 107] - -RFC 3501 IMAPv4 March 2003 - - -Full Copyright Statement - - Copyright (C) The Internet Society (2003). All Rights Reserved. - - This document and translations of it may be copied and furnished to - others, and derivative works that comment on or otherwise explain it - or assist in its implementation may be prepared, copied, published - and distributed, in whole or in part, without restriction of any - kind, provided that the above copyright notice and this paragraph are - included on all such copies and derivative works. However, this - document itself may not be modified in any way, such as by removing - the copyright notice or references to the Internet Society or other - Internet organizations, except as needed for the purpose of - developing Internet standards in which case the procedures for - copyrights defined in the Internet Standards process must be - followed, or as required to translate it into languages other than - English. - - The limited permissions granted above are perpetual and will not be - revoked by the Internet Society or its successors or assigns. v This - document and the information contained herein is provided on an "AS - IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK - FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT - LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL - NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY - OR FITNESS FOR A PARTICULAR PURPOSE. - -Acknowledgement - - Funding for the RFC Editor function is currently provided by the - Internet Society. - - - - - - - - - - - - - - - - - - - - -Crispin Standards Track [Page 108] - blob - d6deaa891af6683fe538686b11058b003efe4e41 (mode 644) blob + /dev/null --- doc/src/rfc5804.txt +++ /dev/null @@ -1,2747 +0,0 @@ - - - - - - -Internet Engineering Task Force (IETF) A. Melnikov, Ed. -Request for Comments: 5804 Isode Limited -Category: Standards Track T. Martin -ISSN: 2070-1721 BeThereBeSquare, Inc. - July 2010 - - - A Protocol for Remotely Managing Sieve Scripts - -Abstract - - Sieve scripts allow users to filter incoming email. Message stores - are commonly sealed servers so users cannot log into them, yet users - must be able to update their scripts on them. This document - describes a protocol "ManageSieve" for securely managing Sieve - scripts on a remote server. This protocol allows a user to have - multiple scripts, and also alerts a user to syntactically flawed - scripts. - -Status of This Memo - - This is an Internet Standards Track document. - - This document is a product of the Internet Engineering Task Force - (IETF). It represents the consensus of the IETF community. It has - received public review and has been approved for publication by the - Internet Engineering Steering Group (IESG). Further information on - Internet Standards is available in Section 2 of RFC 5741. - - Information about the current status of this document, any errata, - and how to provide feedback on it may be obtained at - http://www.rfc-editor.org/info/rfc5804. - -Copyright Notice - - Copyright (c) 2010 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. - - - - -Melnikov & Martin Standards Track [Page 1] - -RFC 5804 ManageSieve July 2010 - - -Table of Contents - - 1. Introduction ....................................................3 - 1.1. Commands and Responses .....................................3 - 1.2. Syntax .....................................................3 - 1.3. Response Codes .............................................3 - 1.4. Active Script ..............................................6 - 1.5. Quotas .....................................................6 - 1.6. Script Names ...............................................6 - 1.7. Capabilities ...............................................7 - 1.8. Transport ..................................................9 - 1.9. Conventions Used in This Document .........................10 - 2. Commands .......................................................10 - 2.1. AUTHENTICATE Command ......................................11 - 2.1.1. Use of SASL PLAIN Mechanism over TLS ...............16 - 2.2. STARTTLS Command ..........................................16 - 2.2.1. Server Identity Check ..............................17 - 2.3. LOGOUT Command ............................................20 - 2.4. CAPABILITY Command ........................................20 - 2.5. HAVESPACE Command .........................................20 - 2.6. PUTSCRIPT Command .........................................21 - 2.7. LISTSCRIPTS Command .......................................23 - 2.8. SETACTIVE Command .........................................24 - 2.9. GETSCRIPT Command .........................................25 - 2.10. DELETESCRIPT Command .....................................25 - 2.11. RENAMESCRIPT Command .....................................26 - 2.12. CHECKSCRIPT Command ......................................27 - 2.13. NOOP Command .............................................28 - 2.14. Recommended Extensions ...................................28 - 2.14.1. UNAUTHENTICATE Command ............................28 - 3. Sieve URL Scheme ...............................................29 - 4. Formal Syntax ..................................................31 - 5. Security Considerations ........................................37 - 6. IANA Considerations ............................................38 - 6.1. ManageSieve Capability Registration Template ..............39 - 6.2. Registration of Initial ManageSieve Capabilities ..........39 - 6.3. ManageSieve Response Code Registration Template ...........41 - 6.4. Registration of Initial ManageSieve Response Codes ........41 - 7. Internationalization Considerations ............................46 - 8. Acknowledgements ...............................................46 - 9. References .....................................................47 - 9.1. Normative References ......................................47 - 9.2. Informative References ....................................48 - - - - - - - - -Melnikov & Martin Standards Track [Page 2] - -RFC 5804 ManageSieve July 2010 - - -1. Introduction - -1.1. Commands and Responses - - A ManageSieve connection consists of the establishment of a client/ - server network connection, an initial greeting from the server, and - client/server interactions. These client/server interactions consist - of a client command, server data, and a server completion result - response. - - All interactions transmitted by client and server are in the form of - lines, that is, strings that end with a CRLF. The protocol receiver - of a ManageSieve client or server is either reading a line or reading - a sequence of octets with a known count followed by a line. - -1.2. Syntax - - ManageSieve is a line-oriented protocol much like [IMAP] or [ACAP], - which runs over TCP. There are three data types: atoms, numbers and - strings. Strings may be quoted or literal. See [ACAP] for detailed - descriptions of these types. - - Each command consists of an atom (the command name) followed by zero - or more strings and numbers terminated by CRLF. - - All client queries are replied to with either an OK, NO, or BYE - response. Each response may be followed by a response code (see - Section 1.3) and by a string consisting of human-readable text in the - local language (as returned by the LANGUAGE capability; see - Section 1.7), encoded in UTF-8 [UTF-8]. The contents of the string - SHOULD be shown to the user ,and implementations MUST NOT attempt to - parse the message for meaning. - - The BYE response SHOULD be used if the server wishes to close the - connection. A server may wish to do this because the client was idle - for too long or there were too many failed authentication attempts. - This response can be issued at any time and should be immediately - followed by a server hang-up of the connection. If a server has an - inactivity timeout resulting in client autologout, it MUST be no less - than 30 minutes after successful authentication. The inactivity - timeout MAY be less before authentication. - -1.3. Response Codes - - An OK, NO, or BYE response from the server MAY contain a response - code to describe the event in a more detailed machine-parsable - fashion. A response code consists of data inside parentheses in the - form of an atom, possibly followed by a space and arguments. - - - -Melnikov & Martin Standards Track [Page 3] - -RFC 5804 ManageSieve July 2010 - - - Response codes are defined when there is a specific action that a - client can take based upon the additional information. In order to - support future extension, the response code is represented as a - slash-separated (Solidus, %x2F) hierarchy with each level of - hierarchy representing increasing detail about the error. Response - codes MUST NOT start with the Solidus character. Clients MUST - tolerate additional hierarchical response code detail that they don't - understand. For example, if the client supports the "QUOTA" response - code, but doesn't understand the "QUOTA/MAXSCRIPTS" response code, it - should treat "QUOTA/MAXSCRIPTS" as "QUOTA". - - Client implementations MUST tolerate (ignore) response codes that - they do not recognize. - - The currently defined response codes are the following: - - AUTH-TOO-WEAK - - This response code is returned in the NO or BYE response from an - AUTHENTICATE command. It indicates that site security policy forbids - the use of the requested mechanism for the specified authentication - identity. - - ENCRYPT-NEEDED - - This response code is returned in the NO or BYE response from an - AUTHENTICATE command. It indicates that site security policy - requires the use of a strong encryption mechanism for the specified - authentication identity and mechanism. - - QUOTA - - If this response code is returned in the NO/BYE response, it means - that the command would have placed the user above the site-defined - quota constraints. If this response code is returned in the OK - response, it can mean that the user's storage is near its quota, or - it can mean that the account exceeded its quota but that the - condition is being allowed by the server (the server supports - so-called soft quotas). The QUOTA response code has two more - detailed variants: "QUOTA/MAXSCRIPTS" (the maximum number of per-user - scripts) and "QUOTA/MAXSIZE" (the maximum script size). - - REFERRAL - - This response code may be returned with a BYE result from any - command, and includes a mandatory parameter that indicates what - server to access to manage this user's Sieve scripts. The server - will be specified by a Sieve URL (see Section 3). The scriptname - - - -Melnikov & Martin Standards Track [Page 4] - -RFC 5804 ManageSieve July 2010 - - - portion of the URL MUST NOT be specified. The client should - authenticate to the specified server and use it for all further - commands in the current session. - - SASL - - This response code can occur in the OK response to a successful - AUTHENTICATE command and includes the optional final server response - data from the server as specified by [SASL]. - - TRANSITION-NEEDED - - This response code occurs in a NO response of an AUTHENTICATE - command. It indicates that the user name is valid, but the entry in - the authentication database needs to be updated in order to permit - authentication with the specified mechanism. This is typically done - by establishing a secure channel using TLS, verifying server identity - as specified in Section 2.2.1, and finally authenticating once using - the [PLAIN] authentication mechanism. The selected mechanism SHOULD - then work for authentications in subsequent sessions. - - This condition can happen if a user has an entry in a system - authentication database such as Unix /etc/passwd, but does not have - credentials suitable for use by the specified mechanism. - - TRYLATER - - A command failed due to a temporary server failure. The client MAY - continue using local information and try the command later. This - response code only makes sense when returned in a NO/BYE response. - - ACTIVE - - A command failed because it is not allowed on the active script, for - example, DELETESCRIPT on the active script. This response code only - makes sense when returned in a NO/BYE response. - - NONEXISTENT - - A command failed because the referenced script name doesn't exist. - This response code only makes sense when returned in a NO/BYE - response. - - ALREADYEXISTS - - A command failed because the referenced script name already exists. - This response code only makes sense when returned in a NO/BYE - response. - - - -Melnikov & Martin Standards Track [Page 5] - -RFC 5804 ManageSieve July 2010 - - - TAG - - This response code name is followed by a string specified in the - command. See Section 2.13 for a possible use case. - - WARNINGS - - This response code MAY be returned by the server in the OK response - (but it might be returned with the NO/BYE response as well) and - signals the client that even though the script is syntactically - valid, it might contain errors not intended by the script writer. - This response code is typically returned in response to PUTSCRIPT - and/or CHECKSCRIPT commands. A client seeing such response code - SHOULD present the returned warning text to the user. - -1.4. Active Script - - A user may have multiple Sieve scripts on the server, yet only one - script may be used for filtering of incoming messages. This is the - active script. Users may have zero or one active script and MUST use - the SETACTIVE command described below for changing the active script - or disabling Sieve processing. For example, users may have an - everyday script they normally use and a special script they use when - they go on vacation. Users can change which script is being used - without having to download and upload a script stored somewhere else. - -1.5. Quotas - - Servers SHOULD impose quotas to prevent malicious users from - overflowing available storage. If a command would place a user over - a quota setting, servers that impose such quotas MUST reply with a NO - response containing the QUOTA response code. Client implementations - MUST be able to handle commands failing because of quota - restrictions. - -1.6. Script Names - - A Sieve script name is a sequence of Unicode characters encoded in - UTF-8 [UTF-8]. A script name MUST comply with Net-Unicode Definition - (Section 2 of [NET-UNICODE]), with the additional restriction of - prohibiting the following Unicode characters: - - o 0000-001F; [CONTROL CHARACTERS] - - o 007F; DELETE - - o 0080-009F; [CONTROL CHARACTERS] - - - - -Melnikov & Martin Standards Track [Page 6] - -RFC 5804 ManageSieve July 2010 - - - o 2028; LINE SEPARATOR - - o 2029; PARAGRAPH SEPARATOR - - Sieve script names MUST be at least one octet (and hence Unicode - character) long. Zero octets script name has a special meaning (see - Section 2.8). Servers MUST allow names of up to 128 Unicode - characters in length (which can take up to 512 bytes when encoded in - UTF-8, not counting the terminating NUL), and MAY allow longer names. - A server that receives a script name longer than its internal limit - MUST reject the corresponding operation, in particular it MUST NOT - truncate the script name. - -1.7. Capabilities - - Server capabilities are sent automatically by the server upon a - client connection, or after successful STARTTLS and AUTHENTICATE - (which establishes a Simple Authentication and Security Layer (SASL)) - commands. Capabilities may change immediately after a successfully - completed STARTTLS command, and/or immediately after a successfully - completed AUTHENTICATE command, and/or after a successfully completed - UNAUTHENTICATE command (see Section 2.14.1). Capabilities MUST - remain static at all other times. - - Clients MAY request the capabilities at a later time by issuing the - CAPABILITY command described later. The capabilities consist of a - series of lines each with one or two strings. The first string is - the name of the capability, which is case-insensitive. The second - optional string is the value associated with that capability. Order - of capabilities is arbitrary, but each capability name can appear at - most once. - - The following capabilities are defined in this document: - - IMPLEMENTATION - Name of implementation and version. This capability - MUST always be returned by the server. - - SASL - List of SASL mechanisms supported by the server, each - separated by a space. This list can be empty if and only if STARTTLS - is also advertised. This means that the client must negotiate TLS - encryption with STARTTLS first, at which point the SASL capability - will list a non-empty list of SASL mechanisms. - - SIEVE - List of space-separated Sieve extensions (as listed in Sieve - "require" action [SIEVE]) supported by the Sieve engine. This - capability MUST always be returned by the server. - - - - - -Melnikov & Martin Standards Track [Page 7] - -RFC 5804 ManageSieve July 2010 - - - STARTTLS - If TLS [TLS] is supported by this implementation. Before - advertising this capability a server MUST verify to the best of its - ability that TLS can be successfully negotiated by a client with - common cipher suites. Specifically, a server should verify that a - server certificate has been installed and that the TLS subsystem has - successfully initialized. This capability SHOULD NOT be advertised - once STARTTLS or AUTHENTICATE command completes successfully. Client - and server implementations MUST implement the STARTTLS extension. - - MAXREDIRECTS - Specifies the limit on the number of Sieve "redirect" - actions a script can perform during a single evaluation. Note that - this is different from the total number of "redirect" actions a - script can contain. The value is a non-negative number represented - as a ManageSieve string. - - NOTIFY - A space-separated list of URI schema parts for supported - notification methods. This capability MUST be specified if the Sieve - implementation supports the "enotify" extension [NOTIFY]. - - LANGUAGE - The language ( from [RFC5646]) currently - used for human-readable error messages. If this capability is not - returned, the "i-default" [RFC2277] language is assumed. Note that - the current language MAY be per-user configurable (i.e., it MAY - change after authentication). - - OWNER - The canonical name of the logged-in user (SASL "authorization - identity") encoded in UTF-8. This capability MUST NOT be returned in - unauthenticated state and SHOULD be returned once the AUTHENTICATE - command succeeds. - - VERSION - This capability MUST be returned by servers compliant with - this document or its successor. For servers compliant with this - document, the capability value is the string "1.0". Lack of this - capability means that the server predates this specification and thus - doesn't support the following commands: RENAMESCRIPT, CHECKSCRIPT, - and NOOP. - - Section 2.14 defines some additional ManageSieve extensions and their - respective capabilities. - - A server implementation MUST return SIEVE, IMPLEMENTATION, and - VERSION capabilities. - - A client implementation MUST ignore any listed capabilities that it - does not understand. - - - - - - -Melnikov & Martin Standards Track [Page 8] - -RFC 5804 ManageSieve July 2010 - - - Example: - - S: "IMPlemENTATION" "Example1 ManageSieved v001" - S: "SASl" "DIGEST-MD5 GSSAPI" - S: "SIeVE" "fileinto vacation" - S: "StaRTTLS" - S: "NOTIFY" "xmpp mailto" - S: "MAXREdIRECTS" "5" - S: "VERSION" "1.0" - S: OK - - After successful authentication, this might look like this: - - Example: - - S: "IMPlemENTATION" "Example1 ManageSieved v001" - S: "SASl" "DIGEST-MD5 GSSAPI" - S: "SIeVE" "fileinto vacation" - S: "NOTIFY" "xmpp mailto" - S: "OWNER" "alexey@example.com" - S: "MAXREdIRECTS" "5" - S: "VERSION" "1.0" - S: OK - -1.8. Transport - - The ManageSieve protocol assumes a reliable data stream such as that - provided by TCP. When TCP is used, a ManageSieve server typically - listens on port 4190. - - Before opening the TCP connection, the ManageSieve client first MUST - resolve the Domain Name System (DNS) hostname associated with the - receiving entity and determine the appropriate TCP port for - communication with the receiving entity. The process is as follows: - - 1. Attempt to resolve the hostname using a [DNS-SRV] Service of - "sieve" and a Proto of "tcp" for the target domain (e.g., - "example.net"), resulting in resource records such as - "_sieve._tcp.example.net.". The result of the SRV lookup, if - successful, will be one or more combinations of a port and - hostname; the ManageSieve client MUST resolve the returned - hostnames to IPv4/IPv6 addresses according to returned SRV record - weight. IP addresses from the first successfully resolved - hostname (with the corresponding port number returned by SRV - lookup) are used to connect to the server. If connection using - one of the IP addresses fails, the next resolved IP address is - - - - - -Melnikov & Martin Standards Track [Page 9] - -RFC 5804 ManageSieve July 2010 - - - used to connect. If connection to all resolved IP addresses - fails, then the resolution/connect is repeated for the next - hostname returned by SRV lookup. - - 2. If the SRV lookup fails, the fallback SHOULD be a normal IPv4 or - IPv6 address record resolution to determine the IP address, where - the port used is the default ManageSieve port of 4190. - -1.9. Conventions Used in This Document - - The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", - "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this - document are to be interpreted as described in [KEYWORDS]. - - In examples, "C:" and "S:" indicate lines sent by the client and - server respectively. Line breaks that do not start a new "C:" or - "S:" exist for editorial reasons. - - Examples of authentication in this document are using DIGEST-MD5 - [DIGEST-MD5] and GSSAPI [GSSAPI] SASL mechanisms. - -2. Commands - - This section and its subsections describe valid ManageSieve commands. - Upon initial connection to the server, the client's session is in - non-authenticated state. Prior to successful authentication, only - the AUTHENTICATE, CAPABILITY, STARTTLS, LOGOUT, and NOOP (see Section - 2.13) commands are valid. ManageSieve extensions MAY define other - commands that are valid in non-authenticated state. Servers MUST - reject all other commands with a NO response. Clients may pipeline - commands (send more than one command at a time without waiting for - completion of the first command). However, a group of commands sent - together MUST NOT have an AUTHENTICATE (*), a STARTTLS, or a - HAVESPACE command anywhere but the last command in the list. - - (*) - The only exception to this rule is when the AUTHENTICATE - command contains an initial response for a SASL mechanism that allows - clients to send data first, the mechanism is known to complete in one - round trip, and the mechanism doesn't negotiate a SASL security - layer. Two examples of such SASL mechanisms are PLAIN [PLAIN] and - EXTERNAL [SASL]. - - - - - - - - - - -Melnikov & Martin Standards Track [Page 10] - -RFC 5804 ManageSieve July 2010 - - -2.1. AUTHENTICATE Command - - Arguments: String - mechanism - String - initial data (optional) - - The AUTHENTICATE command indicates a SASL [SASL] authentication - mechanism to the server. If the server supports the requested - authentication mechanism, it performs an authentication protocol - exchange to identify and authenticate the user. Optionally, it also - negotiates a security layer for subsequent protocol interactions. If - the requested authentication mechanism is not supported, the server - rejects the AUTHENTICATE command by sending the NO response. - - The authentication protocol exchange consists of a series of server - challenges and client responses that are specific to the selected - authentication mechanism. A server challenge consists of a string - (quoted or literal) followed by a CRLF. The contents of the string - is a base-64 encoding [BASE64] of the SASL data. A client response - consists of a string (quoted or literal) with the base-64 encoding of - the SASL data followed by a CRLF. If the client wishes to cancel the - authentication exchange, it issues a string containing a single "*". - If the server receives such a response, it MUST reject the - AUTHENTICATE command by sending a NO reply. - - Note that an empty challenge/response is sent as an empty string. If - the mechanism dictates that the final response is sent by the server, - this data MAY be placed within the data portion of the SASL response - code to save a round trip. - - The optional initial-response argument to the AUTHENTICATE command is - used to save a round trip when using authentication mechanisms that - are defined to send no data in the initial challenge. When the - initial-response argument is used with such a mechanism, the initial - empty challenge is not sent to the client and the server uses the - data in the initial-response argument as if it were sent in response - to the empty challenge. If the initial-response argument to the - AUTHENTICATE command is used with a mechanism that sends data in the - initial challenge, the server MUST reject the AUTHENTICATE command by - sending the NO response. - - The service name specified by this protocol's profile of SASL is - "sieve". - - Reauthentication is not supported by ManageSieve protocol's profile - of SASL. That is, after a successfully completed AUTHENTICATE - command, no more AUTHENTICATE commands may be issued in the same - session. After a successful AUTHENTICATE command completes, a server - MUST reject any further AUTHENTICATE commands with a NO reply. - - - -Melnikov & Martin Standards Track [Page 11] - -RFC 5804 ManageSieve July 2010 - - - However, note that a server may implement the UNAUTHENTICATE - extension described in Section 2.14.1. - - If a security layer is negotiated through the SASL authentication - exchange, it takes effect immediately following the CRLF that - concludes the successful authentication exchange for the client, and - the CRLF of the OK response for the server. - - When a security layer takes effect, the ManageSieve protocol is reset - to the initial state (the state in ManageSieve after a client has - connected to the server). The server MUST discard any knowledge - obtained from the client that was not obtained from the SASL (or TLS) - negotiation itself. Likewise, the client MUST discard any knowledge - obtained from the server, such as the list of ManageSieve extensions, - that was not obtained from the SASL (and/or TLS) negotiation itself. - (Note that a client MAY compare the advertised SASL mechanisms before - and after authentication in order to detect an active down- - negotiation attack. See below.) - - Once a SASL security layer is established, the server MUST re-issue - the capability results, followed by an OK response. This is - necessary to protect against man-in-the-middle attacks that alter the - capabilities list prior to SASL negotiation. The capability results - MUST include all SASL mechanisms the server was capable of - negotiating with that client. This is done in order to allow the - client to detect an active down-negotiation attack. If a user- - oriented client detects such a down-negotiation attack, it SHOULD - either notify the user (it MAY give the user the opportunity to - continue with the ManageSieve session in this case) or close the - transport connection and indicate that a down-negotiation attack - might be in progress. If an automated client detects a down- - negotiation attack, it SHOULD return or log an error indicating that - a possible attack might be in progress and/or SHOULD close the - transport connection. - - When both [TLS] and SASL security layers are in effect, the TLS - encoding MUST be applied (when sending data) after the SASL encoding. - - Server implementations SHOULD support SASL proxy authentication so - that an administrator can administer a user's scripts. Proxy - authentication is when a user authenticates as herself/himself but - requests the server to act (authorize) as another user. - - The authorization identity generated by this [SASL] exchange is a - "simple username" (in the sense defined in [SASLprep]), and both - client and server MUST use the [SASLprep] profile of the [StringPrep] - algorithm to prepare these names for transmission or comparison. If - preparation of the authorization identity fails or results in an - - - -Melnikov & Martin Standards Track [Page 12] - -RFC 5804 ManageSieve July 2010 - - - empty string (unless it was transmitted as the empty string), the - server MUST fail the authentication. - - If an AUTHENTICATE command fails with a NO response, the client MAY - try another authentication mechanism by issuing another AUTHENTICATE - command. In other words, the client may request authentication types - in decreasing order of preference. - - Note that a failed (NO) response to the AUTHENTICATE command may - contain one of the following response codes: AUTH-TOO-WEAK, ENCRYPT- - NEEDED, or TRANSITION-NEEDED. See Section 1.3 for detailed - description of the relevant conditions. - - To ensure interoperability, both client and server implementations of - the ManageSieve protocol MUST implement the SCRAM-SHA-1 [SCRAM] SASL - mechanism, as well as [PLAIN] over [TLS]. - - Note: use of PLAIN over TLS reflects current use of PLAIN over TLS in - other email-related protocols; however, a longer-term goal is to - migrate email-related protocols from using PLAIN over TLS to SCRAM- - SHA-1 mechanism. - - Examples (Note that long lines are folded for readability and are not - part of protocol exchange): - - S: "IMPLEMENTATION" "Example1 ManageSieved v001" - S: "SASL" "DIGEST-MD5 GSSAPI" - S: "SIEVE" "fileinto vacation" - S: "STARTTLS" - S: "VERSION" "1.0" - S: OK - C: Authenticate "DIGEST-MD5" - S: "cmVhbG09ImVsd29vZC5pbm5vc29mdC5leGFtcGxlLmNvbSIsbm9uY2U9Ik - 9BNk1HOXRFUUdtMmhoIixxb3A9ImF1dGgiLGFsZ29yaXRobT1tZDUtc2Vz - cyxjaGFyc2V0PXV0Zi04" - C: "Y2hhcnNldD11dGYtOCx1c2VybmFtZT0iY2hyaXMiLHJlYWxtPSJlbHdvb2 - QuaW5ub3NvZnQuZXhhbXBsZS5jb20iLG5vbmNlPSJPQTZNRzl0RVFHbTJo - aCIsbmM9MDAwMDAwMDEsY25vbmNlPSJPQTZNSFhoNlZxVHJSayIsZGlnZX - N0LXVyaT0ic2lldmUvZWx3b29kLmlubm9zb2Z0LmV4YW1wbGUuY29tIixy - ZXNwb25zZT1kMzg4ZGFkOTBkNGJiZDc2MGExNTIzMjFmMjE0M2FmNyxxb3 - A9YXV0aA==" - S: OK (SASL "cnNwYXV0aD1lYTQwZjYwMzM1YzQyN2I1NTI3Yjg0ZGJhYmNkZ - mZmZA==") - - - - - - - - -Melnikov & Martin Standards Track [Page 13] - -RFC 5804 ManageSieve July 2010 - - - A slightly different variant of the same authentication exchange is: - - S: "IMPLEMENTATION" "Example1 ManageSieved v001" - S: "SASL" "DIGEST-MD5 GSSAPI" - S: "SIEVE" "fileinto vacation" - S: "VERSION" "1.0" - S: "STARTTLS" - S: OK - C: Authenticate "DIGEST-MD5" - S: {136} - S: cmVhbG09ImVsd29vZC5pbm5vc29mdC5leGFtcGxlLmNvbSIsbm9uY2U9Ik - 9BNk1HOXRFUUdtMmhoIixxb3A9ImF1dGgiLGFsZ29yaXRobT1tZDUtc2Vz - cyxjaGFyc2V0PXV0Zi04 - C: {300+} - C: Y2hhcnNldD11dGYtOCx1c2VybmFtZT0iY2hyaXMiLHJlYWxtPSJlbHdvb2 - QuaW5ub3NvZnQuZXhhbXBsZS5jb20iLG5vbmNlPSJPQTZNRzl0RVFHbTJo - aCIsbmM9MDAwMDAwMDEsY25vbmNlPSJPQTZNSFhoNlZxVHJSayIsZGlnZX - N0LXVyaT0ic2lldmUvZWx3b29kLmlubm9zb2Z0LmV4YW1wbGUuY29tIixy - ZXNwb25zZT1kMzg4ZGFkOTBkNGJiZDc2MGExNTIzMjFmMjE0M2FmNyxxb3 - A9YXV0aA== - S: {56} - S: cnNwYXV0aD1lYTQwZjYwMzM1YzQyN2I1NTI3Yjg0ZGJhYmNkZmZmZA== - C: "" - S: OK - - - - - - - - - - - - - - - - - - - - - - - - - - - -Melnikov & Martin Standards Track [Page 14] - -RFC 5804 ManageSieve July 2010 - - - Another example demonstrating use of SASL PLAIN mechanism under TLS - follows. This example also demonstrate use of SASL "initial - response" (the second parameter to the Authenticate command): - - S: "IMPLEMENTATION" "Example1 ManageSieved v001" - S: "VERSION" "1.0" - S: "SASL" "" - S: "SIEVE" "fileinto vacation" - S: "STARTTLS" - S: OK - C: STARTTLS - S: OK - - S: "IMPLEMENTATION" "Example1 ManageSieved v001" - S: "VERSION" "1.0" - S: "SASL" "PLAIN" - S: "SIEVE" "fileinto vacation" - S: OK - C: Authenticate "PLAIN" "QJIrweAPyo6Q1T9xu" - S: NO - C: Authenticate "PLAIN" "QJIrweAPyo6Q1T9xz" - S: NO - C: Authenticate "PLAIN" "QJIrweAPyo6Q1T9xy" - S: BYE "Too many failed authentication attempts" - - - - - - - - - - - - - - - - - - - - - - - - - - - -Melnikov & Martin Standards Track [Page 15] - -RFC 5804 ManageSieve July 2010 - - - The following example demonstrates use of SASL "initial response". - It also demonstrates that an empty response can be sent as a literal - and that negotiating a SASL security layer results in the server - re-issuing server capabilities: - - C: AUTHENTICATE "GSSAPI" {1488+} - C: YIIE[...1480 octets here ...]dA== - S: {208} - S: YIGZBgkqhkiG9xIBAgICAG+BiTCBhqADAgEFoQMCAQ+iejB4oAMCARKic - [...114 octets here ...] - /yzpAy9p+Y0LanLskOTvMc0MnjgAa4YEr3eJ6 - C: {0+} - C: - S: {44} - S: BQQF/wAMAAwAAAAAYRGFAo6W0vIHti8i1UXODgEAEAA= - C: {44+} - C: BQQE/wAMAAwAAAAAIsT1iv9UkZApw471iXt6cwEAAAE= - S: OK - - S: "IMPLEMENTATION" "Example1 ManageSieved v001" - S: "VERSION" "1.0" - S: "SASL" "PLAIN DIGEST-MD5 GSSAPI" - S: "SIEVE" "fileinto vacation" - S: "LANGUAGE" "ru" - S: "MAXREDIRECTS" "3" - S: ok - -2.1.1. Use of SASL PLAIN Mechanism over TLS - - This section is normative for ManageSieve client implementations that - support SASL [PLAIN] over [TLS]. - - If a ManageSieve client is willing to use SASL PLAIN over TLS to - authenticate to the ManageSieve server, the client MUST verify the - server identity (see Section 2.2.1). If the server identity can't be - verified (e.g., the server has not provided any certificate, or if - the certificate verification fails), the client MUST NOT attempt to - authenticate using the SASL PLAIN mechanism. - -2.2. STARTTLS Command - - Support for STARTTLS command in servers is optional. Its - availability is advertised with "STARTTLS" capability as described in - Section 1.7. - - The STARTTLS command requests commencement of a TLS [TLS] - negotiation. The negotiation begins immediately after the CRLF in - the OK response. After a client issues a STARTTLS command, it MUST - - - -Melnikov & Martin Standards Track [Page 16] - -RFC 5804 ManageSieve July 2010 - - - NOT issue further commands until a server response is seen and the - TLS negotiation is complete. - - The STARTTLS command is only valid in non-authenticated state. The - server remains in non-authenticated state, even if client credentials - are supplied during the TLS negotiation. The SASL [SASL] EXTERNAL - mechanism MAY be used to authenticate once TLS client credentials are - successfully exchanged, but servers supporting the STARTTLS command - are not required to support the EXTERNAL mechanism. - - After the TLS layer is established, the server MUST re-issue the - capability results, followed by an OK response. This is necessary to - protect against man-in-the-middle attacks that alter the capabilities - list prior to STARTTLS. This capability result MUST NOT include the - STARTTLS capability. - - The client MUST discard cached capability information and replace it - with the new information. The server MAY advertise different - capabilities after STARTTLS. - - Example: - - C: StartTls - S: oK - - S: "IMPLEMENTATION" "Example1 ManageSieved v001" - S: "SASL" "PLAIN DIGEST-MD5 GSSAPI" - S: "SIEVE" "fileinto vacation" - S: "VERSION" "1.0" - S: "LANGUAGE" "fr" - S: ok - -2.2.1. Server Identity Check - - During the TLS negotiation, the ManageSieve client MUST check its - understanding of the server hostname/IP address against the server's - identity as presented in the server Certificate message, in order to - prevent man-in-the-middle attacks. In this section, the client's - understanding of the server's identity is called the "reference - identity". - - Checking is performed according to the following rules: - - o If the reference identity is a hostname: - - 1. If a subjectAltName extension of the SRVName [X509-SRV], - dNSName [X509] (in that order of preference) type is present - in the server's certificate, then it SHOULD be used as the - - - -Melnikov & Martin Standards Track [Page 17] - -RFC 5804 ManageSieve July 2010 - - - source of the server's identity. Matching is performed as - described in Section 2.2.1.1, with the exception that no - wildcard matching is allowed for SRVName type. If the - certificate contains multiple names (e.g., more than one - dNSName field), then a match with any one of the fields is - considered acceptable. - - 2. The client MAY use other types of subjectAltName for - performing comparison. - - 3. The server's identity MAY also be verified by comparing the - reference identity to the Common Name (CN) [RFC4519] value in - the leaf Relative Distinguished Name (RDN) of the subjectName - field of the server's certificate. This comparison is - performed using the rules for comparison of DNS names in - Section 2.2.1.1, below. Although the use of the Common Name - value is existing practice, it is deprecated, and - Certification Authorities are encouraged to provide - subjectAltName values instead. Note that the TLS - implementation may represent DNs in certificates according to - X.500 or other conventions. For example, some X.500 - implementations order the RDNs in a DN using a left-to-right - (most significant to least significant) convention instead of - LDAP's right-to-left convention. - - o When the reference identity is an IP address, the iPAddress - subjectAltName SHOULD be used by the client for comparison. The - comparison is performed as described in Section 2.2.1.2. - - If the server identity check fails, user-oriented clients SHOULD - either notify the user (clients MAY give the user the opportunity to - continue with the ManageSieve session in this case) or close the - transport connection and indicate that the server's identity is - suspect. Automated clients SHOULD return or log an error indicating - that the server's identity is suspect and/or SHOULD close the - transport connection. Automated clients MAY provide a configuration - setting that disables this check, but MUST provide a setting that - enables it. - - Beyond the server identity check described in this section, clients - should be prepared to do further checking to ensure that the server - is authorized to provide the service it is requested to provide. The - client may need to make use of local policy information in making - this determination. - - - - - - - -Melnikov & Martin Standards Track [Page 18] - -RFC 5804 ManageSieve July 2010 - - -2.2.1.1. Comparison of DNS Names - - If the reference identity is an internationalized domain name, - conforming implementations MUST convert it to the ASCII Compatible - Encoding (ACE) format as specified in Section 4 of RFC 3490 [RFC3490] - before comparison with subjectAltName values of type dNSName. - Specifically, conforming implementations MUST perform the conversion - operation specified in Section 4 of [RFC3490] as follows: - - o in step 1, the domain name SHALL be considered a "stored string"; - - o in step 3, set the flag called "UseSTD3ASCIIRules"; - - o in step 4, process each label with the "ToASCII" operation; and - - o in step 5, change all label separators to U+002E (full stop). - - After performing the "to-ASCII" conversion, the DNS labels and names - MUST be compared for equality according to the rules specified in - Section 3 of [RFC3490]; i.e., once all label separators are replaced - with U+002E (dot) they are compared in the case-insensitive manner. - - The '*' (ASCII 42) wildcard character is allowed in subjectAltName - values of type dNSName, and then only as the left-most (least - significant) DNS label in that value. This wildcard matches any - left-most DNS label in the server name. That is, the subject - *.example.com matches the server names a.example.com and - b.example.com, but does not match example.com or a.b.example.com. - -2.2.1.2. Comparison of IP Addresses - - When the reference identity is an IP address, the identity MUST be - converted to the "network byte order" octet string representation - [RFC791][RFC2460]. For IP Version 4, as specified in RFC 791, the - octet string will contain exactly four octets. For IP Version 6, as - specified in RFC 2460, the octet string will contain exactly sixteen - octets. This octet string is then compared against subjectAltName - values of type iPAddress. A match occurs if the reference identity - octet string and value octet strings are identical. - -2.2.1.3. Comparison of Other subjectName Types - - Client implementations MAY support matching against subjectAltName - values of other types as described in other documents. - - - - - - - -Melnikov & Martin Standards Track [Page 19] - -RFC 5804 ManageSieve July 2010 - - -2.3. LOGOUT Command - - The client sends the LOGOUT command when it is finished with a - connection and wishes to terminate it. The server MUST reply with an - OK response. The server MUST ignore commands issued by the client - after the LOGOUT command. - - The client SHOULD wait for the OK response before closing the - connection. This avoids the TCP connection going into the TIME_WAIT - state on the server. In order to avoid going into the TIME_WAIT TCP - state, the server MAY wait for a short while for the client to close - the TCP connection first. Whether or not the server waits for the - client to close the connection, it MUST then close the connection - itself. - - Example: - - C: Logout - S: Ok - - -2.4. CAPABILITY Command - - The CAPABILITY command requests the server capabilities as described - earlier in this document. It has no parameters. - - Example: - - C: CAPABILITY - S: "IMPLEMENTATION" "Example1 ManageSieved v001" - S: "VERSION" "1.0" - S: "SASL" "PLAIN SCRAM-SHA-1 GSSAPI" - S: "SIEVE" "fileinto vacation" - S: "STARTTLS" - S: OK - -2.5. HAVESPACE Command - - Arguments: String - name - Number - script size - - The HAVESPACE command is used to query the server for available - space. Clients specify the name they wish to save the script as and - its size in octets. Both parameters can be used by the server to see - if the script with the specified name and size is within a user's - quota(s). For example, the server MAY use the script name to check - if a script would be replaced or a new one would be created. Servers - respond with a NO if storing a script with that name and size would - - - -Melnikov & Martin Standards Track [Page 20] - -RFC 5804 ManageSieve July 2010 - - - fail or OK otherwise. Clients SHOULD issue this command before - attempting to place a script on the server. - - Note that the OK response from the HAVESPACE command does not - constitute a guarantee of success as server disk space conditions - could change between the client issuing the HAVESPACE and the client - issuing the PUTSCRIPT commands. A QUOTA response code (see - Section 1.3) remains a possible (albeit unlikely) response to a - subsequent PUTSCRIPT with the same name and size. - - Example: - - C: HAVESPACE "myscript" 999999 - S: NO (QUOTA/MAXSIZE) "Quota exceeded" - - C: HAVESPACE "foobar" 435 - S: OK - -2.6. PUTSCRIPT Command - - Arguments: String - Script name - String - Script content - - The PUTSCRIPT command is used by the client to submit a Sieve script - to the server. - - If the script already exists, upon success the old script will be - overwritten. The old script MUST NOT be overwritten if PUTSCRIPT - fails in any way. A script of zero length SHOULD be disallowed. - - This command places the script on the server. It does not affect - whether the script is processed on incoming mail, unless it replaces - the script that is already active. The SETACTIVE command is used to - mark a script as active. - - When submitting large scripts, clients SHOULD use the HAVESPACE - command beforehand to query if the server is willing to accept a - script of that size. - - The server MUST check the submitted script for validity, which - includes checking that the script complies with the Sieve grammar - [SIEVE] and that all Sieve extensions mentioned in the script's - "require" statement(s) are supported by the Sieve interpreter. (Note - that if the Sieve interpreter supports the Sieve "ihave" extension - [I-HAVE], any unrecognized/unsupported extension mentioned in the - "ihave" test MUST NOT cause the validation failure.) Other checks - such as validating the supplied command arguments for each command - MAY be performed. Essentially, the performed validation SHOULD be - - - -Melnikov & Martin Standards Track [Page 21] - -RFC 5804 ManageSieve July 2010 - - - the same as performed when compiling the script for execution. - Implementations that use a binary representation to store compiled - scripts can extend the validation to a full compilation, in order to - avoid validating uploaded scripts multiple times. - - If the script fails the validation, the server MUST reply with a NO - response. Any script that fails the validity test MUST NOT be stored - on the server. The message given with a NO response MUST be human - readable and SHOULD contain a specific error message giving the line - number of the first error. Implementors should strive to produce - helpful error messages similar to those given by programming language - compilers. Client implementations should note that this may be a - multiline literal string with more than one error message separated - by CRLFs. The human-readable message is in the language returned in - the latest LANGUAGE capability (or in "i-default"; see Section 1.7), - encoded in UTF-8 [UTF-8]. - - An OK response MAY contain the WARNINGS response code. In such a - case the human-readable message that follows the OK response SHOULD - contain a specific warning message (or messages) giving the line - number(s) in the script that might contain errors not intended by the - script writer. The human-readable message is in the language - returned in the latest LANGUAGE capability (or in "i-default"; see - Section 1.7), encoded in UTF-8 [UTF-8]. A client seeing such a - response code SHOULD present the message to the user. - - - - - - - - - - - - - - - - - - - - - - - - - - -Melnikov & Martin Standards Track [Page 22] - -RFC 5804 ManageSieve July 2010 - - - Examples: - - C: Putscript "foo" {31+} - C: #comment - C: InvalidSieveCommand - C: - S: NO "line 2: Syntax error" - - C: Putscript "mysievescript" {110+} - C: require ["fileinto"]; - C: - C: if envelope :contains "to" "tmartin+sent" { - C: fileinto "INBOX.sent"; - C: } - S: OK - - C: Putscript "myforwards" {190+} - C: redirect "111@example.net"; - C: - C: if size :under 10k { - C: redirect "mobile@cell.example.com"; - C: } - C: - C: if envelope :contains "to" "tmartin+lists" { - C: redirect "lists@groups.example.com"; - C: } - S: OK (WARNINGS) "line 8: server redirect action - limit is 2, this redirect might be ignored" - -2.7. LISTSCRIPTS Command - - This command lists the scripts the user has on the server. Upon - success, a list of CRLF-separated script names (each represented as a - quoted or literal string) is returned followed by an OK response. If - there exists an active script, the atom ACTIVE is appended to the - corresponding script name. The atom ACTIVE MUST NOT appear on more - than one response line. - - - - - - - - - - - - - - -Melnikov & Martin Standards Track [Page 23] - -RFC 5804 ManageSieve July 2010 - - - Example: - - C: Listscripts - S: "summer_script" - S: "vacation_script" - S: {13} - S: clever"script - S: "main_script" ACTIVE - S: OK - - C: listscripts - S: "summer_script" - S: "main_script" active - S: OK - -2.8. SETACTIVE Command - - Arguments: String - script name - - This command sets a script active. If the script name is the empty - string (i.e., ""), then any active script is disabled. Disabling an - active script when there is no script active is not an error and MUST - result in an OK reply. - - If the script does not exist on the server, then the server MUST - reply with a NO response. Such a reply SHOULD contain the - NONEXISTENT response code. - - Examples: - - C: Setactive "vacationscript" - S: Ok - - C: Setactive "" - S: Ok - - C: Setactive "baz" - S: No (NONEXISTENT) "There is no script by that name" - - C: Setactive "baz" - S: No (NONEXISTENT) {31} - S: There is no script by that name - - - - - - - - - -Melnikov & Martin Standards Track [Page 24] - -RFC 5804 ManageSieve July 2010 - - -2.9. GETSCRIPT Command - - Arguments: String - script name - - This command gets the contents of the specified script. If the - script does not exist, the server MUST reply with a NO response. - Such a reply SHOULD contain the NONEXISTENT response code. - - Upon success, a string with the contents of the script is returned - followed by an OK response. - - Example: - - C: Getscript "myscript" - S: {54} - S: #this is my wonderful script - S: reject "I reject all"; - S: - S: OK - -2.10. DELETESCRIPT Command - - Arguments: String - script name - - This command is used to delete a user's Sieve script. Servers MUST - reply with a NO response if the script does not exist. Such - responses SHOULD include the NONEXISTENT response code. - - The server MUST NOT allow the client to delete an active script, so - the server MUST reply with a NO response if attempted. Such a - response SHOULD contain the ACTIVE response code. If a client wishes - to delete an active script, it should use the SETACTIVE command to - disable the script first. - - Example: - - C: Deletescript "foo" - S: Ok - - C: Deletescript "baz" - S: No (ACTIVE) "You may not delete an active script" - - - - - - - - - - -Melnikov & Martin Standards Track [Page 25] - -RFC 5804 ManageSieve July 2010 - - -2.11. RENAMESCRIPT Command - - Arguments: String - Old Script name - String - New Script name - - This command is used to rename a user's Sieve script. Servers MUST - reply with a NO response if the old script does not exist (in which - case the NONEXISTENT response code SHOULD be included), or a script - with the new name already exists (in which case the ALREADYEXISTS - response code SHOULD be included). Renaming the active script is - allowed; the renamed script remains active. - - Example: - - C: Renamescript "foo" "bar" - S: Ok - - C: Renamescript "baz" "bar" - S: No "bar already exists" - - If the server doesn't support the RENAMESCRIPT command, the client - can emulate it by performing the following steps: - - 1. List available scripts with LISTSCRIPTS. If the script with the - new script name exists, then the client should ask the user - whether to abort the operation, to replace the script (by issuing - the DELETESCRIPT after that), or to choose a different - name. - - 2. Download the old script with GETSCRIPT . - - 3. Upload the old script with the new name: PUTSCRIPT . - - 4. If the old script was active (as reported by LISTSCRIPTS in step - 1), then make the new script active: SETACTIVE . - - 5. Delete the old script: DELETESCRIPT . - - Note that these steps don't describe how to handle various other - error conditions (for example, NO response containing QUOTA response - code in step 3). Error handling is left as an exercise for the - reader. - - - - - - - - - -Melnikov & Martin Standards Track [Page 26] - -RFC 5804 ManageSieve July 2010 - - -2.12. CHECKSCRIPT Command - - Arguments: String - Script content - - The CHECKSCRIPT command is used by the client to verify Sieve script - validity without storing the script on the server. - - The server MUST check the submitted script for syntactic validity, - which includes checking that all Sieve extensions mentioned in Sieve - script "require" statement(s) are supported by the Sieve interpreter. - (Note that if the Sieve interpreter supports the Sieve "ihave" - extension [I-HAVE], any unrecognized/unsupported extension mentioned - in the "ihave" test MUST NOT cause the syntactic validation failure.) - If the script fails this test, the server MUST reply with a NO - response. The message given with a NO response MUST be human - readable and SHOULD contain a specific error message giving the line - number of the first error. Implementors should strive to produce - helpful error messages similar to those given by programming language - compilers. Client implementations should note that this may be a - multiline literal string with more than one error message separated - by CRLFs. The human-readable message is in the language returned in - the latest LANGUAGE capability (or in "i-default"; see Section 1.7), - encoded in UTF-8 [UTF-8]. - - Examples: - - C: CheckScript {31+} - C: #comment - C: InvalidSieveCommand - C: - S: NO "line 2: Syntax error" - - A ManageSieve server supporting this command MUST NOT check if the - script will put the current user over its quota limit. - - An OK response MAY contain the WARNINGS response code. In such a - case, the human-readable message that follows the OK response SHOULD - contain a specific warning message (or messages) giving the line - number(s) in the script that might contain errors not intended by the - script writer. The human-readable message is in the language - returned in the latest LANGUAGE capability (or in "i-default"; see - Section 1.7), encoded in UTF-8 [UTF-8]. A client seeing such a - response code SHOULD present the message to the user. - - - - - - - - -Melnikov & Martin Standards Track [Page 27] - -RFC 5804 ManageSieve July 2010 - - -2.13. NOOP Command - - Arguments: String - tag to echo back (optional) - - The NOOP command does nothing, beyond returning a response to the - client. It may be used by clients for protocol re-synchronization or - to reset any inactivity auto-logout timer on the server. - - The response to the NOOP command is always OK, followed by the TAG - response code together with the supplied string. If no string was - supplied in the NOOP command, the TAG response code MUST NOT be - included. - - Examples: - - C: NOOP - S: OK "NOOP completed" - - C: NOOP "STARTTLS-SYNC-42" - S: OK (TAG {16} - S: STARTTLS-SYNC-42) "Done" - -2.14. Recommended Extensions - - The UNAUTHENTICATE extension (advertised as the "UNAUTHENTICATE" - capability with no parameters) defines a new UNAUTHENTICATE command, - which allows a client to return the server to non-authenticated - state. Support for this extension is RECOMMENDED. - -2.14.1. UNAUTHENTICATE Command - - The UNAUTHENTICATE command returns the server to the - non-authenticated state. It doesn't affect any previously - established TLS [TLS] or SASL (Section 2.1) security layer. - - The UNAUTHENTICATE command is only valid in authenticated state. If - issued in a wrong state, the server MUST reject it with a NO - response. - - The UNAUTHENTICATE command has no parameters. - - When issued in the authenticated state, the UNAUTHENTICATE command - MUST NOT fail (i.e., it must never return anything other than OK or - BYE). - - - - - - - -Melnikov & Martin Standards Track [Page 28] - -RFC 5804 ManageSieve July 2010 - - -3. Sieve URL Scheme - - URI scheme name: sieve - - Status: permanent - - URI scheme syntax: Described using ABNF [ABNF]. Some ABNF - productions not defined below are from [URI-GEN]. - - sieveurl = sieveurl-server / sieveurl-list-scripts / - sieveurl-script - - sieveurl-server = "sieve://" authority - - sieveurl-list-scripts = "sieve://" authority ["/"] - - sieveurl-script = "sieve://" authority "/" - [owner "/"] scriptname - - authority = - - owner = *ochar - ;; %-encoded version of [SASL] authorization - ;; identity (script owner) or "userid". - ;; - ;; Empty owner is used to reference - ;; global scripts. - ;; - ;; Note that ASCII characters such as " ", ";", - ;; "&", "=", "/" and "?" must be %-encoded - ;; as per rule specified in [URI-GEN]. - - scriptname = 1*ochar - ;; %-encoded version of UTF-8 representation - ;; of the script name. - ;; Note that ASCII characters such as " ", ";", - ;; "&", "=", "/" and "?" must be %-encoded - ;; as per rule specified in [URI-GEN]. - - ochar = unreserved / pct-encoded / sub-delims-sh / - ":" / "@" - ;; Same as [URI-GEN] 'pchar', - ;; but without ";", "&" and "=". - - unreserved = - - pct-encoded = - - - - -Melnikov & Martin Standards Track [Page 29] - -RFC 5804 ManageSieve July 2010 - - - sub-delims-sh = "!" / "$" / "'" / "(" / ")" / - "*" / "+" / "," - ;; Same as [URI-GEN] sub-delims, - ;; but without ";", "&" and "=". - - URI scheme semantics: - - A Sieve URL identifies a Sieve server or a Sieve script on a Sieve - server. The latter form is associated with the application/sieve - MIME type defined in [SIEVE]. There is no MIME type associated - with the former form of Sieve URI. - - The server form is used in the REFERRAL response code (see Section - 1.3) in order to designate another server where the client should - perform its operations. - - The script form allows to retrieve (GETSCRIPT), update - (PUTSCRIPT), delete (DELETESCRIPT), or activate (SETACTIVE) the - named script; however, the most typical action would be to - retrieve the script. If the script name is empty (omitted), the - URI requests that the client lists available scripts using the - LISTSCRIPTS command. - - Encoding considerations: - - The script name and/or the owner, if present, is in UTF-8. Non-- - US-ASCII UTF-8 octets MUST be percent-encoded as described in - [URI-GEN]. US-ASCII characters such as " " (space), ";", "&", - "=", "/" and "?" MUST be %-encoded as described in [URI-GEN]. - Note that "&" and "?" are in this list in order to allow for - future extensions. - - Note that the empty owner (e.g., sieve://example.com//script) is - different from the missing owner (e.g., - sieve://example.com/script) and is reserved for referencing global - scripts. - - The user name (in the "authority" part), if present, is in UTF-8. - Non-US-ASCII UTF-8 octets MUST be percent-encoded as described in - [URI-GEN]. - - Applications/protocols that use this URI scheme name: - ManageSieve [RFC5804] clients and servers. Clients that can store - user preferences in protocols such as [LDAP] or [ACAP]. - - Interoperability considerations: None. - - - - - -Melnikov & Martin Standards Track [Page 30] - -RFC 5804 ManageSieve July 2010 - - - Security considerations: - The part of a ManageSieve URL might potentially disclose - some confidential information about the author of the script or, - depending on a ManageSieve implementation, about configuration of the - mail system. The latter might be used to prepare for a more complex - attack on the mail system. - - Clients resolving ManageSieve URLs that wish to achieve data - confidentiality and/or integrity SHOULD use the STARTTLS command (if - supported by the server) before starting authentication, or use a - SASL mechanism, such as GSSAPI, that provides a confidentiality - security layer. - - Contact: Alexey Melnikov - - Author/Change controller: IESG. - - References: This document and RFC 5228 [SIEVE]. - -4. Formal Syntax - - The following syntax specification uses the Augmented Backus-Naur - Form (BNF) notation as specified in [ABNF]. This uses the ABNF core - rules as specified in Appendix A of the ABNF specification [ABNF]. - "UTF8-2", "UTF8-3", and "UTF8-4" non-terminal are defined in [UTF-8]. - - Except as noted otherwise, all alphabetic characters are case- - insensitive. The use of upper- or lowercase characters to define - token strings is for editorial clarity only. Implementations MUST - accept these strings in a case-insensitive fashion. - - SAFE-CHAR = %x01-09 / %x0B-0C / %x0E-21 / %x23-5B / - %x5D-7F - ;; any TEXT-CHAR except QUOTED-SPECIALS - - QUOTED-CHAR = SAFE-UTF8-CHAR / "\" QUOTED-SPECIALS - - QUOTED-SPECIALS = DQUOTE / "\" - - SAFE-UTF8-CHAR = SAFE-CHAR / UTF8-2 / UTF8-3 / UTF8-4 - ;; , , and - ;; are defined in [UTF-8]. - - ATOM-CHAR = "!" / %x23-27 / %x2A-5B / %x5D-7A / %x7C-7E - ;; Any CHAR except ATOM-SPECIALS - - ATOM-SPECIALS = "(" / ")" / "{" / SP / CTL / QUOTED-SPECIALS - - - - -Melnikov & Martin Standards Track [Page 31] - -RFC 5804 ManageSieve July 2010 - - - NZDIGIT = %x31-39 - ;; 1-9 - - atom = 1*1024ATOM-CHAR - - iana-token = atom - ;; MUST be registered with IANA - - auth-type = DQUOTE auth-type-name DQUOTE - - auth-type-name = iana-token - ;; as defined in SASL [SASL] - - command = (command-any / command-auth / - command-nonauth) CRLF - ;; Modal based on state - - command-any = command-capability / command-logout / - command-noop - ;; Valid in all states - - command-auth = command-getscript / command-setactive / - command-listscripts / command-deletescript / - command-putscript / command-checkscript / - command-havespace / - command-renamescript / - command-unauthenticate - ;; Valid only in Authenticated state - - command-nonauth = command-authenticate / command-starttls - ;; Valid only when in Non-Authenticated - ;; state - - command-authenticate = "AUTHENTICATE" SP auth-type [SP string] - *(CRLF string) - - command-capability = "CAPABILITY" - - command-deletescript = "DELETESCRIPT" SP sieve-name - - command-getscript = "GETSCRIPT" SP sieve-name - - command-havespace = "HAVESPACE" SP sieve-name SP number - - command-listscripts = "LISTSCRIPTS" - - command-noop = "NOOP" [SP string] - - - - -Melnikov & Martin Standards Track [Page 32] - -RFC 5804 ManageSieve July 2010 - - - command-logout = "LOGOUT" - - command-putscript = "PUTSCRIPT" SP sieve-name SP sieve-script - - command-checkscript = "CHECKSCRIPT" SP sieve-script - - sieve-script = string - - command-renamescript = "RENAMESCRIPT" SP old-sieve-name SP - new-sieve-name - - old-sieve-name = sieve-name - - new-sieve-name = sieve-name - - command-setactive = "SETACTIVE" SP active-sieve-name - - command-starttls = "STARTTLS" - - command-unauthenticate= "UNAUTHENTICATE" - - extend-token = atom - ;; MUST be defined by a Standards Track or - ;; IESG-approved experimental protocol - ;; extension - - extension-data = extension-item *(SP extension-item) - - extension-item = extend-token / string / number / - "(" [extension-data] ")" - - literal-c2s = "{" number "+}" CRLF *OCTET - ;; The number represents the number of - ;; octets. - ;; This type of literal can only be sent - ;; from the client to the server. - - literal-s2c = "{" number "}" CRLF *OCTET - ;; Almost identical to literal-c2s, - ;; but with no '+' character. - ;; The number represents the number of - ;; octets. - ;; This type of literal can only be sent - ;; from the server to the client. - - - - - - - -Melnikov & Martin Standards Track [Page 33] - -RFC 5804 ManageSieve July 2010 - - - number = (NZDIGIT *DIGIT) / "0" - ;; A 32-bit unsigned number - ;; with no extra leading zeros. - ;; (0 <= n < 4,294,967,296) - - number-str = string - ;; encoded as a . - - quoted = DQUOTE *1024QUOTED-CHAR DQUOTE - ;; limited to 1024 octets between the <">s - - resp-code = "AUTH-TOO-WEAK" / "ENCRYPT-NEEDED" / "QUOTA" - ["/" ("MAXSCRIPTS" / "MAXSIZE")] / - resp-code-sasl / - resp-code-referral / - "TRANSITION-NEEDED" / "TRYLATER" / - "ACTIVE" / "NONEXISTENT" / - "ALREADYEXISTS" / "WARNINGS" / - "TAG" SP string / - resp-code-ext - - resp-code-referral = "REFERRAL" SP sieveurl - - resp-code-sasl = "SASL" SP string - - resp-code-name = iana-token - ;; The response code name is hierarchical, - ;; separated by '/'. - ;; The response code name MUST NOT start - ;; with '/'. - - resp-code-ext = resp-code-name [SP extension-data] - ;; unknown response codes MUST be tolerated - ;; by the client. - - response = response-authenticate / - response-logout / - response-getscript / - response-setactive / - response-listscripts / - response-deletescript / - response-putscript / - response-checkscript / - response-capability / - response-havespace / - response-starttls / - response-renamescript / - response-noop / - - - -Melnikov & Martin Standards Track [Page 34] - -RFC 5804 ManageSieve July 2010 - - - response-unauthenticate - - response-authenticate = *(string CRLF) - ((response-ok [response-capability]) / - response-nobye) - ;; is REQUIRED if a - ;; SASL security layer was negotiated and - ;; MUST be omitted otherwise. - - response-capability = *(single-capability) response-oknobye - - single-capability = capability-name [SP string] CRLF - - capability-name = string - - ;; Note that literal-s2c is allowed. - - initial-capabilities = DQUOTE "IMPLEMENTATION" DQUOTE SP string / - DQUOTE "SASL" DQUOTE SP sasl-mechs / - DQUOTE "SIEVE" DQUOTE SP sieve-extensions / - DQUOTE "MAXREDIRECTS" DQUOTE SP number-str / - DQUOTE "NOTIFY" DQUOTE SP notify-mechs / - DQUOTE "STARTTLS" DQUOTE / - DQUOTE "LANGUAGE" DQUOTE SP language / - DQUOTE "VERSION" DQUOTE SP version / - DQUOTE "OWNER" DQUOTE SP string - ;; Each capability conforms to - ;; the syntax for single-capability. - ;; Also, note that the capability name - ;; can be returned as either literal-s2c - ;; or quoted, even though only "quoted" - ;; string is shown above. - - version = ( DQUOTE "1.0" DQUOTE ) / version-ext - - version-ext = DQUOTE ver-major "." ver-minor DQUOTE - ; Future versions specified in updates - ; to this document. An increment to - ; the ver-major means a backward-incompatible - ; change to the protocol, e.g., "3.5" (ver-major "3") - ; is not backward-compatible with any "2.X" version. - ; Any version "Z.W" MUST be backward compatible - ; with any version "Z.Q", where Q < W. - ; For example, version "2.4" is backward compatible - ; with version "2.0", "2.1", "2.2", and "2.3". - - ver-major = number - - - - -Melnikov & Martin Standards Track [Page 35] - -RFC 5804 ManageSieve July 2010 - - - ver-minor = number - - sasl-mechs = string - ; Space-separated list of SASL mechanisms, - ; each SASL mechanism name complies with rules - ; specified in [SASL]. - ; Can be empty. - - sieve-extensions = string - ; Space-separated list of supported SIEVE extensions. - ; Can be empty. - - language = string - ; Contains from [RFC5646]. - - - notify-mechs = string - ; Space-separated list of URI schema parts - ; for supported notification [NOTIFY] methods. - ; MUST NOT be empty. - - response-deletescript = response-oknobye - - response-getscript = (sieve-script CRLF response-ok) / - response-nobye - - response-havespace = response-oknobye - - response-listscripts = *(sieve-name [SP "ACTIVE"] CRLF) - response-oknobye - ;; ACTIVE may only occur with one sieve-name - - response-logout = response-oknobye - - response-unauthenticate= response-oknobye - ;; "NO" response can only be returned when - ;; the command is issued in a wrong state - ;; or has a wrong number of parameters - - response-ok = "OK" [SP "(" resp-code ")"] - [SP string] CRLF - ;; The string contains human-readable text - ;; encoded as UTF-8. - - response-nobye = ("NO" / "BYE") [SP "(" resp-code ")"] - [SP string] CRLF - ;; The string contains human-readable text - ;; encoded as UTF-8. - - - -Melnikov & Martin Standards Track [Page 36] - -RFC 5804 ManageSieve July 2010 - - - response-oknobye = response-ok / response-nobye - - response-noop = response-ok - - response-putscript = response-oknobye - - response-checkscript = response-oknobye - - response-renamescript = response-oknobye - - response-setactive = response-oknobye - - response-starttls = (response-ok response-capability) / - response-nobye - - sieve-name = string - ;; See Section 1.6 for the full list of - ;; prohibited characters. - ;; Empty string is not allowed. - - active-sieve-name = string - ;; See Section 1.6 for the full list of - ;; prohibited characters. - ;; This is similar to , but - ;; empty string is allowed and has a special - ;; meaning. - - string = quoted / literal-c2s / literal-s2c - ;; literal-c2s is only allowed when sent - ;; from the client to the server. - ;; literal-s2c is only allowed when sent - ;; from the server to the client. - ;; quoted is allowed in either direction. - -5. Security Considerations - - The AUTHENTICATE command uses SASL [SASL] to provide authentication - and authorization services. Integrity and privacy services can be - provided by [SASL] and/or [TLS]. When a SASL mechanism is used, the - security considerations for that mechanism apply. - - This protocol's transactions are susceptible to passive observers or - man-in-the-middle attacks that alter the data, unless the optional - encryption and integrity services of the SASL (via the AUTHENTICATE - command) and/or [TLS] (via the STARTTLS command) are enabled, or an - external security mechanism is used for protection. It may be useful - to allow configuration of both clients and servers to refuse to - transfer sensitive information in the absence of strong encryption. - - - -Melnikov & Martin Standards Track [Page 37] - -RFC 5804 ManageSieve July 2010 - - - If an implementation supports SASL mechanisms that are vulnerable to - passive eavesdropping attacks (such as [PLAIN]), then the - implementation MUST support at least one configuration where these - SASL mechanisms are not advertised or used without the presence of an - external security layer such as [TLS]. - - Some response codes returned on failed AUTHENTICATE command may - disclose whether or not the username is valid (e.g., TRANSITION- - NEEDED), so server implementations SHOULD provide the ability to - disable these features (or make them not conditional on a per-user - basis) for sites concerned about such disclosure. In the case of - ENCRYPT-NEEDED, if it is applied to all identities then no extra - information is disclosed, but if it is applied on a per-user basis it - can disclose information. - - A compromised or malicious server can use the TRANSITION-NEEDED - response code to force the client that is configured to use a - mechanism that does not disclose the user's password to the server - (e.g., Kerberos), to send the bare password to the server. Clients - SHOULD have the ability to disable the password transition feature, - or disclose that risk to the user and offer the user an option of how - to proceed. - -6. IANA Considerations - - IANA has reserved TCP port number 4190 for use with the ManageSieve - protocol described in this document. - - IANA has registered the "sieve" URI scheme defined in Section 3 of - this document. - - IANA has registered "sieve" in the "GSSAPI/Kerberos/SASL Service - Names" registry. - - IANA has created a new registry for ManageSieve capabilities. The - registration template for ManageSieve capabilities is specified in - Section 6.1. ManageSieve protocol capabilities MUST be specified in - a Standards-Track or IESG-approved Experimental RFC. - - IANA has created a new registry for ManageSieve response codes. The - registration template for ManageSieve response codes is specified in - Section 6.3. ManageSieve protocol response codes MUST be specified - in a Standards-Track or IESG-approved Experimental RFC. - - - - - - - - -Melnikov & Martin Standards Track [Page 38] - -RFC 5804 ManageSieve July 2010 - - -6.1. ManageSieve Capability Registration Template - - To: iana@iana.org - Subject: ManageSieve Capability Registration - - Please register the following ManageSieve capability: - - Capability name: - Description: - Relevant publications: - Person & email address to contact for further information: - Author/Change controller: - -6.2. Registration of Initial ManageSieve Capabilities - - To: iana@iana.org - Subject: ManageSieve Capability Registration - - Please register the following ManageSieve capabilities: - - Capability name: IMPLEMENTATION - Description: Its value contains the name of the server - implementation and its version. - Relevant publications: this RFC, Section 1.7. - Person & email address to contact for further information: - Alexey Melnikov - Author/Change controller: IESG. - - Capability name: SASL - Description: Its value contains a space-separated list of SASL - mechanisms supported by the server. - Relevant publications: this RFC, Sections 1.7 and 2.1. - Person & email address to contact for further information: - Alexey Melnikov - Author/Change controller: IESG. - - Capability name: SIEVE - Description: Its value contains a space-separated list of supported - SIEVE extensions. - Relevant publications: this RFC, Section 1.7. Also [SIEVE]. - Person & email address to contact for further information: - Alexey Melnikov - Author/Change controller: IESG. - - - - - - - - -Melnikov & Martin Standards Track [Page 39] - -RFC 5804 ManageSieve July 2010 - - - Capability name: STARTTLS - Description: This capability is returned if the server supports TLS - (STARTTLS command). - Relevant publications: this RFC, Sections 1.7 and 2.2. - Person & email address to contact for further information: - Alexey Melnikov - Author/Change controller: IESG. - - Capability name: NOTIFY - Description: This capability is returned if the server supports the - 'enotify' [NOTIFY] Sieve extension. - Relevant publications: this RFC, Section 1.7. - Person & email address to contact for further information: - Alexey Melnikov - Author/Change controller: IESG. - - Capability name: MAXREDIRECTS - Description: This capability returns the limit on the number of - Sieve "redirect" actions a script can perform during a - single evaluation. The value is a non-negative number - represented as a ManageSieve string. - Relevant publications: this RFC, Section 1.7. - Person & email address to contact for further information: - Alexey Melnikov - Author/Change controller: IESG. - - Capability name: LANGUAGE - Description: The language ( from [RFC5646]) currently - used for human-readable error messages. - Relevant publications: this RFC, Section 1.7. - Person & email address to contact for further information: - Alexey Melnikov - Author/Change controller: IESG. - - Capability name: OWNER - Description: Its value contains the UTF-8-encoded name of the - currently logged-in user ("authorization identity" - according to RFC 4422). - Relevant publications: this RFC, Section 1.7. - Person & email address to contact for further information: - Alexey Melnikov - Author/Change controller: IESG. - - - - - - - - - -Melnikov & Martin Standards Track [Page 40] - -RFC 5804 ManageSieve July 2010 - - - Capability name: VERSION - Description: This capability is returned if the server is compliant - with RFC 5804; i.e., that it supports RENAMESCRIPT, - CHECKSCRIPT, and NOOP commands. - Relevant publications: this RFC, Sections 2.11, 2.12, and 2.13. - Person & email address to contact for further information: - Alexey Melnikov - Author/Change controller: IESG. - -6.3. ManageSieve Response Code Registration Template - - To: iana@iana.org - Subject: ManageSieve Response Code Registration - - Please register the following ManageSieve response code: - - Response Code: - Arguments (use ABNF to specify syntax, or the word NONE if none - can be specified): - Purpose: - Published Specification(s): - Person & email address to contact for further information: - Author/Change controller: - -6.4. Registration of Initial ManageSieve Response Codes - - To: iana@iana.org - Subject: ManageSieve Response Code Registration - - Please register the following ManageSieve response codes: - - Response Code: AUTH-TOO-WEAK - Arguments (use ABNF to specify syntax, or the word NONE if none can - be specified): NONE - Purpose: This response code is returned in the NO response from - an AUTHENTICATE command. It indicates that site - security policy forbids the use of the requested - mechanism for the specified authentication identity. - Published Specification(s): [RFC5804] - Person & email address to contact for further information: - Alexey Melnikov - Author/Change controller: IESG. - - - - - - - - - -Melnikov & Martin Standards Track [Page 41] - -RFC 5804 ManageSieve July 2010 - - - Response Code: ENCRYPT-NEEDED - Arguments (use ABNF to specify syntax, or the word NONE if none can - be specified): NONE - Purpose: This response code is returned in the NO response from - an AUTHENTICATE command. It indicates that site - security policy requires the use of a strong - encryption mechanism for the specified authentication - identity and mechanism. - Published Specification(s): [RFC5804] - Person & email address to contact for further information: - Alexey Melnikov - Author/Change controller: IESG. - - Response Code: QUOTA - Arguments (use ABNF to specify syntax, or the word NONE if none can - be specified): NONE - Purpose: If this response code is returned in the NO/BYE - response, it means that the command would have placed - the user above the site-defined quota constraints. If - this response code is returned in the OK response, it - can mean that the user is near its quota or that the - user exceeded its quota, but the server supports soft - quotas. - Published Specification(s): [RFC5804] - Person & email address to contact for further information: - Alexey Melnikov - Author/Change controller: IESG. - - Response Code: QUOTA/MAXSCRIPTS - Arguments (use ABNF to specify syntax, or the word NONE if none can - be specified): NONE - Purpose: If this response code is returned in the NO/BYE - response, it means that the command would have placed - the user above the site-defined limit on the number of - Sieve scripts. If this response code is returned in - the OK response, it can mean that the user is near its - quota or that the user exceeded its quota, but the - server supports soft quotas. This response code is a - more specific version of the QUOTA response code. - Published Specification(s): [RFC5804] - Person & email address to contact for further information: - Alexey Melnikov - Author/Change controller: IESG. - - - - - - - - -Melnikov & Martin Standards Track [Page 42] - -RFC 5804 ManageSieve July 2010 - - - Response Code: QUOTA/MAXSIZE - Arguments (use ABNF to specify syntax, or the word NONE if none can - be specified): NONE - Purpose: If this response code is returned in the NO/BYE - response, it means that the command would have placed - the user above the site-defined maximum script size. - If this response code is returned in the OK response, - it can mean that the user is near its quota or that - the user exceeded its quota, but the server supports - soft quotas. This response code is a more specific - version of the QUOTA response code. - Published Specification(s): [RFC5804] - Person & email address to contact for further information: - Alexey Melnikov - Author/Change controller: IESG. - - Response Code: REFERRAL - Arguments (use ABNF to specify syntax, or the word NONE if none can - be specified): - Purpose: This response code may be returned with a BYE result - from any command, and includes a mandatory parameter - that indicates what server to access to manage this - user's Sieve scripts. The server will be specified by - a Sieve URL (see Section 3). The scriptname portion - of the URL MUST NOT be specified. The client should - authenticate to the specified server and use it for - all further commands in the current session. - Published Specification(s): [RFC5804] - Person & email address to contact for further information: - Alexey Melnikov - Author/Change controller: IESG. - - Response Code: SASL - Arguments (use ABNF to specify syntax, or the word NONE if none can - be specified): - Purpose: This response code can occur in the OK response to a - successful AUTHENTICATE command and includes the - optional final server response data from the server as - specified by [SASL]. - Published Specification(s): [RFC5804] - Person & email address to contact for further information: - Alexey Melnikov - Author/Change controller: IESG. - - - - - - - - -Melnikov & Martin Standards Track [Page 43] - -RFC 5804 ManageSieve July 2010 - - - Response Code: TRANSITION-NEEDED - Arguments (use ABNF to specify syntax, or the word NONE if none can - be specified): NONE - Purpose: This response code occurs in a NO response of an - AUTHENTICATE command. It indicates that the user name - is valid, but the entry in the authentication database - needs to be updated in order to permit authentication - with the specified mechanism. This is typically done - by establishing a secure channel using TLS, followed - by authenticating once using the [PLAIN] - authentication mechanism. The selected mechanism - SHOULD then work for authentications in subsequent - sessions. - Published Specification(s): [RFC5804] - Person & email address to contact for further information: - Alexey Melnikov - Author/Change controller: IESG. - - Response Code: TRYLATER - Arguments (use ABNF to specify syntax, or the word NONE if none can - be specified): NONE - Purpose: A command failed due to a temporary server failure. - The client MAY continue using local information and - try the command later. This response code only make - sense when returned in a NO/BYE response. - Published Specification(s): [RFC5804] - Person & email address to contact for further information: - Alexey Melnikov - Author/Change controller: IESG. - - Response Code: ACTIVE - Arguments (use ABNF to specify syntax, or the word NONE if none can - be specified): NONE - Purpose: A command failed because it is not allowed on the - active script, for example, DELETESCRIPT on the active - script. This response code only makes sense when - returned in a NO/BYE response. - Published Specification(s): [RFC5804] - Person & email address to contact for further information: - Alexey Melnikov - Author/Change controller: IESG. - - - - - - - - - - -Melnikov & Martin Standards Track [Page 44] - -RFC 5804 ManageSieve July 2010 - - - Response Code: NONEXISTENT - Arguments (use ABNF to specify syntax, or the word NONE if none can - be specified): NONE - Purpose: A command failed because the referenced script name - doesn't exist. This response code only makes sense - when returned in a NO/BYE response. - Published Specification(s): [RFC5804] - Person & email address to contact for further information: - Alexey Melnikov - Author/Change controller: IESG. - - Response Code: ALREADYEXISTS - Arguments (use ABNF to specify syntax, or the word NONE if none can - be specified): NONE - Purpose: A command failed because the referenced script name - already exists. This response code only makes sense - when returned in a NO/BYE response. - Published Specification(s): [RFC5804] - Person & email address to contact for further information: - Alexey Melnikov - Author/Change controller: IESG. - - Response Code: WARNINGS - Arguments (use ABNF to specify syntax, or the word NONE if none can - be specified): NONE - Purpose: This response code MAY be returned by the server in - the OK response (but it might be returned with the NO/ - BYE response as well) and signals the client that even - though the script is syntactically valid, it might - contain errors not intended by the script writer. - Published Specification(s): [RFC5804] - Person & email address to contact for further information: - Alexey Melnikov - Author/Change controller: IESG. - - Response Code: TAG - Arguments (use ABNF to specify syntax, or the word NONE if none can - be specified): string - Purpose: This response code name is followed by a string - specified in the command that caused this response. - It is typically used for client state synchronization. - Published Specification(s): [RFC5804] - Person & email address to contact for further information: - Alexey Melnikov - Author/Change controller: IESG. - - - - - - -Melnikov & Martin Standards Track [Page 45] - -RFC 5804 ManageSieve July 2010 - - -7. Internationalization Considerations - - The LANGUAGE capability (see Section 1.7) allows a client to discover - the current language used in all human-readable responses that might - be returned at the end of any OK/NO/BYE response. Human-readable - text in OK responses typically doesn't need to be shown to the user, - unless it is returned in response to a PUTSCRIPT or CHECKSCRIPT - command that also contains the WARNINGS response code (Section 1.3). - Human-readable text from NO/BYE responses is intended be shown to the - user, unless the client can automatically handle failure of the - command that caused such a response. Clients SHOULD use response - codes (Section 1.3) for automatic error handling. Response codes MAY - also be used by the client to present error messages in a language - understood by the user, for example, if the LANGUAGE capability - doesn't return a language understood by the user. - - Note that the human-readable text from OK (WARNINGS) or NO/BYE - responses for PUTSCRIPT/CHECKSCRIPT commands is intended for advanced - users that understand Sieve language. Such advanced users are often - sophisticated enough to be able to handle whatever language the - server is using, even if it is not their preferred language, and will - want to see error/warning text no matter what language the server - puts it in. - - A client that generates Sieve script automatically, for example, if - the script is generated without user intervention or from a UI that - presents an abstract list of conditions and corresponding actions, - SHOULD NOT present warning/error messages to the user, because the - user might not even be aware that the client is using Sieve - underneath. However, if the client has a debugging mode, such - warnings/errors SHOULD be available in the debugging mode. - - Note that this document doesn't provide a way to modify the currently - used language. It is expected that a future extension will address - that. - -8. Acknowledgements - - Thanks to Simon Josefsson, Larry Greenfield, Allen Johnson, Chris - Newman, Lyndon Nerenberg, Tim Showalter, Sarah Robeson, Walter Wong, - Barry Leiba, Arnt Gulbrandsen, Stephan Bosch, Ken Murchison, Phil - Pennock, Ned Freed, Jeffrey Hutzelman, Mark E. Mallett, Dilyan - Palauzov, Dave Cridland, Aaron Stone, Robert Burrell Donkin, Patrick - Ben Koetter, Bjoern Hoehrmann, Martin Duerst, Pasi Eronen, Magnus - Westerlund, Tim Polk, and Julien Coloos for help with this document. - Special thank you to Phil Pennock for providing text for the NOOP - command, as well as finding various bugs in the document. - - - - -Melnikov & Martin Standards Track [Page 46] - -RFC 5804 ManageSieve July 2010 - - -9. References - -9.1. Normative References - - [ABNF] Crocker, D. and P. Overell, "Augmented BNF for Syntax - Specifications: ABNF", STD 68, RFC 5234, January 2008. - - [ACAP] Newman, C. and J. Myers, "ACAP -- Application - Configuration Access Protocol", RFC 2244, November - 1997. - - [BASE64] Josefsson, S., "The Base16, Base32, and Base64 Data - Encodings", RFC 4648, October 2006. - - [DNS-SRV] Gulbrandsen, A., Vixie, P., and L. Esibov, "A DNS RR - for specifying the location of services (DNS SRV)", - RFC 2782, February 2000. - - [KEYWORDS] Bradner, S., "Key words for use in RFCs to Indicate - Requirement Levels", BCP 14, RFC 2119, March 1997. - - [NET-UNICODE] Klensin, J. and M. Padlipsky, "Unicode Format for - Network Interchange", RFC 5198, March 2008. - - [NOTIFY] Melnikov, A., Leiba, B., Segmuller, W., and T. Martin, - "Sieve Email Filtering: Extension for Notifications", - RFC 5435, January 2009. - - [RFC2277] Alvestrand, H., "IETF Policy on Character Sets and - Languages", BCP 18, RFC 2277, January 1998. - - [RFC2460] Deering, S. and R. Hinden, "Internet Protocol, Version - 6 (IPv6) Specification", RFC 2460, December 1998. - - [RFC3490] Faltstrom, P., Hoffman, P., and A. Costello, - "Internationalizing Domain Names in Applications - (IDNA)", RFC 3490, March 2003. - - [RFC4519] Sciberras, A., "Lightweight Directory Access Protocol - (LDAP): Schema for User Applications", RFC 4519, June - 2006. - - [RFC5646] Phillips, A. and M. Davis, "Tags for Identifying - Languages", BCP 47, RFC 5646, September 2009. - - [RFC791] Postel, J., "Internet Protocol", STD 5, RFC 791, - September 1981. - - - - -Melnikov & Martin Standards Track [Page 47] - -RFC 5804 ManageSieve July 2010 - - - [SASL] Melnikov, A. and K. Zeilenga, "Simple Authentication - and Security Layer (SASL)", RFC 4422, June 2006. - - [SASLprep] Zeilenga, K., "SASLprep: Stringprep Profile for User - Names and Passwords", RFC 4013, February 2005. - - [SCRAM] Menon-Sen, A., Melnikov, A., Newman, C., and N. - Williams, "Salted Challenge Response Authentication - Mechanism (SCRAM) SASL and GSS-API Mechanisms", RFC - 5802, July 2010. - - [SIEVE] Guenther, P. and T. Showalter, "Sieve: An Email - Filtering Language", RFC 5228, January 2008. - - [StringPrep] Hoffman, P. and M. Blanchet, "Preparation of - Internationalized Strings ("stringprep")", RFC 3454, - December 2002. - - [TLS] Dierks, T. and E. Rescorla, "The Transport Layer - Security (TLS) Protocol Version 1.2", RFC 5246, August - 2008. - - [URI-GEN] Berners-Lee, T., Fielding, R., and L. Masinter, - "Uniform Resource Identifier (URI): Generic Syntax", - STD 66, RFC 3986, January 2005. - - [UTF-8] Yergeau, F., "UTF-8, a transformation format of ISO - 10646", STD 63, RFC 3629, November 2003. - - [X509] Cooper, D., Santesson, S., Farrell, S., Boeyen, S., - Housley, R., and W. Polk, "Internet X.509 Public Key - Infrastructure Certificate and Certificate Revocation - List (CRL) Profile", RFC 5280, May 2008. - - [X509-SRV] Santesson, S., "Internet X.509 Public Key - Infrastructure Subject Alternative Name for Expression - of Service Name", RFC 4985, August 2007. - -9.2. Informative References - - [DIGEST-MD5] Leach, P. and C. Newman, "Using Digest Authentication - as a SASL Mechanism", RFC 2831, May 2000. - - [GSSAPI] Melnikov, A., "The Kerberos V5 ("GSSAPI") Simple - Authentication and Security Layer (SASL) Mechanism", - RFC 4752, November 2006. - - - - - -Melnikov & Martin Standards Track [Page 48] - -RFC 5804 ManageSieve July 2010 - - - [I-HAVE] Freed, N., "Sieve Email Filtering: Ihave Extension", - RFC 5463, March 2009. - - [IMAP] Crispin, M., "INTERNET MESSAGE ACCESS PROTOCOL - - VERSION 4rev1", RFC 3501, March 2003. - - [LDAP] Zeilenga, K., "Lightweight Directory Access Protocol - (LDAP): Technical Specification Road Map", RFC 4510, - June 2006. - - [PLAIN] Zeilenga, K., "The PLAIN Simple Authentication and - Security Layer (SASL) Mechanism", RFC 4616, August - 2006. - -Authors' Addresses - - Alexey Melnikov (editor) - Isode Limited - 5 Castle Business Village - 36 Station Road - Hampton, Middlesex TW12 2BX - UK - - EMail: Alexey.Melnikov@isode.com - - - Tim Martin - BeThereBeSquare, Inc. - 672 Haight st. - San Francisco, CA 94117 - USA - - Phone: +1 510 260-4175 - EMail: timmartin@alumni.cmu.edu - - - - - - - - - - - - - - - - - -Melnikov & Martin Standards Track [Page 49] - blob - 046a2709765fed9f54b134d48ce1d95815c3a8e6 (mode 644) blob + /dev/null --- doc/src/rfc977.txt +++ /dev/null @@ -1,1539 +0,0 @@ - - -Network Working Group Brian Kantor (U.C. San Diego) -Request for Comments: 977 Phil Lapsley (U.C. Berkeley) - February 1986 - - Network News Transfer Protocol - - A Proposed Standard for the Stream-Based - Transmission of News - -Status of This Memo - - NNTP specifies a protocol for the distribution, inquiry, retrieval, - and posting of news articles using a reliable stream-based - transmission of news among the ARPA-Internet community. NNTP is - designed so that news articles are stored in a central database - allowing a subscriber to select only those items he wishes to read. - Indexing, cross-referencing, and expiration of aged messages are also - provided. This RFC suggests a proposed protocol for the ARPA-Internet - community, and requests discussion and suggestions for improvements. - Distribution of this memo is unlimited. - -1. Introduction - - For many years, the ARPA-Internet community has supported the - distribution of bulletins, information, and data in a timely fashion - to thousands of participants. We collectively refer to such items of - information as "news". Such news provides for the rapid - dissemination of items of interest such as software bug fixes, new - product reviews, technical tips, and programming pointers, as well as - rapid-fire discussions of matters of concern to the working computer - professional. News is very popular among its readers. - - There are popularly two methods of distributing such news: the - Internet method of direct mailing, and the USENET news system. - -1.1. Internet Mailing Lists - - The Internet community distributes news by the use of mailing lists. - These are lists of subscriber's mailbox addresses and remailing - sublists of all intended recipients. These mailing lists operate by - remailing a copy of the information to be distributed to each - subscriber on the mailing list. Such remailing is inefficient when a - mailing list grows beyond a dozen or so people, since sending a - separate copy to each of the subscribers occupies large quantities of - network bandwidth, CPU resources, and significant amounts of disk - storage at the destination host. There is also a significant problem - in maintenance of the list itself: as subscribers move from one job - to another; as new subscribers join and old ones leave; and as hosts - come in and out of service. - - - - -Kantor & Lapsley [Page 1] - - - -RFC 977 February 1986 -Network News Transfer Protocol - - -1.2. The USENET News System - - Clearly, a worthwhile reduction of the amount of these resources used - can be achieved if articles are stored in a central database on the - receiving host instead of in each subscriber's mailbox. The USENET - news system provides a method of doing just this. There is a central - repository of the news articles in one place (customarily a spool - directory of some sort), and a set of programs that allow a - subscriber to select those items he wishes to read. Indexing, - cross-referencing, and expiration of aged messages are also provided. - -1.3. Central Storage of News - - For clusters of hosts connected together by fast local area networks - (such as Ethernet), it makes even more sense to consolidate news - distribution onto one (or a very few) hosts, and to allow access to - these news articles using a server and client model. Subscribers may - then request only the articles they wish to see, without having to - wastefully duplicate the storage of a copy of each item on each host. - -1.4. A Central News Server - - A way to achieve these economies is to have a central computer system - that can provide news service to the other systems on the local area - network. Such a server would manage the collection of news articles - and index files, with each person who desires to read news bulletins - doing so over the LAN. For a large cluster of computer systems, the - savings in total disk space is clearly worthwhile. Also, this allows - workstations with limited disk storage space to participate in the - news without incoming items consuming oppressive amounts of the - workstation's disk storage. - - We have heard rumors of somewhat successful attempts to provide - centralized news service using IBIS and other shared or distributed - file systems. While it is possible that such a distributed file - system implementation might work well with a group of similar - computers running nearly identical operating systems, such a scheme - is not general enough to offer service to a wide range of client - systems, especially when many diverse operating systems may be in use - among a group of clients. There are few (if any) shared or networked - file systems that can offer the generality of service that stream - connections using Internet TCP provide, particularly when a wide - range of host hardware and operating systems are considered. - - NNTP specifies a protocol for the distribution, inquiry, retrieval, - and posting of news articles using a reliable stream (such as TCP) - server-client model. NNTP is designed so that news articles need only - - -Kantor & Lapsley [Page 2] - - - -RFC 977 February 1986 -Network News Transfer Protocol - - - be stored on one (presumably central) host, and subscribers on other - hosts attached to the LAN may read news articles using stream - connections to the news host. - - NNTP is modelled upon the news article specifications in RFC 850, - which describes the USENET news system. However, NNTP makes few - demands upon the structure, content, or storage of news articles, and - thus we believe it easily can be adapted to other non-USENET news - systems. - - Typically, the NNTP server runs as a background process on one host, - and would accept connections from other hosts on the LAN. This works - well when there are a number of small computer systems (such as - workstations, with only one or at most a few users each), and a large - central server. - -1.5. Intermediate News Servers - - For clusters of machines with many users (as might be the case in a - university or large industrial environment), an intermediate server - might be used. This intermediate or "slave" server runs on each - computer system, and is responsible for mediating news reading - requests and performing local caching of recently-retrieved news - articles. - - Typically, a client attempting to obtain news service would first - attempt to connect to the news service port on the local machine. If - this attempt were unsuccessful, indicating a failed server, an - installation might choose to either deny news access, or to permit - connection to the central "master" news server. - - For workstations or other small systems, direct connection to the - master server would probably be the normal manner of operation. - - This specification does not cover the operation of slave NNTP - servers. We merely suggest that slave servers are a logical addition - to NNTP server usage which would enhance operation on large local - area networks. - -1.6. News Distribution - - NNTP has commands which provide a straightforward method of - exchanging articles between cooperating hosts. Hosts which are well - connected on a local area or other fast network and who wish to - actually obtain copies of news articles for local storage might well - find NNTP to be a more efficient way to distribute news than more - traditional transfer methods (such as UUCP). - - -Kantor & Lapsley [Page 3] - - - -RFC 977 February 1986 -Network News Transfer Protocol - - - In the traditional method of distributing news articles, news is - propagated from host to host by flooding - that is, each host will - send all its new news articles on to each host that it feeds. These - hosts will then in turn send these new articles on to other hosts - that they feed. Clearly, sending articles that a host already has - obtained a copy of from another feed (many hosts that receive news - are redundantly fed) again is a waste of time and communications - resources, but for transport mechanisms that are single-transaction - based rather than interactive (such as UUCP in the UNIX-world <1>), - distribution time is diminished by sending all articles and having - the receiving host simply discard the duplicates. This is an - especially true when communications sessions are limited to once a - day. - - Using NNTP, hosts exchanging news articles have an interactive - mechanism for deciding which articles are to be transmitted. A host - desiring new news, or which has new news to send, will typically - contact one or more of its neighbors using NNTP. First it will - inquire if any new news groups have been created on the serving host - by means of the NEWGROUPS command. If so, and those are appropriate - or desired (as established by local site-dependent rules), those new - newsgroups can be created. - - The client host will then inquire as to which new articles have - arrived in all or some of the newsgroups that it desires to receive, - using the NEWNEWS command. It will receive a list of new articles - from the server, and can request transmission of those articles that - it desires and does not already have. - - Finally, the client can advise the server of those new articles which - the client has recently received. The server will indicate those - articles that it has already obtained copies of, and which articles - should be sent to add to its collection. - - In this manner, only those articles which are not duplicates and - which are desired are transferred. - - - - - - - - - - - - - -Kantor & Lapsley [Page 4] - - - -RFC 977 February 1986 -Network News Transfer Protocol - - -2. The NNTP Specification - -2.1. Overview - - The news server specified by this document uses a stream connection - (such as TCP) and SMTP-like commands and responses. It is designed - to accept connections from hosts, and to provide a simple interface - to the news database. - - This server is only an interface between programs and the news - databases. It does not perform any user interaction or presentation- - level functions. These "user-friendly" functions are better left to - the client programs, which have a better understanding of the - environment in which they are operating. - - When used via Internet TCP, the contact port assigned for this - service is 119. - -2.2. Character Codes - - Commands and replies are composed of characters from the ASCII - character set. When the transport service provides an 8-bit byte - (octet) transmission channel, each 7-bit character is transmitted - right justified in an octet with the high order bit cleared to zero. - -2.3. Commands - - Commands consist of a command word, which in some cases may be - followed by a parameter. Commands with parameters must separate the - parameters from each other and from the command by one or more space - or tab characters. Command lines must be complete with all required - parameters, and may not contain more than one command. - - Commands and command parameters are not case sensitive. That is, a - command or parameter word may be upper case, lower case, or any - mixture of upper and lower case. - - Each command line must be terminated by a CR-LF (Carriage Return - - Line Feed) pair. - - Command lines shall not exceed 512 characters in length, counting all - characters including spaces, separators, punctuation, and the - trailing CR-LF (thus there are 510 characters maximum allowed for the - command and its parameters). There is no provision for continuation - command lines. - - - - -Kantor & Lapsley [Page 5] - - - -RFC 977 February 1986 -Network News Transfer Protocol - - -2.4. Responses - - Responses are of two kinds, textual and status. - -2.4.1. Text Responses - - Text is sent only after a numeric status response line has been sent - that indicates that text will follow. Text is sent as a series of - successive lines of textual matter, each terminated with CR-LF pair. - A single line containing only a period (.) is sent to indicate the - end of the text (i.e., the server will send a CR-LF pair at the end - of the last line of text, a period, and another CR-LF pair). - - If the text contained a period as the first character of the text - line in the original, that first period is doubled. Therefore, the - client must examine the first character of each line received, and - for those beginning with a period, determine either that this is the - end of the text or whether to collapse the doubled period to a single - one. - - The intention is that text messages will usually be displayed on the - user's terminal whereas command/status responses will be interpreted - by the client program before any possible display is done. - -2.4.2. Status Responses - - These are status reports from the server and indicate the response to - the last command received from the client. - - Status response lines begin with a 3 digit numeric code which is - sufficient to distinguish all responses. Some of these may herald - the subsequent transmission of text. - - The first digit of the response broadly indicates the success, - failure, or progress of the previous command. - - 1xx - Informative message - 2xx - Command ok - 3xx - Command ok so far, send the rest of it. - 4xx - Command was correct, but couldn't be performed for - some reason. - 5xx - Command unimplemented, or incorrect, or a serious - program error occurred. - - - - - - -Kantor & Lapsley [Page 6] - - - -RFC 977 February 1986 -Network News Transfer Protocol - - - The next digit in the code indicates the function response category. - - x0x - Connection, setup, and miscellaneous messages - x1x - Newsgroup selection - x2x - Article selection - x3x - Distribution functions - x4x - Posting - x8x - Nonstandard (private implementation) extensions - x9x - Debugging output - - The exact response codes that should be expected from each command - are detailed in the description of that command. In addition, below - is listed a general set of response codes that may be received at any - time. - - Certain status responses contain parameters such as numbers and - names. The number and type of such parameters is fixed for each - response code to simplify interpretation of the response. - - Parameters are separated from the numeric response code and from each - other by a single space. All numeric parameters are decimal, and may - have leading zeros. All string parameters begin after the separating - space, and end before the following separating space or the CR-LF - pair at the end of the line. (String parameters may not, therefore, - contain spaces.) All text, if any, in the response which is not a - parameter of the response must follow and be separated from the last - parameter by a space. Also, note that the text following a response - number may vary in different implementations of the server. The - 3-digit numeric code should be used to determine what response was - sent. - - Response codes not specified in this standard may be used for any - installation-specific additional commands also not specified. These - should be chosen to fit the pattern of x8x specified above. (Note - that debugging is provided for explicitly in the x9x response codes.) - The use of unspecified response codes for standard commands is - prohibited. - - We have provided a response pattern x9x for debugging. Since much - debugging output may be classed as "informative messages", we would - expect, therefore, that responses 190 through 199 would be used for - various debugging outputs. There is no requirement in this - specification for debugging output, but if such is provided over the - connected stream, it must use these response codes. If appropriate - to a specific implementation, other x9x codes may be used for - debugging. (An example might be to use e.g., 290 to acknowledge a - remote debugging request.) - - -Kantor & Lapsley [Page 7] - - - -RFC 977 February 1986 -Network News Transfer Protocol - - -2.4.3. General Responses - - The following is a list of general response codes that may be sent by - the NNTP server. These are not specific to any one command, but may - be returned as the result of a connection, a failure, or some unusual - condition. - - In general, 1xx codes may be ignored or displayed as desired; code - 200 or 201 is sent upon initial connection to the NNTP server - depending upon posting permission; code 400 will be sent when the - NNTP server discontinues service (by operator request, for example); - and 5xx codes indicate that the command could not be performed for - some unusual reason. - - 100 help text - 190 - through - 199 debug output - - 200 server ready - posting allowed - 201 server ready - no posting allowed - - 400 service discontinued - - 500 command not recognized - 501 command syntax error - 502 access restriction or permission denied - 503 program fault - command not performed - -3. Command and Response Details - - On the following pages are descriptions of each command recognized by - the NNTP server and the responses which will be returned by those - commands. - - Each command is shown in upper case for clarity, although case is - ignored in the interpretation of commands by the NNTP server. Any - parameters are shown in lower case. A parameter shown in [square - brackets] is optional. For example, [GMT] indicates that the - triglyph GMT may present or omitted. - - Every command described in this section must be implemented by all - NNTP servers. - - - - - - -Kantor & Lapsley [Page 8] - - - -RFC 977 February 1986 -Network News Transfer Protocol - - - There is no prohibition against additional commands being added; - however, it is recommended that any such unspecified command begin - with the letter "X" to avoid conflict with later revisions of this - specification. - - Implementors are reminded that such additional commands may not - redefine specified status response codes. Using additional - unspecified responses for standard commands is also prohibited. - -3.1. The ARTICLE, BODY, HEAD, and STAT commands - - There are two forms to the ARTICLE command (and the related BODY, - HEAD, and STAT commands), each using a different method of specifying - which article is to be retrieved. When the ARTICLE command is - followed by a message-id in angle brackets ("<" and ">"), the first - form of the command is used; when a numeric parameter or no parameter - is supplied, the second form is invoked. - - The text of the article is returned as a textual response, as - described earlier in this document. - - The HEAD and BODY commands are identical to the ARTICLE command - except that they respectively return only the header lines or text - body of the article. - - The STAT command is similar to the ARTICLE command except that no - text is returned. When selecting by message number within a group, - the STAT command serves to set the current article pointer without - sending text. The returned acknowledgement response will contain the - message-id, which may be of some value. Using the STAT command to - select by message-id is valid but of questionable value, since a - selection by message-id does NOT alter the "current article pointer". - -3.1.1. ARTICLE (selection by message-id) - - ARTICLE - - Display the header, a blank line, then the body (text) of the - specified article. Message-id is the message id of an article as - shown in that article's header. It is anticipated that the client - will obtain the message-id from a list provided by the NEWNEWS - command, from references contained within another article, or from - the message-id provided in the response to some other commands. - - Please note that the internally-maintained "current article pointer" - is NOT ALTERED by this command. This is both to facilitate the - presentation of articles that may be referenced within an article - - -Kantor & Lapsley [Page 9] - - - -RFC 977 February 1986 -Network News Transfer Protocol - - - being read, and because of the semantic difficulties of determining - the proper sequence and membership of an article which may have been - posted to more than one newsgroup. - -3.1.2. ARTICLE (selection by number) - - ARTICLE [nnn] - - Displays the header, a blank line, then the body (text) of the - current or specified article. The optional parameter nnn is the - - numeric id of an article in the current newsgroup and must be chosen - from the range of articles provided when the newsgroup was selected. - If it is omitted, the current article is assumed. - - The internally-maintained "current article pointer" is set by this - command if a valid article number is specified. - - [the following applies to both forms of the article command.] A - response indicating the current article number, a message-id string, - and that text is to follow will be returned. - - The message-id string returned is an identification string contained - within angle brackets ("<" and ">"), which is derived from the header - of the article itself. The Message-ID header line (required by - RFC850) from the article must be used to supply this information. If - the message-id header line is missing from the article, a single - digit "0" (zero) should be supplied within the angle brackets. - - Since the message-id field is unique with each article, it may be - used by a news reading program to skip duplicate displays of articles - that have been posted more than once, or to more than one newsgroup. - -3.1.3. Responses - - 220 n article retrieved - head and body follow - (n = article number, = message-id) - 221 n article retrieved - head follows - 222 n article retrieved - body follows - 223 n article retrieved - request text separately - 412 no newsgroup has been selected - 420 no current article has been selected - 423 no such article number in this group - 430 no such article found - - - - - -Kantor & Lapsley [Page 10] - - - -RFC 977 February 1986 -Network News Transfer Protocol - - -3.2. The GROUP command - -3.2.1. GROUP - - GROUP ggg - - The required parameter ggg is the name of the newsgroup to be - selected (e.g. "net.news"). A list of valid newsgroups may be - obtained from the LIST command. - - The successful selection response will return the article numbers of - the first and last articles in the group, and an estimate of the - number of articles on file in the group. It is not necessary that - the estimate be correct, although that is helpful; it must only be - equal to or larger than the actual number of articles on file. (Some - implementations will actually count the number of articles on file. - Others will just subtract first article number from last to get an - estimate.) - - When a valid group is selected by means of this command, the - internally maintained "current article pointer" is set to the first - article in the group. If an invalid group is specified, the - previously selected group and article remain selected. If an empty - newsgroup is selected, the "current article pointer" is in an - indeterminate state and should not be used. - - Note that the name of the newsgroup is not case-dependent. It must - otherwise match a newsgroup obtained from the LIST command or an - error will result. - -3.2.2. Responses - - 211 n f l s group selected - (n = estimated number of articles in group, - f = first article number in the group, - l = last article number in the group, - s = name of the group.) - 411 no such news group - - - - - - - - - - - -Kantor & Lapsley [Page 11] - - - -RFC 977 February 1986 -Network News Transfer Protocol - - -3.3. The HELP command - -3.3.1. HELP - - HELP - - Provides a short summary of commands that are understood by this - implementation of the server. The help text will be presented as a - textual response, terminated by a single period on a line by itself. - - 3.3.2. Responses - - 100 help text follows - -3.4. The IHAVE command - -3.4.1. IHAVE - - IHAVE - - The IHAVE command informs the server that the client has an article - whose id is . If the server desires a copy of that - article, it will return a response instructing the client to send the - entire article. If the server does not want the article (if, for - example, the server already has a copy of it), a response indicating - that the article is not wanted will be returned. - - If transmission of the article is requested, the client should send - the entire article, including header and body, in the manner - specified for text transmission from the server. A response code - indicating success or failure of the transferral of the article will - be returned. - - This function differs from the POST command in that it is intended - for use in transferring already-posted articles between hosts. - Normally it will not be used when the client is a personal - newsreading program. In particular, this function will invoke the - server's news posting program with the appropriate settings (flags, - options, etc) to indicate that the forthcoming article is being - forwarded from another host. - - The server may, however, elect not to post or forward the article if - after further examination of the article it deems it inappropriate to - do so. The 436 or 437 error codes may be returned as appropriate to - the situation. - - Reasons for such subsequent rejection of an article may include such - - -Kantor & Lapsley [Page 12] - - - -RFC 977 February 1986 -Network News Transfer Protocol - - - problems as inappropriate newsgroups or distributions, disk space - limitations, article lengths, garbled headers, and the like. These - are typically restrictions enforced by the server host's news - software and not necessarily the NNTP server itself. - -3.4.2. Responses - - 235 article transferred ok - 335 send article to be transferred. End with . - 435 article not wanted - do not send it - 436 transfer failed - try again later - 437 article rejected - do not try again - - An implementation note: - - Because some host news posting software may not be able to decide - immediately that an article is inappropriate for posting or - forwarding, it is acceptable to acknowledge the successful transfer - of the article and to later silently discard it. Thus it is - permitted to return the 235 acknowledgement code and later discard - the received article. This is not a fully satisfactory solution to - the problem. Perhaps some implementations will wish to send mail to - the author of the article in certain of these cases. - -3.5. The LAST command - -3.5.1. LAST - - LAST - - The internally maintained "current article pointer" is set to the - previous article in the current newsgroup. If already positioned at - the first article of the newsgroup, an error message is returned and - the current article remains selected. - - The internally-maintained "current article pointer" is set by this - command. - - A response indicating the current article number, and a message-id - string will be returned. No text is sent in response to this - command. - -3.5.2. Responses - - 223 n a article retrieved - request text separately - (n = article number, a = unique article id) - - - -Kantor & Lapsley [Page 13] - - - -RFC 977 February 1986 -Network News Transfer Protocol - - - 412 no newsgroup selected - 420 no current article has been selected - 422 no previous article in this group - -3.6. The LIST command - -3.6.1. LIST - - LIST - - Returns a list of valid newsgroups and associated information. Each - newsgroup is sent as a line of text in the following format: - - group last first p - - where is the name of the newsgroup, is the number of - the last known article currently in that newsgroup, is the - number of the first article currently in the newsgroup, and

- Translation Status (on $datetimenow for $genversion) -

- ~; - -# table header -print qq ~ - - - - - ~; - -# get files -my @pofiles; -opendir(PODIR, ".") || die("Error: can't open current directory\n"); -push(@pofiles,(readdir(PODIR))); -closedir(PODIR); - -my @sorted_pofiles = sort(@pofiles); -# iterate them -my ($alang, $atran, $afuzz, $auntr, $oddeven) = (0, 0, 0, 0, 0); -foreach my $pofile (@sorted_pofiles) { - $_ = $pofile; - if (/.+\.po$/ && defined($lang{$pofile}) ) { - print STDERR "Processing $_\n"; # be a little informative - ++$alang; - my ($transage, $tran, $fuzz, $untr) = (0, 0, 0, 0); - $_ = qx{$msgfmt -c --statistics -o /dev/null $pofile 2>&1}; - if (/([0-9]+)\s+translated/) { - $tran = $1; - } - if (/([0-9]+)\s+fuzzy/) { - $fuzz = $1; - } - if (/([0-9]+)\s+untranslated/) { - $untr = $1; - } - # print STDERR "Translated [$tran] Fuzzy [$fuzz] Untranslated [$untr]\n"; - $atran += $tran; - $afuzz += $fuzz; - $auntr += $untr; - if ($lang{$pofile}->{'lazy'}) { - $tran = $tran + $fuzz; - $untr = "0"; - $fuzz = "0"; - $transage = $cage; - } else { - $_ = qx{$grep 'PO-Revision-Date:' $pofile | $cut -f2 -d:}; - if (/\s+(\d+)\-(\d+)\-(\d+)/) { - $transage = get_trans_age($1, $2, $3); - } - } - print_lang($lang{$pofile}, $tran, $fuzz, $untr, $transage, $oddeven); - $oddeven = $oddeven? 0: 1; - } -} - -# average results for the project -print "\n\n"; -print_lang($averageitem, $atran, $afuzz, $auntr, 0, 0); - -# table footer -print "

Language	Translated\|Fuzzy\|Untranslated	Percent

\n"; -print qq ~

~; - -# done blob - 7553b17506ba510e32b1af8e4ee5cb75e897e017 (mode 644) blob + /dev/null --- tools/cm-break.pl +++ /dev/null @@ -1,124 +0,0 @@ -#!/usr/bin/perl - -use 5.14.1; -use warnings; - -our $VERSION = "1.05 - 2018-10-08"; -our $cmd = $0 =~ s{.*/}{}r; - -sub usage { - my $err = shift and select STDERR; - say "usage: $cmd file ..."; - exit $err; - } # usage - -use Date::Parse; -use Getopt::Long; -GetOptions ( - "help|?" => sub { usage (0); }, - "V|version" => sub { say "$cmd [$VERSION]"; exit 0; }, - ) or usage (1); - -my %f; -foreach my $fn (@ARGV) { - - open my $fh, "<", $fn or die "$fn: $!\n"; - my ($hdr, $body) = split m/(?<=\n)(?=\r?\n)/ => do { local $/; <$fh> }, 2; - close $fh; - - $hdr && $hdr =~ m/\b(?:In-Reply-To|References)\b/i or next; - - my ($mid) = $hdr =~ m{^Message-Id: (?:[\x20\t]*\n)?[\x20\t]+ (\S.*)}xmi; - my ($dte) = $hdr =~ m{^Date: (?:[\x20\t]*\n)?[\x20\t]+ (\S.*)}xmi; - my ($irt) = $hdr =~ m{^In-Reply-To: (?:[\x20\t]*\n)?[\x20\t]+ (\S.*)}xmi; - my ($ref) = $hdr =~ m{^References: (?:[\x20\t]*\n)?[\x20\t]+ (\S.*)}xmi; - - my $stamp = str2time ($dte) or die $dte; - my $date = $stamp ? do { - my @d = localtime $stamp; - sprintf "%4d-%02d-%02d %02d:%02d:%02d", $d[5] + 1900, ++$d[4], @d[3,2,1,0]; - } : "-"; - #printf "%12s %-20s %s\n", $stamp // "-", $date, $rcv; - - $f{$fn} = { - msg_id => $mid, - refs => $ref, - irt => $irt, - date => $dte, - stamp => $stamp, - sdate => $date, - - hdr => $hdr, - body => $body, - }; - } - -foreach my $fn (sort keys %f) { - - my $c = 0; - - my $f = $f{$fn}; - if ($f->{refs}) { - $c++; - $f->{hdr} =~ s{\nReferences:.*(?:\n\s+.*)*+}{}ig; - } - if ($f->{irt}) { - $c++; - $f->{hdr} =~ s{\nIn-Reply-To:.*(?:\n\s+.*)*+}{}ig; - } - - $c or next; # No changes required - - say "$f->{msg_id} => -"; - - my @t = stat $fn; - open my $fh, ">", $fn or die "$fn: $!\n"; - print $fh $f->{hdr}, $f->{body}; - close $fh or die "$fn: $!\n"; - utime $t[8], $t[9], $fn; - } - -__END__ - -=head1 NAME - -cm-break.pl - remove mail from thread - -=head1 SYNOPSIS - - cm-break.pl ~/Mail/inbox/23 ~/Mail/inbox/45 ... - -=head1 DESCRIPTION - -This script should be called from within Claws-Mail as an action - -Define an action as - - Menu name: Unthread (break threading) - Command: cm-break.pl %F - -Then select from the message list all files that should be un-threaded - -Then invoke the action - -All of those mails will be modified (if needed): their C -and C header tags are removed from the header. - -=head1 SEE ALSO - -L, L -cm-reparent.pl - -=head1 AUTHOR - -H.Merijn Brand - -=head1 COPYRIGHT AND LICENSE - - Copyright (C) 2018-2018 H.Merijn Brand. All rights reserved. - -This library is free software; you can redistribute and/or modify it under -the same terms as Perl itself. -See the L. - -=cut blob - 30eb7fdcfefad8b94709cfbdfb8ec0fb48a21566 (mode 755) blob + /dev/null --- tools/cm-reparent.pl +++ /dev/null @@ -1,186 +0,0 @@ -#!/usr/bin/perl - -use 5.14.1; -use warnings; - -our $VERSION = "1.05 - 2018-10-08"; -our $cmd = $0 =~ s{.*/}{}r; - -sub usage { - my $err = shift and select STDERR; - say "usage: $cmd file ..."; - exit $err; - } # usage - -use Date::Parse; -use Getopt::Long; -GetOptions ( - "help|?" => sub { usage (0); }, - "V|version" => sub { say "$cmd [$VERSION]"; exit 0; }, - ) or usage (1); - -my $p; -my %f; -foreach my $fn (@ARGV) { - - open my $fh, "<", $fn or die "$fn: $!\n"; - my ($hdr, $body) = split m/(?<=\n)(?=\r?\n)/ => do { local $/; <$fh> }, 2; - close $fh; - - $hdr && $hdr =~ m/\b(?:Date|Received)\b/ or next; - - my ($mid) = $hdr =~ m{^Message-Id: (?:[\x20\t]*\n)?[\x20\t]+ (\S.*)}xmi; - my ($dte) = $hdr =~ m{^Date: (?:[\x20\t]*\n)?[\x20\t]+ (\S.*)}xmi; - my ($rcv) = $hdr =~ m{\nReceived: (?:[\x20\t]*\n)?[\x20\t]+ (\S.*(?:\n\s+.*)*+)}xi; - my ($irt) = $hdr =~ m{^In-Reply-To: (?:[\x20\t]*\n)?[\x20\t]+ (\S.*)}xmi; - my ($ref) = $hdr =~ m{^References: (?:[\x20\t]*\n)?[\x20\t]+ (\S.*)}xmi; - - $rcv ||= $dte; - $rcv =~ s/[\s\r\n]+/ /g; - $rcv =~ s/\s+$//; - $rcv =~ s/.*;\s*//; - $rcv =~ s/.* id \S+\s+//i; - my $stamp = str2time ($rcv) or die $rcv; - my $date = $stamp ? do { - my @d = localtime $stamp; - sprintf "%4d-%02d-%02d %02d:%02d:%02d", $d[5] + 1900, ++$d[4], @d[3,2,1,0]; - } : "-"; - #printf "%12s %-20s %s\n", $stamp // "-", $date, $rcv; - - $f{$fn} = { - msg_id => $mid, - refs => $ref, - irt => $irt, - date => $dte, - rcvd => $rcv, - stamp => $stamp, - sdate => $date, - - hdr => $hdr, - body => $body, - }; - - $p //= $fn; - $stamp < $f{$p}{stamp} and $p = $fn; - } - -# All but the oldest will refer to the oldest as parent - -$p or exit 0; -my $pid = $f{$p}{msg_id} or die "Parent file $p has no Message-Id\n"; - -foreach my $fn (sort keys %f) { - - $fn eq $p and next; - - my $c = 0; - - my $f = $f{$fn}; - if ($f->{refs}) { - unless ($f->{refs} eq $pid) { - $c++; - $f->{hdr} =~ s{^(?=References:)}{References: $pid\nX-}mi; - } - } - else { - $c++; - $f->{hdr} =~ s{^(?=Message-Id:)}{References: $pid\n}mi; - } - if ($f->{irt}) { - unless ($f->{irt} eq $pid) { - $c++; - $f->{hdr} =~ s{^(?=In-Reply-To:)}{In-Reply-To: $pid\nX-}mi; - } - } - else { - $c++; - $f->{hdr} =~ s{^(?=Message-Id:)}{In-Reply-To: $pid\n}mi; - } - - $c or next; # No changes required - - unless ($f->{msg_id}) { - warn "Child message $fn has no Message-Id, skipped\n"; - next; - } - - say "$f->{msg_id} => $pid"; - - my @t = stat $fn; - open my $fh, ">", $fn or die "$fn: $!\n"; - print $fh $f->{hdr}, $f->{body}; - close $fh or die "$fn: $!\n"; - utime $t[8], $t[9], $fn; - } - -__END__ - -=head1 NAME - -cm-reparent.pl - fix mail threading - -=head1 SYNOPSIS - - cm-reparent.pl ~/Mail/inbox/23 ~/Mail/inbox/45 ... - -=head1 DESCRIPTION - -This script should be called from within Claws-Mail as an action - -Define an action as - - Menu name: Reparent (fix threading) - Command: cm-reparent.pl %F - -Then select from the message list all files that should be re-parented - -Then invoke the action - -All but the oldest of those mails will be modified (if needed) to -reflect that the oldest mail is the parent of all other mails by -adding or altering the header lines C and C - -Given 4 files A, B, C, and D like - - File Message-Id Date - A 123AC_12 2016-06-01 12:13:14 - B aFFde2993 2016-06-01 13:14:15 - C 0000_1234 2016-06-02 10:18:04 - D foo_bar_12 2016-06-03 04:00:00 - -The new tree will be like - - A 123AC_12 2016-06-01 12:13:14 - +- B aFFde2993 2016-06-01 13:14:15 - +- C 0000_1234 2016-06-02 10:18:04 - +- D foo_bar_12 2016-06-03 04:00:00 - -and not like - - A 123AC_12 2016-06-01 12:13:14 - +- B aFFde2993 2016-06-01 13:14:15 - +- C 0000_1234 2016-06-02 10:18:04 - +- D foo_bar_12 2016-06-03 04:00:00 - -Existing entries of C and C in the header -of any of B, C, or D will be preserved as C or -C respectively. - -=head1 SEE ALSO - -L, L -cm-break.pl - -=head1 AUTHOR - -H.Merijn Brand - -=head1 COPYRIGHT AND LICENSE - - Copyright (C) 2016-2018 H.Merijn Brand. All rights reserved. - -This library is free software; you can redistribute and/or modify it under -the same terms as Perl itself. -See the L. - -=cut blob - f41530ba9e9c764762ff342ef2d62737596741f8 (mode 755) blob + /dev/null --- tools/convert_mbox.pl +++ /dev/null @@ -1,188 +0,0 @@ -#!/usr/bin/perl -# convert_mbox.pl -# perl script to convert mbox file to files in a new MH directory -# aka another mbox -> MH conversion tool -# 29 April 2003 -# Fred Marton -# -# Fixed (hopefully) to account for From lines -# that are of various length and that might have -# time zone info at the end -# 20 January 2004 -# -# Note: Running this with the -w flag generates the following warnings: -# Scalar value @word[1] better written as $word[1] at /path/to/convert_mbox.pl line 54 -# Scalar value @word[0] better written as $word[1] at /path/to/convert_mbox.pl line 56 -# Making these changes requires further changes in the script -# that results in much longer run-times. -# -# Copyright (c) 2003 Fred Marton -# Copyright (c) 2009 Ricardo Mones, based on the bash script -# by Daniel Dickinson [1] -# -# This program is free software; you can redistribute it and/or -# modify it under the terms of the GNU General Public License -# as published by the Free Software Foundation; either version 3 -# of the License, or (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program; if not, write to the Free Software -# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA -# 02111-1307, USA. -# -# [1] http://bugs.debian.org/cgi-bin/bugreport.cgi?msg=15;filename=convert_mbox.sh;att=1;bug=461435 - -use File::Path; -use File::Basename; - -# check for arguments -&usage if ($#ARGV < 1); -if ($ARGV[0] eq "-R") { - # recursive, need more args - &usage if ($#ARGV < 2); - &usage unless (-d $ARGV[1]); - &usage unless (-d $ARGV[2]); - &convert_all ($ARGV[1], $ARGV[2]); -} -else { - # default behaviour - &convert_mbox ($ARGV[0], $$ARGV[1]); -} - -sub strip_sbd { - # raw translation of bash, probably doable in real Perl better - $dirname = shift; - $nosbddir = ""; - $dirleft = $dirname; - while ($dirleft ne "." and $dirleft ne "") { - $enddir = &basename ($dirleft, ['.sbd']); - if ($nosbddir ne "") { - $nosbddir = "$enddir/$nosbddir"; - } - else { - $nosbddir = $enddir; - } - $dirleft = &dirname ($dirleft); - } - print "$nosbddir\n"; -} - -sub convert_all { - ($mboxdir, $targetdir) = @_; - $tmpbase = '/tmp/frommbox'; - $tmplist = '/tmp/.convert_mbox.filelist'; - $curdir = qx/pwd/; - chdir ($mboxdir); - qx/find * -type -d -a ! -name '*.*'i | sort > $tmplist/; - open (FLH, "<$tmplist") or die "cannot open $tmplist: $!\n"; - while () { - chomp; - &convert_one ($_, $targetdir, $tmpbase); - } - close (FLH); - unlink ($tmplist); - chdir ($curdir); -} - -sub convert_one { - # targetdir isn't used in the original bash script, maybe a bug? - ($file, $targetdir, $tmpbase) = @_; - $dirname = &dirname ($file); - $filename = &basename ($file); - if ($dirname eq $filename) { - $dirname = ""; - } - $dirname = &strip_sbd ($dirname); - if ($dirname ne "") { - $dirname = "/$dirname"; - } - &mkpath ($tmpbase . $dirname); - $basefile = &basename ($file); - $base1 = &basename ($file, ['.cmeta']); - $base2 = &basename ($base1, ['.ibex.index']); - $base3 = &basename ($base2, ['.ibex.index.data']); - $base5 = &basename ($base3, ['.ev-summary']); - $base4 = &basename ($base5, ['.ev-summary-meta']); - $subdir = &basename ($dirname); - $basedir = "/" . &dirname ($dirname); - if ( $basedir eq '/.' or $basedir eq '/' ) { - $basedir = $dirname; - $subdir = ""; - } - $basedir = $tmpbase . $basedir; - &mkpath ($basedir); - $dirisfile = 0; - if ( -f "$basedir/$subdir" ) { - $dirisfile = 1; - qx/mv \"$basedir\/$subdir\" \"$basedir\/$subdir.tmp\"/; - &mkpath ("$basedir/$subdir"); - } - if ( ! -d "$basedir/$subdir/$base4" ) { - print "$basedir/$subdir/$base4\n"; - &convert_mbox ($file, "$basedir/$subdir/$base4", 'quiet'); - if ($dirisfile == 1) { - qx/mv \"$basedir\/$subdir.tmp\/*\" \"$basedir\/$subdir\/\"/; - } - } -} - - -sub convert_mbox { - ($mbox, $mh, $quiet) = @_; - # check to make sure there isn't something named MH already - if (-e $mh) { - die (" The directory \"$mh\" already exists. Exiting.\n"); - } - else { - mkdir $mh; - } - # start numbering - $i = 0; - # open the mbox file - open (IN, $mbox); - while ($line = ) { - # check for the beginning of an e-mail - @word = split(/ +/m,$line); - # some lines might start with "From ", so check - # to see if the [second-to-]last word is a year - @word2 = split(/:/,$line); - chomp($word2[$#word2]); - @word3 = split(/ /,$word2[2]); - $year = @word3[1]; - # ignore the MAILER-DAEMON message from pine - if (@word[1] ne "MAILER-DAEMON") { - # start a new file, assuming $year is > 1970 - if (@word[0] eq "From" && $year > 1970) { - $i++; - close (OUT); - open (OUT, ">$mh/$i"); - print OUT $line; - } - else { - # continue the file - print OUT $line; - } - } - } - close (OUT); - close (IN); - # and we're done - if (! defined($quiet)) { - print "\n If it isn't there already, please move the directory \"$mh\"\n" - . " into your MH directory and rebuild your folder tree.\n\n"; - } -} - -sub usage { - die ("Usage: convert_mbox.pl MBOX MH_DIR\n" - . " convert_mbox.pl -R MBOXDIR MH_DIR\n" - . "Where: \n" - . " -R Converts recursively a directory of mboxes\n"); -} - - blob - cd5bef68ac859f3c54c1e68fec0f6999431954a7 (mode 755) blob + /dev/null --- tools/csv2addressbook.pl +++ /dev/null @@ -1,423 +0,0 @@ -#!/usr/bin/perl -w - -use strict; -use Getopt::Long qw(:config pass_through); -use Text::CSV_XS; - -# * This file is free software; you can redistribute it and/or modify it -# * under the terms of the GNU General Public License as published by -# * the Free Software Foundation; either version 3 of the License, or -# * (at your option) any later version. -# * -# * This program is distributed in the hope that it will be useful, but -# * WITHOUT ANY WARRANTY; without even the implied warranty of -# * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# * General Public License for more details. -# * -# * You should have received a copy of the GNU General Public License -# * along with this program; if not, write to the Free Software -# * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. -# * -# * Copyright 2007/2008 Paul Mangan -# * - -# -# Import CSV exported address books to Claws Mail -# Supported address books: -# Becky >= 2.41 -# Thunderbird >= 2.0.0.6 -# Kmail >= 1.9.7 / Kaddressbook >= 3.5.7 -# ** kmail bug: can export badly formatted csv ** -# Gmail -# Fox Mail -# - -# Becky: full export with titles -# thunderbird: export as 'comma separated' -# kmail/kaddressbook: Export CSV list -# gmail: export Outlook format -# foxmail: export with all possible headers -# basic: a csv file only containing these fields 'First Name', 'Last Name', 'Nickname', 'Email Address' - -### -my $quote_char = '"'; -my $esc_char = '"'; -my $sep_char = ','; -### - -my $script = "csv2addressbook.pl"; -my $type = ''; -my $csvfile = ''; -my $bookname = ''; -my $iNeedHelp = ''; - -my $known_types = qr/^(?:becky|thunderbird|kmail|gmail|foxmail|basic)$/; - -GetOptions("type=s" => \$type, - "csv=s" => \$csvfile, - "name=s" => \$bookname, - "help" => \$iNeedHelp); - -my @becky_fields = ('Name','E-mail Address', 'Nickname (Input shortcut)', - 'Web Page','Notes','Company','Department','Job Title', - 'Job Role','Last Name','First Name','Middle Name', - 'Birthday','Home Phone','Business Phone','Mobile Phone', - 'Fax','Street','City','State','Postal Code','Country', - 'Delivery Label'); -my @tbird_fields = ('First Name','Last Name','Display Name','Nickname', - 'Primary Email','Secondary Email','Work Phone', - 'Home Phone','Fax Number','Pager Number','Mobile Number', - 'Home Address','Home Address 2','Home City','Home State', - 'Home ZipCode','Home Country','Work Address','Work Address 2', - 'Work City','Work State','Work ZipCode','Work Country', - 'Job Title','Department','Organization','Web Page 1', - 'Web Page 2','Birth Year','Birth Month','Birth Day', - 'Custom 1','Custom 2','Custom 3','Custom 4','Notes', - 'Anniversary Year','Anniversary Month','Anniversary Day', - 'Category','Spouse name'); -my @kmail_fields = ('Formatted Name','Family Name','Given Name', - 'Additional Names','Honorific Prefixes','Honorific Suffixes', - 'Nick Name','Birthday','Home Address Street', - 'Home Address City','Home Address Region', - 'Home Address Post Code','Home Address Country', - 'Home Address Label','Business Address Street', - 'Business Address City','Business Address Region', - 'Business Address Post Code','Business Address Country', - 'Business Address Label','Home Phone','Business Phone', - 'Mobile Phone','Home Fax','Business Fax','Car Phone','ISDN', - 'Pager','Email Address','Mail Client','Title','Role', - 'Organisation','Department','Note','Homepage','Profession', - 'Assistant\'s Name','Manager\'s Name','Partner\'s Name', - 'Office','IM Address','Anniversary','Blog'); -my @gmail_fields = ('Name','E-mail Address','Notes','E-mail 2 Address', - 'E-mail 3 Address','Mobile Phone','Pager','Company', - 'Job Title','Home Phone','Home Phone 2','Home Fax', - 'Home Address','Business Phone','Business Phone 2', - 'Business Fax','Business Address','Other Phone','Other Fax', - 'Other Address','junk'); -my @foxmail_fields = ('First Name','Last Name','Name','Nickname','e-mail Address', - 'Mobile Phone','Pager Number','QQ','ICQ','Personal Home Page', - 'Sex','Birthday','Interest','Home Country','Home Province', - 'Home City','Home Postal Code','Home Street Address', - 'Home Telephone 1','Home Telephone 2','Home Fax','Office Company', - 'Office Country','Office Province','Office City', - 'Office Postal Code','Office Address','Office HomePage', - 'Office Position','Office Department','Office Telephone 1', - 'Office Telephone 2','Office Fax','Memo','foxaddrID'); -my @basic_fields = ('Nickname','e-mail Address'); - -if (grep m/claws-mail/ => `ps -U $ENV{USER}`) { - die("You must quit claws-mail before running this script\n"); -} - -if ($csvfile eq "" || $type eq "" || $type !~ m/$known_types/ || $iNeedHelp) { - if (!$iNeedHelp) { - if ($csvfile eq "") { - print "ERROR: Option csv is missing!\n"; - } - if ($type eq "") { - print "ERROR: Option type is missing!\n"; - } - if ($type && $type !~ m/$known_types/) { - print "ERROR: \"$type\" is an unknown type!\n"; - } - } - print qq~ -Usage: - $script [OPTIONS] -Options: - --help Show this screen - --type=becky|thunderbird|kmail|gmail|foxmail|basic - Type of exported address book - --csv=FILENAME Full path to CSV file - --name="My new address book" Name of new Claws address book (optional) -~; -exit; -} - -open(INPUT, "<$csvfile") || die("Can't open the CSV file [$csvfile]\n"); - my @csvlines = ; -close INPUT; - -my $config_dir = `claws-mail --config-dir` || die("ERROR: - You don't appear to have Claws Mail installed\n"); -chomp $config_dir; - -my $claws_version = `claws-mail --version`; -$claws_version =~ s/^Claws Mail version //; - -my ($major, $minor) = split(/\./, $claws_version); - -my $addr_dir; - -if (($major == 3 && $minor >= 1) || $major > 3) { - $addr_dir = "$config_dir/addrbook"; -} else { - $addr_dir = $config_dir; -} - -my $addr_index = "$addr_dir/addrbook--index.xml"; -my $csv = Text::CSV_XS->new({binary => 1, - quote_char => $quote_char, - escape_char => $esc_char, - sep_char => $sep_char}); - -my $csvtitles = shift(@csvlines); - -$csv->parse($csvtitles); -my @csvfields = $csv->fields; - -check_fields(); - -my $new_addrbook = $bookname || get_book_name(); - -my $xmlobject = write_xml(); - -chdir; - -my @filelist = (); -opendir(ADDR_DIR, $addr_dir) || die("Can't open $addr_dir directory\n"); - push(@filelist, (readdir(ADDR_DIR))); -closedir(ADDR_DIR); - -my @files = (); -foreach my $file (@filelist) { - if ($file =~ m/^addrbook/ && $file =~ m/[0-9].xml$/) { - push(@files, "$file"); - } -} - -my @sorted_files = sort {$a cmp $b} @files; -my $latest_file = pop(@sorted_files); -$latest_file =~ s/^addrbook-//; -$latest_file =~ s/.xml$//; -$latest_file++; -my $new_addrbk = "addrbook-"."$latest_file".".xml"; - -open (NEWADDR, ">$addr_dir/$new_addrbk"); -print NEWADDR $xmlobject; -close NEWADDR; - -open (ADDRIN, "<$addr_index") || die("can't open $addr_index for reading"); - my @addrindex_file = ; -close ADDRIN; - -my $rw_addrindex; -foreach my $addrindex_line (@addrindex_file) { - if ($addrindex_line =~ m/<\/book_list>/) { - $rw_addrindex .= " \n \n"; - } else { - $rw_addrindex .= "$addrindex_line"; - } -} - -open (NEWADDRIN, ">$addr_index") || die("Can't open $addr_index for writing"); -print NEWADDRIN "$rw_addrindex"; -close NEWADDRIN; - -print "Done. Address book imported successfully.\n"; - -exit; - -sub get_book_name { - if ($type eq "becky") { - return("Becky address book"); - } elsif ($type eq "thunderbird") { - return("Thunderbird address book"); - } elsif ($type eq "kmail") { - return("Kmail address book"); - } elsif ($type eq "gmail") { - return("gmail address book"); - } elsif ($type eq "foxmail") { - return("foxmail address book"); - } elsif ($type eq "basic") { - return("basic address book"); - } -} - -sub check_fields { - if ($type eq "becky") { - if ($#csvfields != $#becky_fields) { - die("ERROR:\n\tInvalid field count!\n" - ."\tYou need to do a Full Export With Titles\n"); - } - } elsif ($type eq "thunderbird") { - if ($#csvfields != $#tbird_fields) { - die("ERROR:\n\tInvalid field count!\n" - ."\tProblem with your exported CSV file\n"); - } - } elsif ($type eq "kmail") { - if ($#csvfields != $#kmail_fields) { - die("ERROR:\n\tInvalid field count!\n" - ."\tProblem with your exported CSV file\n"); - } - } elsif ($type eq "gmail") { - if ($#csvfields != $#gmail_fields) { - die("ERROR:\n\tInvalid field count!\n" - ."\tProblem with your exported CSV file\n"); - } - } elsif ($type eq "foxmail") { - if ($#csvfields != $#foxmail_fields) { - die("ERROR:\n\tInvalid field count!\n" - ."\tProblem with your exported CSV file\n"); - } - } elsif ($type eq "basic") { - if ($#csvfields != $#basic_fields) { - die("ERROR:\n\tInvalid field count!\n" - ."\tProblem with your exported CSV file\n"); - } - } -} - -sub write_xml { - my @std_items = get_items(); - my @input_fields = get_fields(); - - my $time = time; - my $xml = "\n" - ."\n "; - - my $prev_line; - - foreach my $line (@csvlines) { - $csv->parse($line); - my @fields = $csv->fields; - # check if an entry contains line breaks - if ($#fields != $#input_fields) { - if ($prev_line) { - my $concat_line = $prev_line.$line; - $csv->parse($concat_line); - @fields = $csv->fields; - if ($#fields != $#input_fields) { - $concat_line =~ s/\r\n$/ /; - $concat_line =~ s/\n$/ /; - $prev_line = $concat_line; - next; - } - } else { - $line =~ s/\r\n$/ /; - $line =~ s/\n$/ /; - $prev_line = $line; - next; - } - } - $prev_line = ''; - - @fields = escape_fields(@fields); - - $xml .= "\n "; - $time++; - if ($type eq "thunderbird") { - $xml .= "\n " - ."

\n"; - $time++; - if ($fields[$std_items[5]]) { - $xml .="

\n"; - } - $xml .= " \n"; - } elsif ($type eq "foxmail") { - $xml .= "\n "; - if ($fields[$std_items[4]] =~ m/,/) { - my @addrs = split(",", $fields[$std_items[4]]); - my $addr_one = pop(@addrs); - $xml .= "

\n"; - foreach my $eaddr (@addrs) { - $time++; - $xml .= "

\n"; - } - } else { - $xml .= "

\n"; - } - $xml .= " \n"; - } else { - $xml .= "\n " - ."

\n" - ." \n"; - } - $xml .= "\n"; - foreach my $item (@std_items) { - delete($fields[$item]); - } - foreach my $field (0 .. $#fields) { - if ($fields[$field]) { - $time++; - $xml .= " " - ."$fields[$field]\n"; - } - } - $xml .= " \n " - ."\n"; - $time++; - } - - $xml .= "\n"; - - return $xml; -} - -sub get_items { - if ($type eq "becky") { - return ('10','9','2','0','1','4'); - } elsif ($type eq "thunderbird") { - return ('0','1','3','2','4','5','38'); - } elsif ($type eq "kmail") { - return ('2','1','6','0','28','34'); - } elsif ($type eq "gmail") { - return('0','0','0','0','1','2'); - } elsif ($type eq "foxmail") { - return ('0','1','3','2','4','33'); - } elsif ($type eq "basic") { - return ('0','0','0','0','1','0'); - } -} - -sub get_fields { - if ($type eq "becky") { - return(@becky_fields); - } elsif ($type eq "thunderbird") { - return(@tbird_fields); - } elsif ($type eq "kmail") { - return(@kmail_fields); - } elsif ($type eq "gmail") { - return(@gmail_fields); - } elsif ($type eq "foxmail") { - return(@foxmail_fields); - } elsif ($type eq "basic") { - return (@basic_fields); - } -} - -sub escape_fields { - my (@fields) = @_; - - for (my $item = 0; $item <= $#fields; $item++) { - $fields[$item] =~ s/^"//; - $fields[$item] =~ s/"$//; - $fields[$item] =~ s/"/"/g; - $fields[$item] =~ s/&/&/g; - $fields[$item] =~ s/'/'/g; - $fields[$item] =~ s//>/g; - } - - return @fields; -} - blob - b7d5f58fd46d017676136bf9b05b44470448ea38 (mode 755) blob + /dev/null --- tools/ddg_search.pl +++ /dev/null @@ -1,62 +0,0 @@ -#!/usr/bin/perl - -# * Copyright 2003-2019 Paul Mangan -# * -# * This file is free software; you can redistribute it and/or modify it -# * under the terms of the GNU General Public License as published by -# * the Free Software Foundation; either version 3 of the License, or -# * (at your option) any later version. -# * -# * This program is distributed in the hope that it will be useful, but -# * WITHOUT ANY WARRANTY; without even the implied warranty of -# * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# * General Public License for more details. -# * -# * You should have received a copy of the GNU General Public License -# * along with this program; if not, write to the Free Software -# * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. -# * - -# Changes: -# Feb 2007: add support for non ISO-8859-1 compatible locales -# by Alex Gorbachenko -# - -use URI::Escape; -use POSIX qw(locale_h); -use locale; -use Text::Iconv; - -my $ddg = "https://duckduckgo.com/?q"; -$_ = <>; - -$locale = setlocale(LC_CTYPE); -$locale =~ s/\S+\.//; - -$converter = Text::Iconv->new("$locale", "UTF-8"); -$safe=uri_escape($converter->convert("$_")); - -my $config_dir = `claws-mail --config-dir` or die("ERROR: - You don't appear to have Claws Mail installed\n"); -chomp $config_dir; - -chdir($ENV{HOME} . "/$config_dir") or die("ERROR: - Claws Mail config directory not found [~/$config_dir] - You need to run Claws Mail once, quit it, and then rerun this script\n"); - -open (CMRC, "; -close CMRC; - -foreach $rcline (@rclines) { - if ($rcline =~ m/^uri_open_command/) { - chomp $rcline; - @browser = split(/=/, $rcline); - $browser[1] =~ s/%s/$ddg=$safe/; - } -} -system("$browser[1]&"); - -exit; - - blob - 5794e3b0050926832c2a436920e5a865ae6d4069 (mode 755) blob + /dev/null --- tools/eud2gc.py +++ /dev/null @@ -1,69 +0,0 @@ -#!/usr/bin/env python3 - -import string, sys - - -def lReadEfile(sFileName): - try: - sLines = open(sFileName).read() - except: - print ('Error opening %s' %sFileName) - lLines = [] - lLines = sLines.split('\n') - return lLines - - -def dElines2Dict(lElines): - dAliases = {} - for sEntry in lElines: - if '"' in sEntry: - lChunks = sEntry.split('"') - else: - lChunks = sEntry.split(' ') - if lChunks[0] != 'alias': - print ('ignoring invalid line: %s' %sEntry) - else: - sAdresses = lChunks[2:].join(',') - print ('Entry added: %s %s' %(lChunks[1],sEntry)) - dAliases[lChunks[1]]=sAdresses - return dAliases - - -def vWriteGfile(dAliases, sFileName): - try: - oFile = open(sFileName, 'w') - except: - print ('Error opening %s' %sFileName) - return 0 - for sKey in dAliases.keys(): - #print ('BEGIN:VCARD') - #print ('N:;%s' %sKey) - #print ('BDAY:') - #print ('ADR;HOME:;;;;;;') - #print ('TEL:;') - #print ('EMAIL;INTERNET:%s' %dAliases[sKey]) - #print ('END:VCARD') - oFile.write ('BEGIN:VCARD\n') - oFile.write ('FN:%s\n' %sKey) - oFile.write ('N:;%s\n' %sKey) - oFile.write ('BDAY:\n') - oFile.write ('ADR;HOME:;;;;;;;\n') - oFile.write ('TEL:;\n') - oFile.write ('EMAIL;INTERNET:%s\n' %dAliases[sKey]) - oFile.write ('END:VCARD\n') - oFile.close() - return 1 - - -if __name__ == '__main__': - if len(sys.argv) >= 3: - sEfileName = sys.argv[1] - sGfileName = sys.argv[2] - lAliases = lReadEfile(sEfileName) - dAliases = dElines2Dict(lAliases) - if vWriteGfile(dAliases, sGfileName) == 1: - print ('Done!') - else: - print ('Error saving output-file') - else: - print ('Usage:\n %s ' %sys.argv[0]) blob - fec94e819a28be665543e3b06b6435dffb733118 (mode 755) blob + /dev/null --- tools/filter_conv.pl +++ /dev/null @@ -1,172 +0,0 @@ -#!/usr/bin/perl -w -use strict; - -# * Copyright 2002 Paul Mangan -# * -# * Reimplemented by Torsten Schoenfeld -# * -# * This file is free software; you can redistribute it and/or modify it -# * under the terms of the GNU General Public License as published by -# * the Free Software Foundation; either version 3 of the License, or -# * (at your option) any later version. -# * -# * This program is distributed in the hope that it will be useful, but -# * WITHOUT ANY WARRANTY; without even the implied warranty of -# * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# * General Public License for more details. -# * -# * You should have received a copy of the GNU General Public License -# * along with this program; if not, write to the Free Software -# * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. -# * - -my $old_config_dir = "$ENV{HOME}/.sylpheed"; -my $config_dir = `claws-mail --config-dir`; -chomp $config_dir; - -chdir($ENV{ HOME } . "/$config_dir") - or die("You don't appear to have Claws Mail installed\n"); - -############################################################################### - -my $normal_headers = qr/^(?:Subject|From|To|Cc)$/; - -my @new_filters = ("[global]\n"); - -############################################################################### - -my $mailbox; - -open(FOLDERLIST, "<$old_config_dir/folderlist.xml") - or die("Can't find '$old_config_dir/folderlist.xml'\n"); - while () { - if (m/) { - chomp(); - - my ($header_one, - $value_one, - $op, - $header_two, - $value_two, - $destination, - $mode_one, - $mode_two, - $action) = split(/\t/); - - $value_one =~ s/\"/\\\"/g ; - $value_two =~ s/\"/\\\"/g ; - $action = $action eq "m" ? "move" : "delete"; - $destination = $destination =~ m!^\#mh/! ? - $destination : - "#mh/$mailbox/$destination"; - - my ($predicate_one, - $predicate_two, - $match_type_one, - $match_type_two, - $new_filter); - - ########################################################################### - - if ($mode_one % 2 == 0) { - $predicate_one = "~"; - } - else { - $predicate_one = ""; - } - - if ($mode_one <= 1) { - $match_type_one = "matchcase"; - } - else { - $match_type_one = "regexpcase"; - } - - ########################################################################### - - if ($mode_two % 2 == 0) { - $predicate_two = "~"; - } - else { - $predicate_two = ""; - } - - if ($mode_two <= 1) { - $match_type_two = "matchcase"; - } - else { - $match_type_two = "regexpcase"; - } - - ########################################################################### - - if ($header_one eq "To" && $header_two eq "Cc" || - $header_one eq "Cc" && $header_two eq "To" and - $value_one eq $value_two and - $mode_one eq $mode_two and - $op eq "|") { - if ($action eq "move") { - $new_filter = $predicate_one . qq(to_or_cc $match_type_one "$value_one" move "$destination"\n); - } - else { - $new_filter = $predicate_one . qq(to_or_cc $match_type_one "$value_one" delete\n); - } - } - else { - if ($header_one =~ m/$normal_headers/) { - $new_filter .= $predicate_one . lc($header_one) . qq( $match_type_one "$value_one"); - } - else { - $new_filter .= $predicate_one . qq(header "$header_one" $match_type_one "$value_one"); - } - - if ($op ne " ") { - if ($header_two =~ m/$normal_headers/) { - $new_filter .= qq( $op ) . $predicate_two . lc($header_two) . qq( $match_type_two "$value_two"); - } - else { - $new_filter .= qq( $op ) . $predicate_two . qq(header "$header_two" $match_type_two "$value_two"); - } - } - - if (defined($new_filter)) { - if ($action eq "move") { - $new_filter .= qq( move "$destination"\n); - } - else { - $new_filter .= qq(delete\n); - } - } - } - - ########################################################################### - - push(@new_filters, $new_filter) if (defined($new_filter)); - } -close(FILTERRC); - -############################################################################### - -open(MATCHERRC, ">>matcherrc"); - print MATCHERRC @new_filters; -close(MATCHERRC); - -print "Converted $#new_filters filters\n"; - -if ($old_config_dir eq $config_dir) { - rename("filterrc", "filterrc.old"); - print "Renamed your old filter rules ('filterrc' to 'filterrc.old')\n"; -} -############################################################################### - blob - 4bae1bc03d944e347c82253ccd558959d3680ee5 (mode 755) blob + /dev/null --- tools/filter_conv_new.pl +++ /dev/null @@ -1,279 +0,0 @@ -#!/usr/bin/perl -w - -use strict; -use XML::SimpleObject; - -# * This file is free software; you can redistribute it and/or modify it -# * under the terms of the GNU General Public License as published by -# * the Free Software Foundation; either version 3 of the License, or -# * (at your option) any later version. -# * -# * This program is distributed in the hope that it will be useful, but -# * WITHOUT ANY WARRANTY; without even the implied warranty of -# * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# * General Public License for more details. -# * -# * You should have received a copy of the GNU General Public License -# * along with this program; if not, write to the Free Software -# * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. -# * -# * Copyright 2006 Paul Mangan -# * - -# -# Convert new style Sylpheed filter rules (Sylpheed >= 0.9.99) to -# Claws Mail filtering rules -# - -# -# TABLE OF EQUIVALENTS -# -# SYLPHEED : Claws Mail -#------------------------------------------------------ -# -# NAME -# -# name : rulename -# -# CONDITION LIST -# -# bool or : | -# bool and : & -# -# match-header (name From) : from -# match-header (name To) : to -# match-header (name Cc) : cc -# match-header (name Subject) : subject -# else... -# match-header : header -# -# match-header (type contains) : [nothing] -# match-header (type not-contain) : [append with ~] -# match-header (type is) : [no equivalent] (use type contains) -# match-header (type is-not) : [no equivalent] (use type not-contain) -# match-header (type regex) : regexpcase -# match-header (type not-regex) : regexpcase [append with ~] -# -# matcher-any-header ; headers-part -# match-to-or-cc : to_or_cc -# match-body-text : body_part -# command-test : test -# size (type gt) : size_greater -# size (type lt) : size_smaller -# age (type gt) : age_greater -# age (type lt) : age_lower -# -# ACTION LIST -# -# move : move -# copy : copy -# not-receive : [no equivalent] (use type delete) -# delete : delete -# mark : mark -# color-label : color -# mark-as-read : mark_as_read -# exec : execute -# stop-eval : stop -# - -my $old_config = "$ENV{HOME}/.sylpheed-2.0/filter.xml"; -my $older_config = "$ENV{HOME}/.sylpheed/filter.xml"; -my $old_filters; - -my $config_dir = `claws-mail --config-dir` or die("ERROR: - You don't appear to have Claws Mail installed\n"); -chomp $config_dir; - -chdir($ENV{HOME} . "/$config_dir") or die("ERROR: - Claws Mail config directory not found [~/$config_dir] - You need to run Claws Mail once, quit it, and then rerun this script\n"); - -if (-e $old_config) { - $old_filters = $old_config; -} elsif (-e $older_config) { - $old_filters = $older_config; -} else { - print "ERROR:\n\tSylpheed filter not found\n\t[$old_config]\n\t[$older_config]\n"; - exit; -} - -my $claws_version = `claws-mail --version`; -$claws_version =~ s/^Claws Mail version //; - -my ($major, $minor) = split(/\./, $claws_version); - -my $version_test = 0; -if ($major > 2 || ($major == 2 && $minor >= 3)) { - $version_test = 1; -} - -my $parser = XML::Parser->new(ErrorContext => 2, Style => "Tree"); -my $xmlobj = XML::SimpleObject->new($parser->parsefile($old_filters)); - -my @conditions = ('match-header','match-to-or-cc','match-any-header', - 'match-body-text','command-test','size','age'); - -my @actions = ('copy','not-receive','mark','color-label','mark-as-read', - 'exec','stop-eval','move','delete'); - -my $standard_headers = qr/^(?:Subject|From|To|Cc)$/; -my $negative_matches = qr/^(?:not-contain|is-not|not-regex)$/; -my $numeric_matches = qr/^(?:size|age)$/; -my $exact_matches = qr/^(?:move|copy|delete|mark)$/; - -my @new_filters = ("[filtering]"); - -my $disabled = 0; -my $bool; - -## rules list -foreach my $element ($xmlobj->child("filter")->children("rule")) { - my $new_filter = "\n"; - if ($element->attribute("enabled")) { - if ($element->attribute("enabled") eq "false") { - if ($version_test) { - $new_filter .= "disabled "; - } else { - $disabled++; - next; # skip disabled rules - } - } elsif ($version_test) { - $new_filter .= "enabled "; - } - } - if ($element->attribute("name")) { - my $name = $element->attribute("name"); - $name = clean_me($name); - $new_filter .= "rulename \"$name\" "; - } -## condition list - foreach my $parent ($element->children("condition-list")) { - if ($parent->attribute("bool")) { - $bool = $parent->attribute("bool"); - $bool =~ s/or/|/; - $bool =~ s/and/&/; - } - foreach my $condition (@conditions) { - my $new_condition = 0; - my $type; - if ($parent->children("$condition")) { - foreach my $sibling ($parent->children("$condition")) { - if ($new_condition) { - $new_filter .= " $bool "; - } - if ($sibling->attribute("type")) { - $type = $sibling->attribute("type"); - if ($type =~ m/$negative_matches/) { - $new_filter .= '~'; - } - } - if ($sibling->attribute("name")) { - my $name = $sibling->attribute("name"); - if ($condition eq "match-header") { - if ($name =~ m/$standard_headers/) { - $new_filter .= lc($name) . " "; - } else { - $new_filter .= "header \"$name\" "; - } - } - } - if ($condition eq "match-any-header") { - $new_filter .= "headers_part "; - } elsif ($condition eq "match-header-content") { - $new_filter .= "headers_cont "; - } elsif ($condition eq "match-to-or-cc") { - $new_filter .= "to_or_cc "; - } elsif ($condition eq "match-body-text") { - $new_filter .= "body_part "; - } elsif ($condition eq "command-test") { - $new_filter .= "test "; - } elsif ($condition eq "size") { - if ($type eq "gt") { - $new_filter .= "size_greater "; - } else { - $new_filter .= "size_smaller "; - } - } elsif ($condition eq "age") { - if ($type eq "gt") { - $new_filter .= "age_greater "; - } else { - $new_filter .= "age_lower "; - } - } - if ($condition !~ m/$numeric_matches/ && - $condition ne "command-test") { - if ($type =~ m/regex/) { - $new_filter .= "regexpcase "; - } else { - $new_filter .= "matchcase "; - } - } - my $value = clean_me($sibling->value); - if ($condition =~ m/$numeric_matches/) { - $new_filter .= "$value"; - } else { - $new_filter .= "\"$value\""; - } - $new_condition++; - } - } - } - } -## end of condition list -## action list - foreach my $parent ($element->children("action-list")) { - foreach my $action (@actions) { - if ($parent->children("$action")) { - foreach my $sibling ($parent->children("$action")) { - if ($action =~ m/$exact_matches/) { - $new_filter .= " $action"; - } elsif ($action eq "not-receive") { - $new_filter .= " delete"; - } elsif ($action eq "color-label") { - $new_filter .= " color"; - } elsif ($action eq "mark-as-read") { - $new_filter .= " mark_as_read"; - } elsif ($action eq "exec") { - $new_filter .= " execute"; - } elsif ($action eq "stop-eval") { - $new_filter .= " stop"; - } - if ($sibling->value) { - my $value = clean_me($sibling->value); - if ($action eq "color-label") { - $new_filter .= " $value"; - } else { - $new_filter .= " \"$value\""; - } - } - } - } - } - } -## end of action list - push(@new_filters, $new_filter) if (defined($new_filter)); -} -## end of rules list -push(@new_filters, "\n"); - -# write new config -open(MATCHERRC, ">>matcherrc"); - print MATCHERRC @new_filters; -close(MATCHERRC); - -print "Converted ". ($#new_filters-1) . " filters\n"; -if ($disabled) { - print "[$disabled disabled filter(s) not converted]\n"; -} - -exit; - -sub clean_me { - my ($dirty) = @_; - - $dirty =~ s/\"/\\\"/g; - $dirty =~ s/\n/ /g; - - return $dirty; -} - blob - 379807d68b5f918fcc32c128b308667fd0649bd7 (mode 755) blob + /dev/null --- tools/fix_date.sh +++ /dev/null @@ -1,275 +0,0 @@ -#!/bin/sh - -# * Copyright 2004 Tristan Chabredier -# * -# * This file is free software; you can redistribute it and/or modify it -# * under the terms of the GNU General Public License as published by -# * the Free Software Foundation; either version 3 of the License, or -# * (at your option) any later version. -# * -# * This program is distributed in the hope that it will be useful, but -# * WITHOUT ANY WARRANTY; without even the implied warranty of -# * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# * General Public License for more details. -# * -# * You should have received a copy of the GNU General Public License -# * along with this program; if not, write to the Free Software -# * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. -# -# fix_date.sh helper script to fix non-standard date or add missing -# date header to emails - -# usage: fix_date.sh [ ..] -# It will replace the Date: value w/ the one picked up from more recent -# Fetchinfo time header, Received: field.. Otherwise, it will take the file -# modification time (using a RFC 2822-compliant form). -# Any already existing X-Original-Date is kept, if missing we're adding it -# if the Date: was set (even if set w/ non conform value) - -# TODO: fallback to X-OriginalArrivalTime: ? - -VERSION="0.1.4" - - -version() -{ - echo "$VERSION" - exit 0 -} - -usage() -{ - echo "usage:" - echo " ${0##*/} [] [ ..]" - echo "switches:" - echo " -h --help display this help then exit" - echo " -v --version display version information then exit" - echo " -d --debug turn on debug information (be more verbose)" - echo " -f --force always force (re-)writing of Date: header" - echo " -r --rfc force re-writing of Date: header when it's not RFC-compliant" - echo " -s --strict use RFC-strict matching patterns for dates" - echo " -- end of switches (in case a filename starts with a -)" - echo "this script requires coreutils (cat, cut, head, tr), dos2unix, grep and set" - echo "in PATH to work" - exit $1 -} - -date_valid() -{ - test $STRICT -eq 1 && \ - REGEXP="$DATE_REGEXP_STRICT" || \ - REGEXP="$DATE_REGEXP" - - echo "$1" | grep -qEim 1 "$REGEXP" - DATE_VALID=$? -} - -dump_date_fields() -{ - test -z "$X_ORIGINAL_DATE" -a -n "$DATE" && \ - echo "X-Original-Date:$DATE" >> "$TMP" - echo "Date:$REPLACEMENT_DATE" >> "$TMP" -} - - -# use --force to always (re-)write the Date header -# otherwise, the Date header will be written if only it doesn't exist -FORCE=0 -# use --rfc to (re-)write the Date header when it's not RFC-compliant -# otherwise, the Date header will be written if only it doesn't exist -RFC=0 -# use --debug to display more information about what's performed -DEBUG=0 -# use --strict to use strict matching patterns for date validation -STRICT=0 -# 0 = valid, always valid until --strict is used, then date_valid overrides this value -DATE_VALID=0 -# max header lines (300 is a reasonable minimum value but 600 has already been encountered, set to 1000 by security) -MAX_HEADER_LINES=1000 - -while [ -n "$1" ] -do - case "$1" in - -h|--help) usage 0;; - -v|--version) version;; - -f|--force) FORCE=1;; - -d|--debug) DEBUG=1;; - -r|--rfc) RFC=1;; - -s|--strict) STRICT=1;; - --) shift - break;; - -*) echo "error: unrecognized switch '$1'" - usage 1;; - *) break;; - esac - shift -done - -if [ $FORCE -eq 1 -a $RFC -eq 1 ] -then - echo "error: use either --force or --rfc, but not both at the same time" - usage 1 -fi - -test $# -lt 1 && \ - usage 1 - -for PROG in dos2unix grep sed -do - type "$PROG" >/dev/null 2>&1 || \ - { echo "error: $PROG not found in PATH"; exit 1; } -done - -TMPDIR="/tmp" -TMP="$TMPDIR/${0##*/}.$$.tmp" -echo > "$TMP" >/dev/null 2>&1 -if [ $? -eq 0 ] -then - rm -f "$TMP" >/dev/null 2>&1 -else - TMPDIR="$HOME" - TMP="$TMPDIR/${0##*/}.$$.tmp" -fi -HEADERS="$TMPDIR/${0##*/}.$$.headers.tmp" -BODY="$TMPDIR/${0##*/}.$$.body.tmp" - -DATE_REGEXP='( (Mon|Tue|Wed|Thu|Fri|Sat|Sun),)? [0-9]+ (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]+ [0-9]+:[0-9]+:[0-9]+ [+-]?[0-9]+' -DATE_REGEXP_STRICT='(Mon|Tue|Wed|Thu|Fri|Sat|Sun), [0-9]+ (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]+ [0-9]+:[0-9]+:[0-9]+ [+-]?[0-9]+' - -while [ -n "$1" ] -do - # skip if file is empty or doesn't exist - if [ ! -s "$1" ] - then - test $DEBUG -eq 1 && \ - echo "$1: no found or empty, skipping" - shift - continue - fi - SKIP=0 - - # split headers and body - # find the empty line that separates body (if any) from headers, - # work on a temporary dos2unix'ed copy because body might - # contain DOS CRLF and grep '^$' won't work - head -$MAX_HEADER_LINES "$1" | dos2unix > "$TMP" - SEP=`grep -nEm1 "^$" "$TMP" 2>/dev/null | cut -d ':' -f 1` - rm -f "$TMP" - if [ -z "$SEP" -o "$SEP" = "0" -o $? -ne 0 ] - then - cp -f "$1" "$HEADERS" - :> "$BODY" - test $DEBUG -eq 1 && \ - echo "$1: no body part could be found before line $MAX_HEADER_LINES" - else - sed -n '1,'`expr $SEP - 1`'p' "$1" > "$HEADERS" - sed '1,'`expr $SEP - 1`'d' "$1" > "$BODY" - fi - - # work on headers only - - # get the Date and X-Original-Date - X_ORIGINAL_DATE=`sed -n '/^X-Original-Date:/,/^[^\t]/p' "$HEADERS" | head -n -1 | cut -d ':' -f 2-` - DATE=`sed -n '/^Date:/,/^[^\t]/p' "$HEADERS" | head -n -1 | cut -d ':' -f 2-` - - # work on headers, minus Date and X-Original-Date - test -n "$X_ORIGINAL_DATE" && \ - sed -i '/^X-Original-Date:/,/^[^\t]/d' "$HEADERS" - test -n "$DATE" && \ - sed -i '/^Date:/,/^[^\t]/d' "$HEADERS" - - # find a replacement date in Fetchinfo: header - FETCH_DATE=`grep -im1 'X-FETCH-TIME: ' "$HEADERS" | cut -d ' ' -f 2-` - - # or in Received: headers .. - test $STRICT -eq 1 && \ - REGEXP="$DATE_REGEXP" || \ - REGEXP="$DATE_REGEXP_STRICT" - RECEIVED_DATE=`sed -n '/^Received:/,/^[^\t]/p' "$HEADERS" | head -n -1 | grep -Eoim 1 "$REGEXP"` - - # .. or from file properties - FILE_DATE=`LC_ALL=POSIX LANG=POSIX ls -l --time-style="+%a, %d %b %Y %X %z" "$1" | tr -s ' ' | cut -d ' ' -f 6-11` - # we could also use the system date as a possible replacement - SYSTEM_DATE="`date -R`" - - # determine which replacement date to use - if [ -z "$FETCH_DATE" ] - then - if [ -z "$RECEIVED_DATE" ] - then - # don't forget the leading whitespace here - REPLACEMENT_DATE=" $FILE_DATE" - REPLACEMENT="file date" -# REPLACEMENT_DATE=" $SYSTEM_DATE" -# REPLACEMENT="system date" - else - REPLACEMENT_DATE="$RECEIVED_DATE" - REPLACEMENT="received date" - fi - else - # don't forget the leading whitespace here - REPLACEMENT_DATE=" $FETCH_DATE" - REPLACEMENT="Fetchinfo time header" - fi - - # ensure that the original X-Original-Date is kept - :> "$TMP" - if [ -n "$X_ORIGINAL_DATE" ] - then - echo "X-Original-Date:$X_ORIGINAL_DATE" >> "$TMP" - fi - - # replace/set the date and write all lines - test $RFC -eq 1 && \ - date_valid "$DATE" - if [ -z "$DATE" ] - then - test $DEBUG -eq 1 && \ - echo "$1: date not found, using $REPLACEMENT now" - dump_date_fields - else - if [ $FORCE -eq 1 ] - then - test $DEBUG -eq 1 && \ - echo "$1: date already found, replacing with $REPLACEMENT" - dump_date_fields - else - if [ $RFC -eq 1 ] - then - if [ $DATE_VALID -ne 0 ] - then - test $DEBUG -eq 1 && \ - echo "$1: date already found but not RFC-compliant, replacing with $REPLACEMENT" - dump_date_fields - else - test $DEBUG -eq 1 && \ - echo "$1: date already found and RFC-compliant, skipping" - SKIP=1 - fi - else - test $DEBUG -eq 1 && \ - echo "$1: date already found, skipping" - SKIP=1 - fi - fi - fi - - if [ $SKIP -eq 0 ] - then - # uncomment the following line to backup the original file - #mv -f "$1" "$1.bak" - - cat "$HEADERS" >> "$TMP" - cat "$BODY" >> "$TMP" - mv -f "$TMP" "$1" - if [ $? -ne 0 ] - then - echo "error while moving '$TMP' to '$1'" - exit 1 - fi - fi - rm -f "$HEADERS" "$BODY" "$TMP" >/dev/null 2>&1 - - shift -done -exit 0 blob - 10dea1a0f98db72c57ff6f7cac206bb3eb3ffa4f (mode 755) blob + /dev/null --- tools/gif2xface.pl +++ /dev/null @@ -1,98 +0,0 @@ -#!/usr/bin/perl -# -# gif2xface -- converts a 48x48 GIF file to an X-Face mail header -# -# Author: Ricardo Mones -# -# This is a hack over the original xbm2face script. The xbm files generated -# by some graphic tools (notably The Gimp version 1.2.1) aren't suitable to -# feed the compface program. Starting with a GIF and using some filters does -# the trick. A little help screen also added. -# This requieres giftopnm and pbmtoxbm (both in libgr-progs package). -# -# The original xbm2face author's comment follows: -# -# xbm2xface -- converts a 48x48 xbm file to an X-Face mail header -# -# Author: Jonathan Stigelman -# -# URL: http://hackvan.com/pub/stig/src/linux/ -# FTP: hackvan.com:/pub/stig/src/linux/ -# -# This is a Perl script that I wrote to convert 48x48 xbm (X bitmap) files -# into X-Face: headers suitable for inclusion in RFC822 internet -# electronic mail. A 48x48 bitmap is awfully small, but X-Faces are still -# good enough for other people to visually establish your identity in -# email without having to carefully read your name. -# -# Basically, it gets you noticed...either as the person with the cool -# X-Face or as that jerk with modem noise in all of his email messages. -# -# People will start looking over your shoulder and say "Hey Cool! How'd -# you do that?" When they do, you just send 'em to my URL for this -# utility and tell 'em to upgrade to a real mail reader: XEmacs and VM. -# -# It also requires the 'compface' utility. -# - -sub check_for_help { - local($param) = @_; - - # is a filter, no args must be present - if (defined($param)) - { - print "\n", 'gif2xface -- A filter for converting an 48x48 gif into a xface string', "\n\n" ; - print 'Usage: gif2xface < input.gif > output.xface', "\n\n"; - exit; - } -} - -sub reverse_byte { - local($byte) = @_; - local($n, $b); - for ( $b= $n= 0; $b<8; ++$b) { - $n |= (($byte & 1) << (7-$b)); - $byte >>= 1; - } - return($n); -} - - -&check_for_help($ARGV[0]); - -# printf "0x%02x\n", &reverse_byte(0xF0); - -$ra = rand; -$tf = "/tmp/gif2xface.$ra"; -open(GP,"|giftopnm|pbmtoxbm>$tf"); - -while (<>) { - print GP $_; -} -close(GP); -open(GP,"<$tf"); -; -m/^#define \w+_width (\d+)/ && ($width=$1); -; -m/^#define \w+_height (\d+)/ && ($height=$1); -; -m/^static.* = \{/ && (( $width == 48 && $height == 48 ) - || die $0, ": sorry, xfaces must be 48x48 pixels" ); - -$| = 1; print "X-Face:"; - -open(CF,"|compface"); - -while () { - $st=""; - while (s/(0x..)(,|\};)\s*//) { - $st .= sprintf("0x%02x, ", &reverse_byte(eval($1))); - } - $_=$st; - s/(0x..), 0x(..)/\1\2/g; - s/\s*(0x...., 0x...., 0x....)(,|\};)\s/\1,\n/g; - print CF $_; -} -close (CF); -close (GP); -unlink $tf; blob - e331a5b66f9132dedd2d83da5a353b0bc206076d (mode 755) blob + /dev/null --- tools/gitlog2changelog.py +++ /dev/null @@ -1,145 +0,0 @@ -#!/usr/bin/env python3 -# Copyright 2008 Marcus D. Hanwell -# Adapted for Claws Mail - Copyright 2013 Colin Leroy -# Distributed under the terms of the GNU General Public License v2 or later - -import string, re, os, sys - -curRev = "" -prevVer = "" - -if len(sys.argv) == 3: - curRev = sys.argv[2] - prevVer = sys.argv[1] -else: - curRevCmd = os.popen("git describe") - curRev = curRevCmd.read() - curRev = curRev[0:len(curRev)-1] - curRevCmd.close() - if len(sys.argv) == 2: - prevVer = sys.argv[1] - else: - prevVer = re.split('-', curRev, 1)[0] - -# Execute git log with the desired command line options. -fin = os.popen('git log ' + prevVer + '..' + curRev +' --summary --stat --no-merges --date=short', 'r') -# Create a ChangeLog file in the current directory. -fout = sys.stdout - -# Set up the loop variables in order to locate the blocks we want -authorFound = False -dateFound = False -messageFound = False -filesFound = False -message = "" -commit = "" -messageNL = False -files = "" -prevAuthorLine = "" - -# The main part of the loop -for line in fin: - # The commit line marks the start of a new commit object. - if re.match('^commit', line): - # Start all over again... - authorFound = False - dateFound = False - messageFound = False - messageNL = False - message = "" - filesFound = False - files = "" - commitCmd = os.popen("git describe "+re.split(' ', line, 1)[1]) - commit = commitCmd.read() - commitCmd.close() - commit = commit[0:len(commit)-1] - continue - # Match the author line and extract the part we want - elif re.match('^Author:', line): - authorList = re.split(': ', line, 1) - author = re.split('<', authorList[1], 1)[0] - author = "[" + author[0:len(author)-1]+"]" - authorFound = True - continue - # Match the date line - elif re.match('^Date:', line): - dateList = re.split(': ', line, 1) - date = dateList[1] - date = date[0:len(date)-1] - dateFound = True - continue - # The svn-id lines are ignored - elif re.match(' git-svn-id:', line): - continue - # The sign off line is ignored too - elif re.search('Signed-off-by', line) != None: - continue - # Extract the actual commit message for this commit - elif authorFound & dateFound & messageFound == False: - # Find the commit message if we can - if len(line) == 1: - if messageNL: - messageFound = True - else: - messageNL = True - elif len(line) == 4: - messageFound = True - else: - if len(message) == 0: - message = message + line.strip() - else: - message = message + " " + line.strip() - # If this line is hit all of the files have been stored for this commit - elif re.search('file(s)? changed', line) != None: - filesFound = True - continue - # Collect the files for this commit. FIXME: Still need to add +/- to files - elif authorFound & dateFound & messageFound: - fileList = re.split(' \| ', line, 2) - if len(fileList) > 1: - if len(files) > 0: - files = files + "\n\t* " + fileList[0].strip() - else: - files = "\t* " + fileList[0].strip() - # All of the parts of the commit have been found - write out the entry - if authorFound & dateFound & messageFound & filesFound: - # First the author line, only outputted if it is the first for that - # author on this day - authorLine = date + " " + author - if len(prevAuthorLine) != 0: - fout.write("\n"); - fout.write(authorLine + " " + commit + "\n\n") - - # Assemble the actual commit message line(s) and limit the line length - # to 80 characters. - commitLine = message - i = 0 - commit = "" - while i < len(commitLine): - if len(commitLine) < i + 70: - commit = commit + "\n\t\t" + commitLine[i:len(commitLine)] - break - index = commitLine.rfind(' ', i, i+70) - if index > i: - commit = commit + "\n\t\t" + commitLine[i:index] - i = index+1 - else: - commit = commit + "\n\t\t" + commitLine[i:70] - i = i+71 - - # Write out the commit line - fout.write(files + "\t\t" + commit + "\n") - - #Now reset all the variables ready for a new commit block. - authorFound = False - dateFound = False - messageFound = False - messageNL = False - message = "" - filesFound = False - files = "" - prevAuthorLine = authorLine - -# Close the input and output lines now that we are finished. -fin.close() -fout.close() blob - 40cf12e81c6f67f77e5e8ef4243ddd19045a7ded (mode 755) blob + /dev/null --- tools/google_msgid.pl +++ /dev/null @@ -1,7 +0,0 @@ -#!/usr/bin/perl -my $browser = 'mozilla'; -my $google_id = 'http://groups.google.com/groups?as_umsgid'; -$_ = <>; -chomp; -s/<|>//eg; -system("$browser '$google_id=$_' &"); blob - b93bcc1e101874ff89cf33bd6caf7ed95d79acfa (mode 644) blob + /dev/null --- tools/jhbuild/README +++ /dev/null @@ -1,17 +0,0 @@ -Building Claws Mail with JHBuild --------------------------------- - -Claws Mail can be built with JHBuild. This way, it's easy to do -sandboxed builds, for example in order to try out different versions -of low-level dependencies like gtk+ or glib without messing up a production -system. It's also useful to build older dependencies that are otherwise hard -to get on a more recent distribution. - -In order to use JHBuild for building Claws Mail, first, JHBuild itself -must be built and installed, see -https://developer.gnome.org/jhbuild/stable/getting-started.html - -JHBuild needs a configuration file, either as ~/.jhbuildrc or given with the -parameter -f on the command line. You can use the file -sample.jhbuildrc-claws-mail as a starting point, but you'll have to modify -it to suit your local environment. blob - 40bdcca854b8fb5ea4c24574f431da3b6c9c411a (mode 644) blob + /dev/null --- tools/jhbuild/claws-mail.modules +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - libgdata.pc - - - - - - - - - - oauth.pc - - - - - - - - - - - - - - - - - - - blob - 751d07b3b005b8503465d70d64e177dcffd85d9a (mode 644) blob + /dev/null --- tools/jhbuild/sample.jhbuildrc-claws-mail +++ /dev/null @@ -1,46 +0,0 @@ -# -*- mode: python -*- -# -# Sample jhbuildrc configuration file for building Claws Mail and -# some of its dependencies. - -# Select module set to use -moduleset = os.path.expanduser('~/src/claws-mail/claws/tools/jhbuild/claws-mail.modules') - -# repo login in case of write access -#repos["git.claws-mail.org"] = 'ssh://git.claws-mail.org/home/git/' - -# default modules -modules = ['claws-mail'] - -# what directory should the source be checked out to? -checkoutroot = os.path.expanduser('~/src/claws-mail') - -# the prefix to configure/install modules to (must have write access) -prefix = '/opt/claws-mail' - -# make arguments (e.g. concurrent build) -#makeargs = '-j4' - -# environment vars (e.g. CFLAGS) -#os.environ['CFLAGS'] = '-g -O0' - -# module-specific autofoo args -#module_autogenargs['claws-mail'] = " ".join([autogenargs, "--disable-manual"]) -#module_autogenargs['libgdata'] = " ".join([autogenargs, "--disable-always-build-tests"]) - -# path for building (if None, build in-tree) -#buildroot = None - -# skip building of dependant modules (system-installed ones will be used) -skip = [ - "glib" - , "gtk+" - , "libgdata" - , "libchamplain" - ] - -# speficif branches/tags of modules that should be built -#branches['libgdata'] = (None, 'LIBGDATA_0_17_1') - -# module specific extra environment variables -#module_extra_env = { "clutter-gtk" : {"LDFLAGS" : "-lm -lgthread-2.0"} } blob - 75d3b020bc93a2d7d2e970862c33fac18613fa34 (mode 644) blob + /dev/null --- tools/kdeservicemenu/README +++ /dev/null @@ -1,62 +0,0 @@ -claws-mail-kdeservicemenu.pl -Version: 1.6 -Claws Mail servicemenu for Konqueror - -FILES -o README You're reading it -o install.sh installer script -o claws-mail-kdeservicemenu.pl perl program -o claws-attach-files.desktop.template - .desktop file template - -DESCRIPTION -Enables attaching files from Konqueror to a new compose window. - -Adds the following right-click menu item to Konqueror: -/Claws Mail/Attach File(s) - -REQUIREMENTS -Perl 5.x.x - -INSTALL -o cd claws-mail/tools/kdeservicemenu -o ./install.sh (for kdialog prompt) - -or- -o ./install.sh --global - ./install.sh --local - (systemwide or home directory installation) - -UNINSTALL -o cd claws-mail/tools/kdeservicemenu -o ./install.sh (for kdialog prompt) - -or- -o ./install.sh --uninstall-global - ./install.sh --uninstall-local - (systemwide or home directory uninstallation) - - -LICENSE -GNU GENERAL PUBLIC LICENSE - -THANKS -install.sh was originally based on the install.sh script written by Dylan -Schrader , and released under the GPL, as part -of his 'Attach to email' service Menu for Konqueror, version 0.6.13 -, it has since been -heavily adapted. - -Translators: -[de] Thomas Gilgin -[es] Ricardo Mones Lastra -[fr] Fabien Vantard -[it] Andrea Spadaccini -[pt_BR] Frederico Goncalves Guimaraes -[sk] Andrej Kacian - -LINKS -Claws Mail -Perl -KDE - -CONTACT -Paul Mangan blob - fe00f3f8ba5398e2c87faf2d82e17d9846222bcf (mode 644) blob + /dev/null --- tools/kdeservicemenu/claws-mail-attach-files.desktop.kde4template +++ /dev/null @@ -1,14 +0,0 @@ -[Desktop Entry] -Type=Service -Actions=AttachFiles; -Comment=kde service menu for attaching files to Claws Mail -Encoding=UTF8 -Name=Claws Mail attach files -ServiceTypes=KonqPopupMenu/Plugin,all/allfiles -X-KDE-Priority=TopLevel -X-KDE-Submenu=Claws Mail - -[Desktop Action AttachFiles] -Exec=SCRIPT_PATH %F -Icon=claws-mail -Name=Attach File(s) blob - 33be8c77015ebeda44f88fc46438fbdf78a080fb (mode 644) blob + /dev/null --- tools/kdeservicemenu/claws-mail-attach-files.desktop.template +++ /dev/null @@ -1,13 +0,0 @@ -[Desktop Entry] -Actions=AttachFiles; -Comment=kde service menu for attaching files to Claws Mail -Encoding=UTF8 -Name=Claws Mail attach files -ServiceTypes=all/allfiles -X-KDE-Priority=TopLevel -X-KDE-Submenu=Claws Mail - -[Desktop Action AttachFiles] -Exec=SCRIPT_PATH %F -Icon=claws-mail -Name=Attach File(s) blob - 4769937e8def83b85686fb583cecb07050af2a8c (mode 755) blob + /dev/null --- tools/kdeservicemenu/claws-mail-kdeservicemenu.pl +++ /dev/null @@ -1,38 +0,0 @@ -#!/usr/bin/perl - -# * Copyright 2004-2006 Paul Mangan -# * -# * This file is free software; you can redistribute it and/or modify it -# * under the terms of the GNU General Public License as published by -# * the Free Software Foundation; either version 3 of the License, or -# * (at your option) any later version. -# * -# * This program is distributed in the hope that it will be useful, but -# * WITHOUT ANY WARRANTY; without even the implied warranty of -# * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# * General Public License for more details. -# * -# * You should have received a copy of the GNU General Public License -# * along with this program; if not, write to the Free Software -# * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. - -unless ($ARGV[0]) { exit; } - -my $claws = "claws-mail --compose --attach"; -my $sel = split_parts(); - -exec "$claws $sel"; - -exit; - -sub split_parts { - my $selectedParts = ""; - my $count = 0; - - while ($ARGV[$count]) { - $selectedParts .= "\"$ARGV[$count]\" "; - $count++; - } - - return ($selectedParts); -} blob - e3560ebdea45c6494a37cf67358eb7a209cadb86 (mode 755) blob + /dev/null --- tools/kdeservicemenu/install.sh +++ /dev/null @@ -1,138 +0,0 @@ -#!/usr/bin/env bash - -PERL_SCRIPT="claws-mail-kdeservicemenu.pl" -DESKTOP="claws-mail-attach-files.desktop" - -function check_environ { -echo "Checking for kde4-config..." -if [ ! -z "$(type 'kde4-config' 2> /dev/null)" ]; then - echo "Found kde4-config..." - SERVICEMENU_DIR="share/kde4/services/ServiceMenus" - DESKTOP_TEMPLATE="claws-mail-attach-files.desktop.kde4template" - KDECONFIG="kde4-config" -else - echo "kde4-config not found..." - echo "Checking for kde-config..." - if [ ! -z "$(type 'kde-config' 2> /dev/null)" ]; then - echo "Found kde-config..." - SERVICEMENU_DIR="share/apps/konqueror/servicemenus" - DESKTOP_TEMPLATE="claws-mail-attach-files.desktop.template" - KDECONFIG="kde-config" - else - echo "kde-config not found..." - echo "asking user to find kde4-config or kde-config..." - KDECONFIG=$(kdialog --title "Locate kde-config or kde4-config" --getopenfilename / ) - test -z $KDECONFIG && exit 1 - if [[ $KDECONFIG == *4-config ]]; then - SERVICEMENU_DIR="share/kde4/services/ServiceMenus" - DESKTOP_TEMPLATE="claws-mail-attach-files.desktop.kde4template" - else - SERVICEMENU_DIR="share/apps/konqueror/servicemenus" - DESKTOP_TEMPLATE="claws-mail-attach-files.desktop.template" - fi - fi -fi -} - -function install_all { -echo "Generating $DESKTOP ..." -SED_PREFIX=${PREFIX//\//\\\/} -sed "s/SCRIPT_PATH/$SED_PREFIX\\/bin\\/$PERL_SCRIPT/" $DESKTOP_TEMPLATE > $DESKTOP -echo "Installing $PREFIX/$SERVICEMENU_DIR/$DESKTOP" -mv -f $DESKTOP $PREFIX/$SERVICEMENU_DIR/$DESKTOP -if [[ $? -ne 0 ]] -then - kdialog --error "Could not complete installation." - exit -fi -echo "Installing $PREFIX/bin/$PERL_SCRIPT" -cp -f $PERL_SCRIPT $PREFIX/bin/ -echo "Setting permissions ..." -chmod 0644 $PREFIX/$SERVICEMENU_DIR/$DESKTOP -chmod 0755 $PREFIX/bin/$PERL_SCRIPT -echo "Finished installation." -kdialog --msgbox "Finished installation." -} - -function uninstall_all { -echo "Removing $PREFIX/$SERVICEMENU_DIR/$DESKTOP" -rm $PREFIX/$SERVICEMENU_DIR/$DESKTOP -if [[ $? -ne 0 ]] -then - kdialog --error "Could not complete uninstall." - exit -fi -echo "Removing $PREFIX/bin/$PERL_SCRIPT" -rm $PREFIX/bin/$PERL_SCRIPT -echo "Finished uninstall." -kdialog --msgbox "Finished uninstall." -} - -function show_help { - echo "Usage: $0 [--global|--local|--uninstall-global|--uninstall-local]" - echo - echo " --global attempts a system-wide installation." - echo " --local attempts to install in your home directory." - echo " --uninstall-global attempts a system-wide uninstallation." - echo " --uninstall-local attempts to uninstall in your home directory." - echo - exit 0 -} - -if [ -z $1 ] - then option="--$(kdialog --menu "Please select installation type" \ - local "install for you only" \ - global "install for all users" \ - uninstall-local "uninstall for you only" \ - uninstall-global "uninstall for all users" 2> /dev/null)" - else option=$1 -fi - -case $option in - "--global" ) - check_environ - PREFIX=$($KDECONFIG --prefix) - echo "Installing in $PREFIX/$SERVICEMENU_DIR ..." - if [ "$(id -u)" != "0" ]; then - exec kdesu "$0 --global" - fi - install_all - ;; - "--local" ) - check_environ - PREFIX=$($KDECONFIG --localprefix) - echo "Installing in $PREFIX$SERVICEMENU_DIR ..." - if [ ! -d $PREFIX/bin ]; then - mkdir $PREFIX/bin - fi - if [ ! -d $PREFIX/$SERVICEMENU_DIR ]; then - mkdir $PREFIX/$SERVICEMENU_DIR - fi - install_all - ;; - "--uninstall-global" ) - check_environ - PREFIX=$($KDECONFIG --prefix) - echo "Uninstalling from $PREFIX/$SERVICEMENU_DIR ..." - if [ "$(id -u)" != "0" ]; then - exec kdesu "$0 --uninstall-global" - fi - uninstall_all - ;; - "--uninstall-local" ) - check_environ - PREFIX=$($KDECONFIG --localprefix) - echo "Uninstalling from $PREFIX$SERVICEMENU_DIR ..." - uninstall_all - ;; - "-h" ) - show_help - ;; - "--help" ) - show_help - ;; - * ) - show_help -esac - -echo "Done." blob - bc147e7dffac60bdd1a2476aeb95a1e1b75faed8 (mode 755) blob + /dev/null --- tools/kmail-mailbox2claws-mail.pl +++ /dev/null @@ -1,155 +0,0 @@ -#!/usr/bin/perl -w - -# * This file is free software; you can redistribute it and/or modify it -# * under the terms of the GNU General Public License as published by -# * the Free Software Foundation; either version 3 of the License, or -# * (at your option) any later version. -# * -# * This program is distributed in the hope that it will be useful, but -# * WITHOUT ANY WARRANTY; without even the implied warranty of -# * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# * General Public License for more details. -# * -# * You should have received a copy of the GNU General Public License -# * along with this program; if not, write to the Free Software -# * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. -# * -# * Copyright 2003-2007 Paul Mangan -# * -# * 2007-02-25: several fixes for kmail 1.9.6 -# --kmaildir now expects the full path -# renamed from maildir2claws-mail.pl to kmail-mailbox2claws-mail.pl -# * 2003-10-01: add --debug and --dry-run options -# * 2003-09-30: updated/improved by Matthias F�rste -# * 2003-05-27: version one - -## script name : kmail-mailbox2claws-mail.pl - -## script purpose : convert a Kmail mailbox into a Claws Mail mailbox - -## USAGE: kmail-mailbox2claws-mail.pl --kmaildir=/full/path/to/kmail/mailbox - -## tested with Kmail version 1.9.6 - -use strict; - -use Getopt::Long; -use File::Find; - -my $kmaildir = ''; -my $iNeedHelp = ''; -# dont actually change anything if set(useful in conjunction with debug) -my $PRETEND = ''; -# print debug info if set -my $DEBUG = ''; - -my $claws_tmpdir = "$ENV{HOME}/claws_tmp"; - -GetOptions("kmaildir=s" => \$kmaildir, - "help" => \$iNeedHelp, - "dry-run" => \$PRETEND, - "debug" => \$DEBUG); - -if ($kmaildir eq "" || $iNeedHelp) { - if (!$iNeedHelp) { - print "No directory name given\n"; - } - print "Use the following format:\n"; - print "\tkmail-mailbox2claws-mail.pl --kmaildir=full-path-to-kmail-dir\n\n"; - exit; -} - - -my $count = 1; -my $MAIL_dir = "$kmaildir"; - -my $find_opts = { wanted => \&process }; - -if (-d $MAIL_dir) { - find($find_opts , ($MAIL_dir)); -} else { - print "\n$MAIL_dir is not a directory !\n"; - exit; -} - -unless ($PRETEND) { - mkdir("$claws_tmpdir", 0755); - system("mv $claws_tmpdir $ENV{HOME}/Mail"); - - print "\n\nSucessfully converted mailbox \"$MAIL_dir\"\n"; - print "Start claws-mail and right-click \"Mailbox (MH)\" and "; - print "select \"Rebuild folder tree\"\n"; - print "You may also need to run \"/File/Folder/Check for "; - print "new messages in all folders\"\n\n"; -} - -print "\n"; -exit; - -sub process() { - if (-d) { - process_dir($File::Find::dir); - } else { - process_file($File::Find::name); - } -} - -sub process_dir() { - my $direc = shift(); - $DEBUG && print "\nDIR $direc"; - - if ($direc !~ m/^drafts$/ && - $direc !~ m/^outbox$/ && - $direc !~ m/^trash$/ && - $direc !~ m/^inbox$/) { - my $tmpdir = $direc; - $tmpdir =~ s/^$MAIL_dir//; - $tmpdir =~ s/\/sent-mail$/sent/; - $tmpdir =~ s/\/cur$//; - $tmpdir =~ s/\/new$//; - $tmpdir =~ s/^\///; - $tmpdir =~ s/\.directory//g; - $tmpdir =~ s/\.//g; - - my $newdir = "$claws_tmpdir/$tmpdir"; - $DEBUG && print qq{\n>>> -e "$newdir" || mkdir("$newdir")}; - $PRETEND || -e "$newdir" || mkdir("$newdir"); - } - -} - -sub process_file { - my $file = shift; - $DEBUG && print "\nFILE $file"; - - my $nfile; - my $tmpfile = $file; - - $tmpfile =~ s|^$kmaildir||; - - if ($tmpfile =~ m/\/cur\// || - $tmpfile =~ m/\/new\//) { - - $tmpfile =~ s/\/new//; - $tmpfile =~ s/\/cur//; - - my @spl_str = split("/", $tmpfile); - pop(@spl_str); - push(@spl_str, "$count"); - - foreach my $spl_str (@spl_str) { - $spl_str =~ s/\.directory$//; - $spl_str =~ s/^\.//; - $spl_str =~ s/^sent-mail$/sent/; - } - $nfile = join("/", @spl_str); - $nfile = $claws_tmpdir.$nfile; - } - - if (-e "$file" && $nfile ne "") { - $DEBUG && print qq{\n+++ cp "$file" "$nfile"}; - $PRETEND || system("cp \"$file\" \"$nfile\""); - $count++; - } - -} blob - 681fdf2af97857b1acc04a8e765e122be6efa89c (mode 755) blob + /dev/null --- tools/kmail2claws-mail.pl +++ /dev/null @@ -1,211 +0,0 @@ -#!/usr/bin/perl - -# * Copyright 2002 Paul Mangan -# * -# * This file is free software; you can redistribute it and/or modify it -# * under the terms of the GNU General Public License as published by -# * the Free Software Foundation; either version 3 of the License, or -# * (at your option) any later version. -# * -# * This program is distributed in the hope that it will be useful, but -# * WITHOUT ANY WARRANTY; without even the implied warranty of -# * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# * General Public License for more details. -# * -# * You should have received a copy of the GNU General Public License -# * along with this program; if not, write to the Free Software -# * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. - -## script name : kmail2claws-mail.pl - -## script purpose : convert a Kmail addressbook into a Claws Mail addressbook - -use Getopt::Long; - -$kmailfile = ''; - -GetOptions("kmailfile=s" => \$kmailfile); - -$time = time; - -$claws_addr = "\n"; -$claws_addr .= "\n"; - -chdir; - -opendir(CLAWS, ".claws-mail") || die("Can't open .claws-mail directory\n"); - push(@cached,(readdir(CLAWS))); -closedir(CLAWS); - -foreach $cached (@cached) { - if ($cached =~ m/^addrbook/ && $cached =~ m/[0-9].xml$/) { - push(@addr, "$cached"); - } -} - -@sorted = sort {$a cmp $b} @addr; -$last_one = pop(@sorted); -$last_one =~ s/^addrbook-//; -$last_one =~ s/.xml$//; -$last_one++; -$new_addrbk = "addrbook-"."$last_one".".xml"; - -open (KFILE, "<$kmailfile") || die("Can't find the kmail file\n"); - @kmaillines = ; -close KFILE; - -$dross = shift(@kmaillines); - -foreach $kmailline (@kmaillines) { - (@kmaildata) = split(/,/,$kmailline); - foreach $kmaildata (@kmaildata) { - $kmaildata =~ s/^"//; - $kmaildata =~ s/"$//; - $kmaildata =~ s/"/"/g; - $kmaildata =~ s/&/&/g; - $kmaildata =~ s/'/'/g; - $kmaildata =~ s//>/g; - } - $claws_addr .= " \n" - ." \n"; - $time++; - $claws_addr .= "

\n" - ." \n"; - if ($kmaildata[13] ne "" || $kmaildata[9] ne "" || $kmaildata[21] ne "" || - $kmaildata[16] ne "" || $kmaildata[5] ne "" || $kmaildata[24] ne "" || - $kmaildata[19] ne "" || $kmaildata[12] ne "" || $kmaildata[10] ne "" || - $kmaildata[4] ne "" || $kmaildata[2] ne "" || $kmaildata[11] ne "" || - $kmaildata[3] ne "" || $kmaildata[14] ne "" || $kmaildata[22] ne "" || - $kmaildata[17] ne "" || $kmaildata[20] ne "" || $kmaildata[15] ne "" || - $kmaildata[23] ne "" || $kmaildata[18] ne "") { - $claws_addr .= " \n"; - - if ($kmaildata[3] ne "" || $kmaildata[2] ne "") { - $time++; - $claws_addr .= " " - ."$kmaildata[3] $kmaildata[0] $kmaildata[2] $kmaildata[1]\n"; - } - if ($kmaildata[15] ne "") { - $time++; - $claws_addr .= " " - ."$kmaildata[15]\n"; - } - if ($kmaildata[16] ne "") { - $time++; - $claws_addr .= " " - ."$kmaildata[16]\n"; - } - if ($kmaildata[17] ne "") { - $time++; - $claws_addr .= " " - ."$kmaildata[17]\n"; - } - if ($kmaildata[18] ne "") { - $time++; - $claws_addr .= " " - ."$kmaildata[18]\n"; - } - if ($kmaildata[19] ne "") { - $time++; - $claws_addr .= " " - ."$kmaildata[19]\n"; - } - if ($kmaildata[10] ne "") { - $time++; - $claws_addr .= " " - ."$kmaildata[10]\n"; - } - if ($kmaildata[12] ne "") { - $time++; - $claws_addr .= " " - ."$kmaildata[12]\n"; - } - if ($kmaildata[11] ne "") { - $time++; - $claws_addr .= " " - ."$kmaildata[11]\n"; - } - if ($kmaildata[14] ne "") { - $time++; - $claws_addr .= " " - ."$kmaildata[14]\n"; - } - if ($kmaildata[5] ne "") { - $time++; - $claws_addr .= " " - ."$kmaildata[5]\n"; - } - if ($kmaildata[4] ne "") { - $time++; - $claws_addr .= " " - ."$kmaildata[4]\n"; - } - if ($kmaildata[20] ne "") { - $time++; - $claws_addr .= " " - ."$kmaildata[20]\n"; - } - if ($kmaildata[21] ne "") { - $time++; - $claws_addr .= " " - ."$kmaildata[21]\n"; - } - if ($kmaildata[22] ne "") { - $time++; - $claws_addr .= " " - ."$kmaildata[22]\n"; - } - if ($kmaildata[23] ne "") { - $time++; - $claws_addr .= " " - ."$kmaildata[23]\n"; - } - if ($kmaildata[24] ne "") { - $time++; - $claws_addr .= " " - ."$kmaildata[24]\n"; - } - if ($kmaildata[9] ne "") { - $time++; - $claws_addr .= " " - ."$kmaildata[9]\n"; - } - if ($kmaildata[13] ne "") { - $time++; - $claws_addr .= " " - ."$kmaildata[13]\n"; - } - $claws_addr .= " \n"; - } - $claws_addr .= " \n"; - $time++; -} -$claws_addr .= "\n"; - -open (NEWADDR, ">.claws-mail/$new_addrbk"); -print NEWADDR $claws_addr; -close NEWADDR; - -open (ADDRIN, "<.claws-mail/addrbook--index.xml") || die("can't open addrbook--index.xml"); - @addrindex_file = ; -close ADDRIN; - -foreach $addrindex_line (@addrindex_file) { - if ($addrindex_line =~ m/<\/book_list>/) { - $rewrite_addrin .= " \n" - ." \n"; - } else { - $rewrite_addrin .= "$addrindex_line"; - } -} - -open (NEWADDRIN, ">.claws-mail/addrbook--index.xml"); -print NEWADDRIN "$rewrite_addrin"; -close NEWADDRIN; - -print "\nYou have sucessfully converted your Kmail addressbook\n"; -exit; blob - e0c2d18c5d20588de40f33c90483795d24a1e929 (mode 755) blob + /dev/null --- tools/kmail2claws-mail_v2.pl +++ /dev/null @@ -1,156 +0,0 @@ -#!/usr/bin/perl - -# * Copyright 2002 Paul Mangan -# * -# * This file is free software; you can redistribute it and/or modify it -# * under the terms of the GNU General Public License as published by -# * the Free Software Foundation; either version 3 of the License, or -# * (at your option) any later version. -# * -# * This program is distributed in the hope that it will be useful, but -# * WITHOUT ANY WARRANTY; without even the implied warranty of -# * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# * General Public License for more details. -# * -# * You should have received a copy of the GNU General Public License -# * along with this program; if not, write to the Free Software -# * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. - -## script name : kmail2claws-mail_v2.pl - -## script purpose : convert an exported Kmail addressbook csv file -## into a Claws Mail addressbook - -## tested with Kmail 1.4.7 and KAddressBook 3.1beta1 - -use Getopt::Long; - -$kmailfile = ''; -$iNeedHelp = ''; - -GetOptions("kmailfile=s" => \$kmailfile, - "help" => \$iNeedHelp); - -if ($kmailfile eq "" || $iNeedHelp) { - if (!$iNeedHelp) { - print "No filename given\n"; - } - print "Use the following format:\n"; - print "\tkmail2claws-mail_v2.pl --kmailfile=/path/to/addressbook.csv\n"; - exit; -} - -$claws_dir = ".claws-mail"; -$addr_index = "$claws_dir/addrbook--index.xml"; -$new_addressbook = "Kmail address book"; - -$time = time; - -chdir; - -opendir(CLAWS, $claws_dir) || die("Can't open $claws_dir directory\n"); - push(@cached,(readdir(CLAWS))); -closedir(CLAWS); - -foreach $cached (@cached) { - if ($cached =~ m/^addrbook/ && $cached =~ m/[0-9].xml$/) { - push(@addr, "$cached"); - } -} - -@sorted = sort {$a cmp $b} @addr; -$last_one = pop(@sorted); -$last_one =~ s/^addrbook-//; -$last_one =~ s/.xml$//; -$last_one++; -$new_addrbk = "addrbook-"."$last_one".".xml"; - -open (KFILE, "<$kmailfile") || die("Can't open the kmail file [$kmailfile]\n"); - @kmaillines = ; -close KFILE; - -$count = 0; -$defs = shift(@kmaillines); -@extra_def = (3,4,5,7 ... 27,29 ... 32,34 ... 42); - -(@kmaildefs) = split(/,/,$defs); - -$claws_addr = "\n"; -$claws_addr .= "\n"; - -foreach $kmailline (@kmaillines) { - (@kmaildata) = split(/,/,$kmailline); - foreach $kmaildata (@kmaildata) { - $kmaildata =~ s/^"//; - $kmaildata =~ s/"$//; - $kmaildata =~ s/"/"/g; - $kmaildata =~ s/&/&/g; - $kmaildata =~ s/'/'/g; - $kmaildata =~ s//>/g; - $kmaildata =~ s/\\n/, /g; - chomp $kmaildata; - } - $claws_addr .= " \n" - ." \n"; - $time++; - $claws_addr .= "

\n" - ." \n"; - - foreach $extra_def (@extra_def) { - if ($kmaildata[$extra_def] ne "") { - push (@def_exist, $extra_def); - } - } - if ($def_exist[0]) { - $claws_addr .= " \n"; - } - foreach $def_exist (@def_exist) { - $kmaildefs[$def_exist] =~ s/^"//; - $kmaildefs[$def_exist] =~ s/"$//; - $kmaildefs[$def_exist] =~ s/'/'/g; - - $time++; - $claws_addr .= " " - ."$kmaildata[$def_exist]\n"; - $attribs = 1; - } - if ($attribs == 1) { - $claws_addr .= " \n"; - } - $claws_addr .= " \n"; - $time++; - $count++; -} -$claws_addr .= "\n"; - -open (NEWADDR, ">$claws_dir/$new_addrbk"); -print NEWADDR $claws_addr; -close NEWADDR; - -open (ADDRIN, "<$addr_index") - || die("can't open $addr_index for reading"); - @addrindex_file = ; -close ADDRIN; - -foreach $addrindex_line (@addrindex_file) { - if ($addrindex_line =~ m/<\/book_list>/) { - $rw_addrindex .= " \n" - ." \n"; - } else { - $rw_addrindex .= "$addrindex_line"; - } -} - -open (NEWADDRIN, ">$addr_index") - || die("Can't open $addr_index for writing"); -print NEWADDRIN "$rw_addrindex"; -close NEWADDRIN; - -print "Done. $count address(es) converted successfully.\n"; - -exit; - blob - b44fd3595a5f096664a9c5308acf6b0b77d439a9 (mode 755) blob + /dev/null --- tools/mairix.sh +++ /dev/null @@ -1,38 +0,0 @@ -#!/bin/sh - -# * Copyright 2007 Tristan Chabredier -# * -# * This file is free software; you can redistribute it and/or modify it -# * under the terms of the GNU General Public License as published by -# * the Free Software Foundation; either version 3 of the License, or -# * (at your option) any later version. -# * -# * This program is distributed in the hope that it will be useful, but -# * WITHOUT ANY WARRANTY; without even the implied warranty of -# * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# * General Public License for more details. -# * -# * You should have received a copy of the GNU General Public License -# * along with this program; if not, write to the Free Software -# * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. -# -# mairix.sh mairix wrapper for Claws Mail - -# if any param is passed, $1 must be the mairixrc file to use -# if no param is passed, ~/.mairixrc is assumed - -read TEXT -test -z "$TEXT" && \ - exit 0 - -if [ $# -ge 1 ] -then - RCFILE="$1" - shift -else - RCFILE=~/.mairixrc -fi - -mairix -f "$RCFILE" --purge && \ - mairix -f "$RCFILE" "$@" $TEXT -exit $? blob - 038bad76048f41484fd32c2baa2eeff378b85bbd (mode 644) blob + /dev/null --- tools/make.themes.project +++ /dev/null @@ -1,257 +0,0 @@ -#!/usr/bin/env bash -# -# Generate the source directory for claws-mail-themes package -# from the theme tarballs in http://www.claws-mail.org/themes.php -# -# Copyright (c) 2006-2010 Ricardo Mones -# Paul Mangan -# -# This program is free software; you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation; either version 3 of the License, or -# (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. -# - -test x$1 = x && echo "Error: version number not given" && exit 1; - -VERS=$1 -shift; -SITE=http://www.claws-mail.org -NAME=claws-mail-themes -DDIR=$NAME-$VERS -PAGE=themes.php -LIST=themes.list -WLOG=themes.wget.log - -function getListFromPage() -{ - test -f ${PAGE} && rm -f ${PAGE}; - wget -q -a ${WLOG} ${SITE}/${PAGE} - test ! -f ${PAGE} && echo "Error: couldn't get ${PAGE}." && exit 1; - - grep 'download.php?file=' ${PAGE} \ - | cut -f2 -d\" \ - > ${LIST} -} - -function makeRoomForThemes() -{ - test -d ${DDIR} \ - && rm -rf ${DDIR} \ - && echo "Removing previous destination"; - mkdir ${DDIR}; -} - -function downloadThemes() -{ - for theme in `cat ${LIST} `; - do tarf=`echo $theme | cut -f2 -d/ `; - test $tarf = "png" \ - && tarf=`echo $theme | cut -f3 -d/ `; - echo -n "Downloading... "; - wget -q -a ${WLOG} -O ${DDIR}/$tarf ${SITE}/$theme - test ! -f ${DDIR}/$tarf && echo "Error: couldn't get $tarf" && exit 1; - pushd ${DDIR} > /dev/null - tarops=""; - test ${tarf} = ${tarf/.tar.bz2/} && tarops="xzf" || tarops="xjf"; - echo -n "unpacking... " \ - && tar $tarops $tarf \ - && echo -n "deleting tarball... " \ - && rm -f $tarf \ - && echo "Ok ($tarf)"; - popd > /dev/null - done; -} - -function removeWhitespaces() -{ - cd ${DDIR}; - for dir in *; - do test -d "$dir" \ - && test ! "${dir}" = "${dir/ /_}" \ - && mv "${dir}" "${dir// /_}"; - done; - cd ".."; -} - -function fixPermissions() -{ - find ${DDIR} -type d -exec chmod 755 '{}' + - find ${DDIR} -type f -exec chmod 644 '{}' + -} - -function createProject() -{ - touch ${DDIR}/${NAME} -} - -function createThemeMakefileAm() -{ - echo "Making $1"; - MA="/tmp/tmp.makefile.am"; - cd "$1" - dir="$1"; - echo 'themedir = $(prefix)/share/claws-mail/themes/'${dir} > $MA - echo "" >> $MA - echo -n 'dist_theme_DATA =' >> $MA - count_png=`ls -1 *.png 2> /dev/null | wc -l ` - count_xpm=`ls -1 *.xpm 2> /dev/null | wc -l ` - ext="xpm" - count=$count_xpm - if [ $count_png -gt $count_xpm ]; - then ext="png"; - count=$count_png; - fi - i=1; - for px in `ls -1 *.${ext} `; - do if [ $i -lt $count ]; - then echo " $px \\" >> $MA; - else echo " $px" >> $MA; - fi; - i=$((1 + $i)); - done; - echo "" >> $MA; - count=`ls * | grep -v "\.${ext}$" | wc -l `; - if [ $count -gt 0 ]; - then echo -n 'EXTRA_DIST =' >> $MA; - i=1; - for npx in `ls -1 * | grep -v "\.${ext}$" `; - do if [ $i -lt $count ]; - then echo " $npx \\" >> $MA; - else echo " $npx" >> $MA; - fi; - i=$((1 + $i)); - done; - echo "" >> $MA; - fi; - mv $MA Makefile.am - cd ".." -} - -function createAutogenSh() -{ - cat< ${DDIR}/autogen.sh -#!/bin/sh - -aclocal \ - && automake --add-missing --foreign --copy \ - && autoconf \ - && ./configure --enable-maintainer-mode $@ -EOA - chmod +x ${DDIR}/autogen.sh - echo "Created autogen.sh" -} - -function createMakefileAm() -{ - cd ${DDIR} - MA=Makefile.am - if [ -f INSTALL ] - then echo "EXTRA_DIST = INSTALL "${NAME} > $MA - else echo "EXTRA_DIST = "${NAME} > $MA - fi - echo "" >> $MA - echo -n "SUBDIRS =" >> $MA - for dir in *; - do test -d "$dir" && echo -n " ${dir}" >> $MA; - done; - cd ".." - echo "Created Makefile.am" -} - -function createConfigureAc() -{ - cd ${DDIR} - CA=configure.ac - echo 'AC_PREREQ(2.59d)' > $CA - echo 'AC_INIT('${NAME}')' >> $CA - echo 'AM_INIT_AUTOMAKE('${NAME}', '${VERS}')' >> $CA - cat >> $CA <> $CA \ - && createThemeMakefileAm "$dir"; - done; - echo "])" >> $CA - cd ".."; - echo "Created $CA"; -} - -function cleanMine() -{ - find ${DDIR} -name Makefile.am -delete - rm -f \ - ${DDIR}/autogen.sh \ - ${DDIR}/configure.ac \ - ${DDIR}/${NAME} -} - -function cleanGenerated() -{ - find ${DDIR} -name Makefile.in -delete - find ${DDIR} -name Makefile -delete - rm -rf ${DDIR}/autom4te.cache - rm -f \ - ${DDIR}/aclocal.m4 \ - ${DDIR}/install-sh \ - ${DDIR}/missing \ - ${DDIR}/config.status \ - ${DDIR}/configure \ - ${DDIR}/config.log -} - -case "$1" in - --clean) - cleanMine; - echo "Cleaned."; - ;; - --clean-all) - cleanMine; - cleanGenerated; - echo "Cleaned all."; - ;; - --download) - getListFromPage; - makeRoomForThemes; - downloadThemes; - echo "Downloaded."; - ;; - --autotoolize) - removeWhitespaces; - fixPermissions; - createProject; - createAutogenSh; - createMakefileAm; - createConfigureAc; - echo "Autotoolized."; - ;; - --all) - $0 $VERS --download - $0 $VERS --autotoolize - echo "Done."; - ;; - *) - echo "Syntax: "; - echo " $0 vers {--clean[-all]|--download|--autotoolize|--all}" - ;; -esac - blob - e626282c4aff361eabb56cb609d2ed5cbe99130f (mode 755) blob + /dev/null --- tools/mew2claws-mail.pl +++ /dev/null @@ -1,175 +0,0 @@ -#!/usr/bin/perl - -# * Copyright 2007 J�r�me Lelong -# * -# * This file is free software; you can redistribute it and/or modify it -# * under the terms of the GNU General Public License as published by -# * the Free Software Foundation; either version 3 of the License, or -# * (at your option) any later version. -# * -# * This program is distributed in the hope that it will be useful, but -# * WITHOUT ANY WARRANTY; without even the implied warranty of -# * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# * General Public License for more details. -# * -# * You should have received a copy of the GNU General Public License -# * along with this program; if not, write to the Free Software -# * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. - -## script name : mew2claws-mail.pl - -## script purpose : convert a Mew addressbook into a Claws Mail addressbook - -## This script assumes your Mew addressbook is Latin-1 encoded and not -## unicode. In this latter case, you will have to hack this script a -## little. - -use Getopt::Long; - -## Process the command line options -## the program expects one argument: the Mew addressbook file - -my $help=0; -my $mewfile=''; -GetOptions("mew-addressbook=s" => \$mewfile, - "help" => \$help); - -if ($help==1) -{ - print("usage : perl mew2claws-mail.pl [--help] [--mew-addressbook=file] \n"); - print("\t--help: displays this help\n"); - print("\t--mew-addressbook=file : file is the filename of your Mew addressbook\n"); - exit 0; -} -if ($mewfile ne '' && !-f $mewfile) -{ - print("file $mewfile does not exists\n"); - exit 1; -} - -$time=time; -$claws_addr=''; -$home = glob("~"); -$clawsdir=`claws-mail --config-dir`; -chomp($clawsdir); -$clawsdir = $home . '/' . $clawsdir . '/' . 'addrbook/'; - -opendir(CLAWS, $clawsdir) || die("Can't open $clawsdir directory\n"); -push(@cached,(readdir(CLAWS))); -closedir(CLAWS); - -## find the first availabel name for a new addressbook in claws-mail -foreach $cached (@cached) -{ - if ($cached =~ m/^addrbook/ && $cached =~ m/[0-9].xml$/) - { - push(@addr, "$cached"); - } -} -@sorted = sort {$a cmp $b} @addr; -$last_one = pop(@sorted); -$last_one =~ s/^addrbook-//; -$last_one =~ s/.xml$//; -$last_one++; -$new_addrbk = "addrbook-"."$last_one".".xml"; - - -open (MEWFILE, "<$mewfile") || die("Can't find the Mew addressbook file\n"); -@mewentries = ; -close MEWFILE; - -$claws_addr .= "\n" -. ""; - - -chomp(@mewentries); -foreach $line (@mewentries) -{ - $line =~ s/ *\t/ /g; - $line =~ s/ *$//g; - (@fields) = split(/ +/,$line); - $nickname= shift(@fields); - @emails=(); - $alias=''; - $firstname=''; - $lastname=''; - while (1) - { - $field = shift(@fields); - if ($field =~ m/@/) - { - $field =~ s/,$//; - push(@emails, $field); - } else - { - unshift(@fields, $field); - last; - } - } - $alias = shift(@fields); - if ($alias eq "\*") - { - print($alias . "\n"); - $alias=''; - } - - - $firstname=shift(@fields); $firstname =~ s/"//g; - foreach (@fields) - { - $lastname .= "$_ "; - } - $lastname =~ s/"//g; - $lastname =~ s/ *$//g; - - $claws_addr .= " \n" - ." \n"; - $time++; - - foreach $email (@emails) - { - $claws_addr .= "

\n"; - $time++; - } - $claws_addr .= " \n" - . " \n" - . " \n"; - $claws_addr .= " \n"; - $time++; -} -$claws_addr .= "\n"; - -open (NEWADDR, ">$clawsdir/$new_addrbk") ; -print NEWADDR ($claws_addr); -close NEWADDR; - -open (ADDRIN, "<$clawsdir/addrbook--index.xml") || die("can't open addrbook--index.xml"); -@addrindex_file = ; -close ADDRIN; - -foreach $addrindex_line (@addrindex_file) -{ - if ($addrindex_line =~ m//) - { - $rewrite_addrin .= " \n" - ." \n"; - } else - { - $rewrite_addrin .= "$addrindex_line"; - } -} - -open (NEWADDRIN, ">$clawsdir/addrbook--index.xml"); -print NEWADDRIN "$rewrite_addrin"; -close NEWADDRIN; - -print "\nYou have sucessfully converted your Mew addressbook\n"; -exit; blob - f960533ace33667abc2a14b434585389bae13b1b (mode 644) blob + /dev/null --- tools/multiwebsearch.conf +++ /dev/null @@ -1,5 +0,0 @@ -cpan|http://search.cpan.org/search?mode=module&query= -ddg|https://duckduckgo.com/?q= -rfc|http://www.ietf.org/rfc/rfc|.txt -sf|http://sourceforge.net/search/?type_of_search=soft&words= -usenet|http://groups.google.com/groups?q=|&meta=site%3Dgroups blob - f5398c237c26acf4a5ef0d5c63ad2b908d612395 (mode 755) blob + /dev/null --- tools/multiwebsearch.pl +++ /dev/null @@ -1,79 +0,0 @@ -#!/usr/bin/perl - -# * Copyright 2003-2007 Paul Mangan -# * -# * This file is free software; you can redistribute it and/or modify it -# * under the terms of the GNU General Public License as published by -# * the Free Software Foundation; either version 3 of the License, or -# * (at your option) any later version. -# * -# * This program is distributed in the hope that it will be useful, but -# * WITHOUT ANY WARRANTY; without even the implied warranty of -# * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# * General Public License for more details. -# * -# * You should have received a copy of the GNU General Public License -# * along with this program; if not, write to the Free Software -# * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. -# * - -# Changes: -# Feb 2007: add support for non ISO-8859-1 compatible locales -# by Alex Gorbachenko -# - -use Getopt::Long; -use URI::Escape; -use POSIX qw(locale_h); -use Text::Iconv; - -my $where = ''; -my $what = ''; - -GetOptions("where=s" => \$where, - "what=s" => \$what); - -$locale = setlocale(LC_CTYPE); -$locale =~ s/\S+\.//; - -$converter = Text::Iconv->new("$locale", "UTF-8"); -$safe=uri_escape($converter->convert("$what")); -$what=$safe; - -chdir($ENV{HOME} . "/.claws-mail") - || die("Can't find your ~/.claws-mail directory\n"); - -open (CONF, "; -close CONF; - -foreach $confline (@conflines) { - if ($confline =~ m/^$where\|/) { - chomp $confline; - @parts = split(/\|/, $confline); - $url = $parts[1]; - if ($parts[2]) { - $what .= $parts[2]; - } - } -} - -if (!$url) { - die("No url found with the alias \"$where\"\n"); -} - -open (SYLRC, "; -close SYLRC; - -foreach $rcline (@rclines) { - if ($rcline =~ m/^uri_open_command/) { - chomp $rcline; - @browser = split(/=/, $rcline); - $browser[1] =~ s/%s/$url$what/; - } -} -system("$browser[1]&"); -exit; blob - 4fd0357bafd34b06e9a6f468c11ad70f71143f01 (mode 755) blob + /dev/null --- tools/nautilus2claws-mail.sh +++ /dev/null @@ -1,54 +0,0 @@ -#!/usr/bin/env bash - -# nautilus2claws-mail.sh -# Copyright 2004 Reza Pakdel - -# This program is free software; you can redistribute it and/or -# modify it under the terms of the GNU General Public License -# as published by the Free Software Foundation; either version 3 -# of the License, or (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program; if not, write to the Free Software -# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA -# 02111-1307, USA. - -# This script will recursively attach a number of selected -# files/directories from Nautilus to a new blank e-mail. - -# Authors: Reza Pakdel -# Stephan Sachse -# -# Fixes: -# Stephan Sachse : files/directorys with whitspaces - - -SELECTED_PATHS="${NAUTILUS_SCRIPT_SELECTED_FILE_PATHS}" -NB_SELECTED_PATHS=`echo -n "${SELECTED_PATHS}" | wc -l | awk '{print $1}'` - -ATTACHMENTS="" - -for ((i=${NB_SELECTED_PATHS}; i>0; i--)) ; do - CURRENT_PATH=`echo -n "${SELECTED_PATHS}" | head -n${i} | tail -n1` - if test -d "${CURRENT_PATH}" ; then - FILES_FOUND=`find "${CURRENT_PATH}" -type f` - NB_FILES_FOUND=`echo "${FILES_FOUND}" | wc -l | awk '{print $1}'` - for ((j=${NB_FILES_FOUND}; j>0; j--)) ; do - CURRENT_FILE=`echo "${FILES_FOUND}" | head -n${j} | tail -n1` - ATTACHMENTS="${ATTACHMENTS} \"${CURRENT_FILE}\"" - done - else - ATTACHMENTS="${ATTACHMENTS} \"${CURRENT_PATH}\"" - fi -done - -echo "-----------" -echo ${ATTACHMENTS} - -eval "claws-mail --compose --attach ${ATTACHMENTS}" - blob - b0d703a13b40b6f57dee5d1c34e5a3b04bd7df52 (mode 755) blob + /dev/null --- tools/outlook2claws-mail.pl +++ /dev/null @@ -1,219 +0,0 @@ -#!/usr/bin/perl -w - -# Copyright 2002-2003 Ricardo Mones -# -# This file is free software; you can redistribute it and/or modify it -# under the terms of the GNU General Public License as published by -# the Free Software Foundation; either version 3 of the License, or -# (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, but -# WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. -# -# outlook2claws-mail.pl -- perl script to convert an Outlook generated -# contact list into a Claws Mail XML address book. -# -# This script is based on: -# out2syl.sh by Rafael Lossurdo -# kmail2claws-mail.pl by Paul Mangan -# -# See README file for details and usage. -# - -$nboffields = 28; # change this only if you did read README - -# parse parameters -$do_csv = 0; -die "Error: required filename missing\n" unless (defined($ARGV[0])); -$_=$ARGV[0]; -if (/--csv/) { - die "Error: required filename missing\n" unless (defined($ARGV[1])); - $do_csv = 1; - $outl_file = $ARGV[1]; -} -else { - $outl_file = $ARGV[0]; -} -# some init -$clawsconf = ".claws-mail/addrbook"; -$indexname = "$clawsconf/addrbook--index.xml"; - -# the next is mostly Paul's code -$time = time; - -chdir; -opendir(CLAWS, $clawsconf) || die("Error: can't open $clawsconf directory\n"); - push(@cached,(readdir(CLAWS))); -closedir(CLAWS); - -foreach $cached (@cached) { - if ($cached =~ m/^addrbook/ && $cached =~ m/[0-9].xml$/) { - push(@addr, "$cached"); - } -} - -@sorted = sort {$a cmp $b} @addr; -$last_one = pop(@sorted); -$last_one =~ s/^addrbook-//; -$last_one =~ s/.xml$//; -$last_one++; -$new_book = "/addrbook-"."$last_one".".xml"; - -# some subs -# warning: output file is global -sub write_header { - print NEWB "\n"; - print NEWB "\n"; -} - -sub write_footer { - print NEWB "\n"; -} - -sub write_person_h { - my($fn, $ln, $nn, $cn) = @_; - # one of them must be given - if (($fn eq "") and ($ln eq "") and ($nn eq "") and ($cn eq "")) { - $cn = "No name provided"; - # but return may break XML structure - } - print NEWB " \n"; -} - -sub write_person_f { - print NEWB " \n"; -} - -sub write_addrlist_h { - print NEWB " \n"; -} - -sub write_addrlist_f { - print NEWB " \n"; -} - -sub write_address { - my($al, $em, $re) = @_; - if ($em eq "") { - $em = "No e-mail address"; - # email is a must -> no address breaks claws-mail display - # (claws-mail says file is ok but no name is shown) - # maybe this is a bug on claws-mail? - } - print NEWB "

\n"; -} - -sub write_attrlist_h { - print NEWB " \n"; -} - -sub write_attrlist_f { - print NEWB " \n"; -} - -sub write_attribute { - my($aname, $aval) = @_; - if (($aname eq "") or ($aval eq "")) { return; } # both are must - print NEWB " ", $aval, "\n"; -} - -sub process_text { - write_header(); - $count = 0; - while () { - chomp; - if (/\s+[0-9]+\s+(.+)/) { $_ = $1; } - else { $count += 2 and die "Error: wrong format at line $count \n"; } - @field = split(/;/); # first is name, second mail addr - write_person_h("","","",$field[0]); - write_addrlist_h(); - $field[1] =~ s/\r//; # beware, dangerous chars inside ;) - write_address("",$field[1],""); - write_addrlist_f(); - write_person_f(); - ++$count; - } - write_footer(); -} - -sub process_csv { - write_header(); - $count = 0; - while () { - chomp; - # do something useful: quote XML chars - s/\&/&/g; - s/\/>/g; - s/\'/'/g; - s/\"/"/g; - @field = split(/,/); - if ($#field != $nboffields) { $count += 2 and die "Error: wrong format at line $count \n"; } - # First Name, Last Name, Nickname, Name - write_person_h($field[0],$field[1],$field[4],$field[3]); - write_addrlist_h(); - write_address("",$field[5],$field[$nboffields - 1]); - write_addrlist_f(); - write_attrlist_h(); # the remaining values as attributes - foreach $a (2, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27) { - # add only filled fields (should be trimmed?) - if (defined($field[$a]) && $field[$a] ne "") { - write_attribute($headerline[$a],$field[$a]); - } - } - write_attrlist_f(); - write_person_f(); - ++$count; - } - write_footer(); -} - -# ok, was enough, do some more bit bashing now -open(OUTL, $outl_file) - or die "Error: can't open $outl_file for reading\n"; -# 1st line: file format checking (csv) or discarding (default) -$_ = ; -chomp; -if ($do_csv) { - @headerline = split(/,/); - # check before creating output file - die "Error: unknown csv file format\n" - unless ($#headerline == $nboffields); -} -open(NEWB, '>', "$clawsconf/$new_book") - or die "Error: can't open $clawsconf/$new_book for writing\n"; -if ($do_csv) { process_csv(); } -else { process_text(); } - -close NEWB; -close OUTL; - -# update index (more Paul's code :) - -open(INDX, $indexname) - or die "Error: can't open $indexname for reading\n"; -@index_file = ; -close INDX; - -foreach $index_line (@index_file) { - if ($index_line =~ m/<\/book_list>/) { - $new_index .= " \n"." \n"; } else { - $new_index .= "$index_line"; - } -} -open (INDX, '>', $indexname) - or die "Error: can't open $indexname for writing\n"; -print INDX "$new_index"; -close INDX; - -print "Done. $count address(es) converted successfully.\n"; - blob - f75a3f1d7a674adce3e83ef6f088fe6db5921190 (mode 755) blob + /dev/null --- tools/popfile-link.sh +++ /dev/null @@ -1,70 +0,0 @@ -#!/usr/bin/env bash - -# * Copyright 2007 Tristan Chabredier -# * -# * This file is free software; you can redistribute it and/or modify it -# * under the terms of the GNU General Public License as published by -# * the Free Software Foundation; either version 3 of the License, or -# * (at your option) any later version. -# * -# * This program is distributed in the hope that it will be useful, but -# * WITHOUT ANY WARRANTY; without even the implied warranty of -# * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# * General Public License for more details. -# * -# * You should have received a copy of the GNU General Public License -# * along with this program; if not, write to the Free Software -# * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. -# -# popfile-link.sh helper script to open messages in POPFile's control center -# in order to edit their status - -# Requires that POPFile is running and that the message has been processed -# by it (X-POPFile-Link: header present). POPFile control center opens with -# the web browser set in Claws Mail prefs. - - -open_page() -{ - TMPCMD=$(echo $OPEN_CMD | sed "s|\"%s\"|$1|") - $TMPCMD & -} - - -SESSION_ID="" -if [ "$1" = "--ask-session-id" ] -then - shift - SESSION_ID=$(gxmessage -entry -center -wrap -buttons "OK:0,Cancel:1" -default "OK" \ - -name "popfile-link" -title "POPFile session ID" "Type in the ID of a running POPFile session to use") - test -z "$SESSION_ID" -o $? -ne 0 && \ - exit 0 -fi - -test -z "$1" && \ - exit 1 - -CM_DIR=$(claws-mail --config-dir) -test -z "$CM_DIR" -o ! -d "$HOME/$CM_DIR" && \ - exit 1 - -OPEN_CMD=$(grep -Em 1 "^uri_open_command=" "$HOME/$CM_DIR/clawsrc" | cut -d '=' -f 2-) -test -z "$OPEN_CMD" && \ - exit 1 - -while [ -n "$1" ] -do - LINK=$(grep -Eim 1 "^X\-POPFile\-Link: " "$1") - if [ -n "$LINK" ] - then - LINK=${LINK:16} - if [ -n "$SESSION_ID" ] - then - open_page "${LINK}\\&session=$SESSION_ID" - else - open_page "$LINK" - fi - fi - shift -done -exit 0 blob - 70300610a515ae2aac11148f50f54378ccc51982 (mode 755) blob + /dev/null --- tools/tb2claws-mail +++ /dev/null @@ -1,278 +0,0 @@ -#!/usr/bin/perl - -# Script name : tb2claws-mail -# Script version: 1.0.2 -# Script based on : script kmail2claws-mail.pl -# Script purpose : convert The Bat! addressbook into Claws Mail addressbook -# Author : Aleksandar Urosevic aka Urke MMI -# Licence : GPL -# -# Thanks goes to : Paul Mangan -# -# Usage: Export The Bat! Address Book to CSV file format -# with all fields selected to YES and then start: -# tb2claws-mail --tbfile=/full/path/to/thebat/addressbook.csv -# -# Change Log: -# -# 18-12-2003 v 1.0.2 -# - bugfix: added missing attribute-list start -# -# 01-01-2003 v 1.0.1 -# - bugfix: no more empty Business Homepage entry -# - bugfix: no more \0D\0A�s in Notes entry -# - bugfix: no more double space in Full Name entry -# - code utilization -# - add info about number of converted addresses -# -# 15-08-2002 v 1.0.0 -# - first public release -# -# TODO: -# -# * Add switch for Full Name entry on atrybute part -# - -use Getopt::Long; - -GetOptions("tbfile=s" => \$tbfile); - -#$tbfile = '/home/urke/bin/claws-mail/tb2ldif/thebat-addressbook.csv'; -$total_addresses = 0; - -chdir; - -# check is Claws-Mail instrtalled -opendir(CLAWS, ".claws-mail/addrbook") || die("Can't open Claws Mail directory! Conversion aborted\n"); - push(@cached, (readdir(CLAWS))); -closedir(CLAWS); - -# get last existing addressbook filename -# to set filename for newest addressbook - -# get all existing addressbook filenames -foreach $cached (@cached) { - if ($cached =~ m/^addrbook/ && $cached =~ m/[0-9].xml$/) { - push(addr, "$cached"); - } -} -# sort filenames, get last and set newest filename -@sorted = sort {$a cmp $b} @addr; -$last_one = pop(@sorted); -$last_one =~ s/^addrbook-//; -$last_one =~ s/.xml$//; -$last_one++; -$new_addrbk = "addrbook-"."$last_one".".xml"; - -# open thebat file to stack -open (TBFILE, "<$tbfile") || die("Specified Address Book file does not exist.\n\033[5m\033[31mYou must specify full path to input file!\033[0m\nConversion aborted.\n"); - @tblines = ; -close TBFILE; - -# shift firs line from file because this is field names -$dross = shift(@tblines); - -# set time mark and header of addressbook -$time = time; -$claws_addr = "\n"; -$claws_addr .= "\n"; - -# create addressbook entry from The Bat! addressbook -foreach $tbline (@tblines) { - $total_addresses += 1; - (@tbdata) = split(/,/,$tbline); - foreach $tbdata (@tbdata) { - # fix nonacceptable characters - $tbdata =~ s/^"//; - $tbdata =~ s/"$//; - $tbdata =~ s/"/"/g; - $tbdata =~ s/&/&/g; - $tbdata =~ s/'/'/g; - $tbdata =~ s//>/g; - $tbdata =~ s/\\2C\ /, /g; - $tbdata =~ s/(\\0D\\0A){1,}/, /g; - $tbdata =~ s/\ {2,}/ /g; - } - # set addressbook field values - $claws_addr .= " \n" - ." \n"; - $time++; - $claws_addr .= "

\n" - ." \n"; - - # find is need to make entry attributes - $check = 0; - for($i=6; $i<=31; $i++) { - $tbdata[$i] =~ s/^\s+//; - $tbdata[$i] =~ s/\s+$//; - if ($tbdata[$i] ne "") { $check += 1; } - } - - if ($check > 0) { - $claws_addr .= " \n"; - if ($tbdata[1] ne "" || $tbdata[2] ne "") { - $time++; - if($tbdata[29] ne "" && $tbdata[1] ne "") { $full_name = "$tbdata[29] $tbdata[1]"; } else { $full_name = "$tbdata[1]"; } - if($tbdata[3] ne "") { $full_name .= " $tbdata[3]"; } - if($tbdata[2] ne "") { $full_name .= " $tbdata[2]"; } - if($tbdata[28] ne "") { $full_name .= " $tbdata[28]"; } - - $claws_addr .= " " - ."$full_name\n"; - } - if ($tbdata[15] ne "") { - $time++; - $claws_addr .= " " - ."$tbdata[15]\n"; - } - if ($tbdata[16] ne "") { - $time++; - $claws_addr .= " " - ."$tbdata[16]\n"; - } - if ($tbdata[17] ne "") { - $time++; - $claws_addr .= " " - ."$tbdata[17]\n"; - } - if ($tbdata[18] ne "") { - $time++; - $claws_addr .= " " - ."$tbdata[18]\n"; - } - if ($tbdata[19] ne "") { - $time++; - $claws_addr .= " " - ."$tbdata[19]\n"; - } - if ($tbdata[9] ne "") { - $time++; - $claws_addr .= " " - ."$tbdata[9]\n"; - } - if ($tbdata[10] ne "") { - $time++; - $claws_addr .= " " - ."$tbdata[10]\n"; - } - if ($tbdata[11] ne "") { - $time++; - $claws_addr .= " " - ."$tbdata[11]\n"; - } - if ($tbdata[30] ne "") { - $time++; - $claws_addr .= " " - ."$tbdata[30]\n"; - } - if ($tbdata[14] ne "") { - $time++; - $claws_addr .= " " - ."$tbdata[14]\n"; - } - if ($tbdata[7] ne "") { - $time++; - $claws_addr .= " " - ."$tbdata[7]\n"; - } - if ($tbdata[8] ne "") { - $time++; - $claws_addr .= " " - ."$tbdata[8]\n"; - } - if ($tbdata[20] ne "") { - $time++; - $claws_addr .= " " - ."$tbdata[20]\n"; - } - if ($tbdata[21] ne "") { - $time++; - $claws_addr .= " " - ."$tbdata[21]\n"; - } - if ($tbdata[22] ne "") { - $time++; - $claws_addr .= " " - ."$tbdata[22]\n"; - } - if ($tbdata[23] ne "") { - $time++; - $claws_addr .= " " - ."$tbdata[23]\n"; - } - if ($tbdata[24] ne "") { - $time++; - $claws_addr .= " " - ."$tbdata[24]\n"; - } - if ($tbdata[25] ne "") { - $time++; - $claws_addr .= " " - ."$tbdata[25]\n"; - } - if ($tbdata[26] ne "") { - $time++; - $claws_addr .= " " - ."$tbdata[26]\n"; - } - if ($tbdata[12] ne "") { - $time++; - $claws_addr .= " " - ."$tbdata[12]\n"; - } - if ($tbdata[13] ne "") { - $time++; - $claws_addr .= " " - ."$tbdata[13]\n"; - } - if ($tbdata[31] ne "") { - $time++; - $claws_addr .= " " - ."$tbdata[31]\n"; - } - if ($tbdata[27] ne "") { - $time++; - $claws_addr .= " " - ."$tbdata[27]\n"; - } - $claws_addr .= " \n"; - } -# if ( $check > 0 ) { -# $claws_addr .= "\n"; -# } - - $claws_addr .= " \n"; - $time++; -} -$claws_addr .= "\n"; - -# print new addressbook to file -open (NEWADDR, ">.claws-mail/addrbook/$new_addrbk"); - print NEWADDR $claws_addr; -close NEWADDR; - -# add new addressbook to index -open (ADDRIN, "<.claws-mail/addrbook/addrbook--index.xml") || die("Can't open addrbook--index.xml"); - @addrindex_file = ; -close ADDRIN; - -foreach $addrindex_line (@addrindex_file) { - if ($addrindex_line =~ m/<\/book_list>/) { - $rewrite_addrin .= " \n" - ." \n"; - } else { - $rewrite_addrin .= "$addrindex_line"; - } -} - -open (NEWADDRIN, ">.claws-mail/addrbook/addrbook--index.xml"); - print NEWADDRIN "$rewrite_addrin"; -close NEWADDRIN; -print "You have sucessfully converted your The Bat! addressbook\n"; -print "New addressbook file name: $new_addrbk\n"; -print "Total addresses converted: $total_addresses\n"; -exit; blob - 8cf2bb25fa6289341e194560e62710662e6c0909 (mode 755) blob + /dev/null --- tools/tbird2claws.py +++ /dev/null @@ -1,133 +0,0 @@ -#!/usr/bin/env python3 - -# Script name : tbird2claws.py -# Script purpose : Integrate a Thunderbird folder tree to Claws Mail -# Author : Aleksandar Urosevic aka Urke MMI -# Licence : GPL -# Author: Rodrigo Dias Arruda Senra - -#The script receives two parameters from command-line: -# - -#Best way to use it is to go to inside yout Thunderbird -#root mailfolder directory and invoke it as: - -#\python3 \tbird2claws.py . \Mail - -import os -import sys -import importlib - -__author__ = 'Rodrigo Senra ' -__date__ = '2005-03-23' -__version__ = '0.3' - -__doc__ = r""" -This module integrates your Mozilla Thunderbird 1.0 tree to -your Claws Mail MH mailbox tree. - -The script receives two parameters from command-line: - - -Best way to use it is to go to inside your Thunderbird -root mailfolder directory and invoke it as: - - \python3 \tbird2claws.py . \Mail - -This idiom will avoid the creation of the folder Thunderbird inside -your Claws Mail folder tree. - -If the names of your directories match in both trees, files should -be placed in the correct folder. - -This is an alpha release, so it may be a little rough around the edges. -Nevertheless, I used it with great success to convert a very large and -deep folder tree. - -Please, do backup your claws-mail (destination) folder tree before trying -this out. Live safe and die old! - -This code is released in the public domain. -""" - -def harvest_offsets(filepath): - """Given the filepath, this runs through the file finding - the number of the line where a message begins. - - The function returns a list of integers corresponding to - the beginning of messages. - """ - offsets = [] - i = 0 - state = 'begin' - for i,line in enumerate(open(filepath)): - if line.startswith('From - ') and state!='found_head': - offsets.append(i) - continue -# elif line.startswith('Return-Path') and state=='found_head': -# state = 'found_offset' -# offsets.append(i) -# continue - offsets.append(i) - return offsets - -def make_messages(outputdir, filepath, offsets, start): - """Given a filepath holding several messages in Thunderbird format, - extract the messages and create individual files for them, inside - outputdir with appropriate the appropriate naming scheme. - """ - if not os.path.exists(outputdir): - os.makedirs(outputdir) - if not os.path.exists(filepath): - raise Exception('Cannot find message file %s'%(filepath)) - lines = open(filepath).readlines() - aux = offsets[:] - msgoffs = zip(offsets[:-1], aux[1:]) - for i,j in msgoffs: - fd = open(os.path.join(outputdir,"%d"%start),"w") - fd.write(''.join(lines[i:j-1])) #-1 to remove first from line - fd.close() - start +=1 - -def process_file(filepath, outputdir): - """Integrates a Thunderbird message file into a claws-mail message directory. - """ - offs = harvest_offsets(filepath) - make_messages(outputdir, filepath, offs, 1) - -def clean_path(path): - """Rename all directories and subdirectories .sbd to - """ - l = [] - f = os.path.basename(path) - while f and f != "": - if f.endswith('.sbd'): - f = f[:-4] - l.append(f) - path = os.path.dirname(path) - f = os.path.basename(path) - l.reverse() - r = os.path.join(*l) - return r - - - -def convert_tree(in_treepath, out_treepath): - """Traverse your thunderbird tree, converting each message file found into - a claws-mail message directory. - """ - for path,subs,files in os.walk(in_treepath): - outpath = clean_path(path) - if files: - for f in [x for x in files if not x.endswith('.msf')]: - process_file(os.path.join(path,f), - os.path.join(out_treepath,outpath,f)) - -if __name__=='__main__': - if len(sys.argv)<3: - print (__doc__) - else: - if sys.version[0] == '2': - importlib.reload(sys) - sys.setdefaultencoding('utf8') - convert_tree(sys.argv[1], sys.argv[2]) blob - e9f04ae059d1090f13a178d255ffad5eacfab67c (mode 755) blob + /dev/null --- tools/textviewer.pl +++ /dev/null @@ -1,178 +0,0 @@ -#!/usr/bin/perl - -# COPYRIGHT AND LICENSE -# Copyright (C) 2005-2018 H.Merijn Brand -# -# This script is free software; you can redistribute it and/or modify it -# under the same terms as Perl and/or Claws Mail itself. (GPL) - -use 5.14.1; -use warnings; - -our $VERSION = "1.01 - 2018-10-08"; -our $CMD = $0 =~ s{.*/}{}r; - -sub usage { - my ($err, $str) = (@_, ""); - $err and select STDERR; - say "usage: $CMD [--html] [--type=] file\n", - " --html Generate HTML (if supported)\n", - " --type=X X as mimetype (msword => doc)\n", - " $CMD --list will show all implemented conversions"; - $str and say $str; - exit $err; - } # usage - -use Getopt::Long qw(:config bundling nopermute); -my $opt_v = 0; -my $opt_h = "text"; -GetOptions ( - "help|?" => sub { usage (0); }, - "V|version" => sub { say "$CMD [$VERSION]"; exit 0; }, - - "v|verbose:1" => \$opt_v, - "t|type|mimetype=s" => \my $opt_t, - "h|html" => sub { $opt_h = "html" }, - "l|list!" => \my $opt_l, - ) or usage (1); - -$opt_v and say "$0 @ARGV"; - -# anon-list contains all possible commands to show content -# plain text is a reference to same type (alias) -# %f will be replaced with file. If no %f, file will be the last arg -my %fh = ( - text => { - bin => [ "strings" ], # fallback for binary files - - txt => [ "cat" ], # Plain text - - html => [ "htm2txt", - "html2text" ], # HTML - - msword => "doc", - doc => [ "catdoc -x -dutf-8", - "wvText", - "antiword -w 72" ], # M$ Word - "vnd.ms-excel" => "xls", - "ms-excel" => "xls", - docx => [ "unoconv -f text --stdout" ], # MS Word - xlsx => "xls", - xls => [ "xlscat -L", - "catdoc -x -dutf-8", - "wvText" ], # M$ Excel -# ppt => [ "ppthtml" ], # M$ PowerPoint -# ppthtml "$1" | html2text - csv => "xls", # Comma Separated Values - - ics => [ "ics2txt" ], # ICS calendar request - - rtf => [ "rtf2text", - "unrtf -t text" ], # RTF - pdf => [ "pdftotext %f -" ], # Adobe PDF - - ods => "xls", # OpenOffice spreadsheet - sxc => "xls", # OpenOffice spreadsheet - odt => [ "oo2pod %f | pod2text", - "ooo2txt" ], # OpenOffice writer - rtf => [ "rtf2text" ], # RTF - - pl => [ "perltidy -st -se", - "cat" ], # Perl - pm => "pl", - - jsn => [ "json_pp" ], # JSON - json => "jsn", - - xml => [ "xml_pp" ], # XML - - ( map { $_ => "txt" } qw( - patch diff - c h ic ec cc - sh sed awk - plain - yml yaml - )), - - bz2 => [ "bzip2 -d < %f | strings" ], - - zip => [ "unzip -l %f" ], # ZIP - - test => [ \&test ], # Internal - - tgz => [ "tar tvf" ], # Tar uncompressed - tgz => [ "tar tzvf" ], # Tar GZ compressed - tbz => [ "tar tjvf" ], # Tar BZip2 compressed - txz => [ "tar tJvf" ], # Tar XZ compressed - - rar => [ "unrar l" ], # RAR - }, - - html => { - rtf => [ "rtf2html" ], - }, - ); - -if ($opt_l) { - my %tc = %{$fh{text}}; - foreach my $ext (sort keys %tc) { - my $exe = $tc{$ext}; - ref $exe or $exe = $tc{$exe}; - printf " .%-12s %s\n", $ext, $_ for @$exe; - } - exit 0; - } - -my $file = shift or usage (1, "File argument is missing"); --f $file or usage (1, "File argument is not a plain file"); --r $file or usage (1, "File argument is not a readable file"); --s $file or usage (1, "File argument is an empty file"); - -my $ext = $file =~ m/\.(\w+)$/ ? lc $1 : ""; -$opt_t && exists $fh{text}{lc $opt_t} and $ext = lc$opt_t; -unless (exists $fh{text}{$ext}) { - my $ftype = `file --brief $file`; - $ext = - $ftype =~ m/^pdf doc/i ? "pdf" : - $ftype =~ m/^ascii( english)? text/i ? "txt" : - $ftype =~ m/^(utf-8 unicode|iso-\d+)( english)? text/i ? "txt" : - $ftype =~ m/^xml doc/i ? "xml" : - $ftype =~ m/^\w+ compress/i ? "bin" : - "bin" ; - # \w+ archive - # \w+ image - # ... - } -$ext ||= "txt"; -exists $fh{$opt_h}{$ext} or $opt_h = "text"; -exists $fh{$opt_h}{$ext} or $ext = "txt"; -my $ref = $fh{$opt_h}{$ext}; -ref $ref or $ref = $fh{$opt_h}{$ref}; - -$opt_v and warn "[ @$ref ] $file\n"; - -sub which { - (my $cmd = shift) =~ s/\s.*//; # Only the command. Discard arguments here - foreach my $path (split m/:+/, $ENV{PATH}) { - -x "$path/$cmd" and return "$path/$cmd"; - } - return 0; - } # which - -my $cmd = "cat -ve"; -foreach my $c (@$ref) { - if (ref $c) { - $c->($file); - exit; - } - - my $cp = which ($c) or next; - $cmd = $c; - last; - } - -my @cmd = split m/ +/ => $cmd; -grep { s/%f\b/$file/ } @cmd or push @cmd, $file; -#$cmd =~ s/%f\b/$file/g or $cmd .= " $file"; -$opt_v and say "@cmd"; -exec @cmd; blob - 38c8894310ffa9e9d5eda99aa61698a6302967d8 (mode 755) blob + /dev/null --- tools/textviewer.sh +++ /dev/null @@ -1,243 +0,0 @@ -#!/usr/bin/env bash - -# textviewer.sh -# Copyright 2003 Luke Plant -# and Johann Koenig - -# This program is free software; you can redistribute it and/or -# modify it under the terms of the GNU General Public License -# as published by the Free Software Foundation; either version 3 -# of the License, or (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program; if not, write to the Free Software -# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA -# 02111-1307, USA. - -############################################################################## -# -# This script is a text viewer designed to be used with claws-mail actions -# Set up an action with the command line: textviewer.sh %p | -# -# The script will try to detect file type automatically, and then -# invokes a relevant program to print the file in plain text to -# the standard output. -# -# From v 0.9.7claws7, claws-mail sets the temporary file -# of a part to XXXXXX.mimetmp.[filename of attachment] -# This means we can use the extension of the filename for checking. -# Also use the program 'file' if that fails. -# -# To extend the script just follow the patterns that already exist, or -# contact the author if you have problems. - -############################################################################## -# -# Change Log -# -# 2003-03-25 -# - make extension matching case insensitive -# -# 2003-03-23 -# - Support for MS Excel (xlhtml) and Powerpoint (ppthtml) -# -# 2004-03-09 -# - Support for HTML (html2text) -# -# 2004-02-13 -# - added support for perl and shell scripts, and recognize that -# 'file' will always return 'text' somewhere in its output for -# files that, well, contain text -# -# 2004-01-25 -# - added brief messages describing whats going on -# -# 2004-01-23 -# - added support for 'pdftotext,' from xpdf-utils debian package -# -# 2004-01-05 -# - added matcher and action for OpenOffice Writer documents -# (requires ooo2txt) -# -# 2004-01-05 -# - changed page width parameter for antiword -# - fixed matcher for 'diffs' -# - added a matcher and action for bzip2 - bzip2 files -# are decompressed and textviewer.sh run on the result -# - similarly decompress gzip files and run textviewer.sh -# on the result, insteading of doing 'gzip -l' -# -# 2003-12-30 -# added the script to claws-mail/tools -# -# 2003-12-30 -# - use 'fold' after 'unrtf' to wrap to a nice width -# - added basic file sanity checks -# -# 2003-12-29 -# Added recognition for "Zip " from 'file' output -# -# 2003-12-19 -# Initial public release -# -############################################################################### - -if [ $# -eq 0 ] -then - echo "No filename supplied." >&2 - echo "Usage: textviewer.sh FILE" >&2 - exit 1 -fi - -[ -f "$1" ] || -{ - echo "File \"$1\" does not exist or is not a regular file." >&2 - exit 1 -} - -[ -r "$1" ] || -{ - echo "Cannot read file \"$1\"." >&2 - exit 1 -} - -FILETYPE=`file --brief "$1"` || -{ - echo "Please install the command 'file' to use this script." >&2 - exit 1 -}; - -FNAME=`echo "$1" | tr [A-Z] [a-z]` -case "$FNAME" in - *.doc) TYPE=MSWORD ;; - *.ppt) TYPE=POWERPOINT ;; - *.zip) TYPE=ZIP ;; - *.tar.gz|*.tgz) TYPE=TARGZ ;; - *.tar.bz2|*.tar.bz) TYPE=TARBZ ;; - *.gz) TYPE=GZIP ;; - *.bz2|*.bz) TYPE=BZIP ;; - *.tar) TYPE=TAR ;; - *.diff) TYPE=TEXT ;; - *.txt) TYPE=TEXT ;; - *.rtf) TYPE=RTF ;; - *.sxw) TYPE=OOWRITER ;; - *.pdf) TYPE=PDF ;; - *.sh) TYPE=TEXT ;; - *.pl) TYPE=TEXT ;; - *.html|*.htm) TYPE=HTML ;; - *.xls) TYPE=EXCEL ;; -esac - -if [ "$TYPE" = "" ] -then - case $FILETYPE in - *"HTML"*) TYPE=HTML ;; - *"text"*) TYPE=TEXT ;; - gzip*) TYPE=GZIP ;; - bzip2*) TYPE=BZIP ;; - "POSIX tar archive"*) TYPE=TAR ;; - "Zip "*) TYPE=ZIP ;; - "Rich Text Format"*) - TYPE=RTF ;; - esac -fi - -case $TYPE in - TARGZ) echo -e "Gzip'd tarball contents:\n" ; - tar -tzvf "$1" ;; - - TARBZ) echo -e "Bzip'd tarball contents:\n" ; - tar -tjvf "$1" ;; - - BZIP) TMP=`mktemp "$1".temp.XXXXXXX` || exit 1; - bunzip2 -c "$1" > "$TMP" || exit 1; - echo -e "Re-running \"$0\" on bunzip'd contents of \"$1\":\n"; - "$0" "$TMP"; - rm "$TMP" ;; - - GZIP) TMP=`mktemp "$1".temp.XXXXXXX` || exit 1; - gunzip -c "$1" > "$TMP" || exit 1; - echo "Re-running \"$0\" on gunzip'd contents of \"$1\":\n"; - "$0" "$TMP"; - rm "$TMP" ;; - - TAR) echo -e "Tar archive contents:\n" ; - tar -tvf "$1" ;; - - ZIP) echo -e "Zip file contents:\n" ; - unzip -l "$1" ;; - - RTF) which unrtf > /dev/null 2>&1 || - { - echo "Program 'unrtf' for displaying RTF files not found" >&2 - exit 1 - }; - echo -e "Displaying \"$1\" using \"unrtf\":\n"; - unrtf -t text "$1" 2>/dev/null | egrep -v '^### ' | fold -s -w 72 ;; - - TEXT) cat "$1" ;; - - MSWORD) which antiword > /dev/null 2>&1 || - { - echo "Program 'antiword' for displaying MS Word files not found" >&2 - exit 1 - }; - echo -e "Displaying \"$1\" using \"antiword\":\n"; - antiword -w 72 "$1" ;; - - POWERPOINT) which ppthtml > /dev/null 2>&1 || - { - echo "Program 'ppthtml' for displaying Powerpoint files not found" >&2 - exit 1 - }; - which html2text > /dev/null 2>&1 || - { - echo "Program 'html2text' for displaying Powerpoint files not found" >&2 - exit 1 - }; - echo -e "Displaying \"$1\" using \"ppthtml\" and \"html2text\":\n"; - ppthtml "$1" | html2text ;; - - EXCEL) which xlhtml > /dev/null 2>&1 || - { - echo "Program 'xlhtml' for displaying Excel files not found" >&2 - exit 1 - }; - which html2text > /dev/null 2>&1 || - { - echo "Program 'html2text' for displaying Excel files not found" >&2 - exit 1 - }; - echo -e "Displaying \"$1\" using \"xlhtml\" and \"html2text\":\n"; - xlhtml "$1" | html2text ;; - - OOWRITER) which ooo2txt > /dev/null 2>&1 || - { - echo "Program 'ooo2txt' for converting OpenOffice Writer files not files not found" >&2 - exit 1 - }; - echo -e "Displaying \"$1\" using \"ooo2txt\":\n"; - ooo2txt "$1" ;; - - PDF) which pdftotext > /dev/null 2>&1 || - { - echo "Program 'pdftotext' for converting Adobe Portable Document Format to text not found" >&2 - exit 1 - }; - echo -e "Displaying \"$1\" using \"pdftotext\":\n"; - pdftotext "$1" - ;; - - HTML) which html2text > /dev/null 2>&1 || - { - echo "Program 'html2text' for converting HTML files not found" >&2 - exit 1 - }; - html2text -nobs "$1" ;; - - *) echo "Unsupported file type \"$FILETYPE\", cannot display.";; -esac blob - d49cfea7afc6baf9888805122345319704d38786 (mode 755) blob + /dev/null --- tools/thunderbird-filters-convertor.pl +++ /dev/null @@ -1,519 +0,0 @@ -#!/usr/bin/perl -w - -use strict; -use Getopt::Long; -use URI::Escape; - -# * This file is free software; you can redistribute it and/or modify it -# * under the terms of the GNU General Public License as published by -# * the Free Software Foundation; either version 3 of the License, or -# * (at your option) any later version. -# * -# * This program is distributed in the hope that it will be useful, but -# * WITHOUT ANY WARRANTY; without even the implied warranty of -# * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# * General Public License for more details. -# * -# * You should have received a copy of the GNU General Public License -# * along with this program; if not, write to the Free Software -# * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. -# * -# * Copyright 2007 Paul Mangan -# * - -# -# Convert Thunderbird filtering rules to Claws Mail filtering rules -# - -# -# TABLE OF EQUIVALENTS -# -# thunderbird : Claws Mail -#------------------------------------------------------ -# -# name="NAME" : rulename "NAME" -# -# enabled="yes" : enabled / disabled -# -# CONDITION LIST -# -------------- -# -# OR : | -# AND : & -# -# subject : subject -# from : from -# to : to -# cc : cc -# to or cc : to_or_cc -# body : body-part -# date : **** -# priority : **** -# status : **** -# age in days : age_greater/age_lower -# size : size_greater/size_smaller -# [custom header] : header -# -# 2nd level conditions -# -------------------- -# -# contains : [nothing] -# doesn't contain : [append with ~] -# is : regexpcase -# isn't : regexpcase -# ends with : regexpcase -# begins with : regexpcase -# is in ab : found_in_addressbook -# isn't in ab : ~found_in_addressbook -# -# -# status 2nd and 3rd level conditions -# ----------------------------------- -# -# [is|isn't] replied -# [is|isn't] read -# [is|isn't] new -# [is|isn't] forwarded -# [is|isn't] flagged -# -# -# Date header 2nd level condition -# -------------------------------- -# -# is -# isn't -# is before -# is after -# -# -# Priority header 2nd and 3rd level conditions -# -------------------------------------------- -# is [Lowest|Low|Normal|High|Highest] -# is higher than [Lowest|Low|Normal|High|Highest] -# is lower than [Lowest|Low|Normal|High|Highest] -# -# -# ACTION LIST -# ----------- -# -# Move to folder : move -# Copy to folder : copy -# Forward : **** -# Reply : **** -# Mark read : mark_as_read -# Mark flagged : mark -# Label : **** -# Change priority : **** -# JunkScore 100 [mark as spam] : **** -# JunkScore 0 [mark as ham] : **** -# Delete : delete -# Delete from Pop3 server : delete -# Fetch body from Pop3Server : **** -# - -my $script = "thunderbird-filters-convertor.pl"; -my ($tbirdfile, $account, $mailbox, $iNeedHelp) = 0; - -GetOptions("tbird-file=s" => \$tbirdfile, - "account-name=s" => \$account, - "mailbox-name=s" => \$mailbox, - "help|h" => \$iNeedHelp); - -if ($iNeedHelp) { - help_me(); -} - -if (!$tbirdfile) { - print "ERROR: No filename given\n"; - print "Use $script -h for help\n"; - exit; -} - -unless (-e $tbirdfile) { - print "ERROR: $tbirdfile NOT FOUND!!\n"; - exit; -} - -if (!$mailbox) { - print "ERROR: No mailbox name given\n"; - print "Use $script -h for help\n"; - exit; -} - -my $config_dir = `claws-mail --config-dir` or die("ERROR: - You don't appear to have Claws Mail installed\n"); -chomp $config_dir; - -chdir($ENV{HOME} . "/$config_dir") or die("ERROR: - Claws Mail config directory not found [~/$config_dir] - You need to run Claws Mail once, quit it, and then re-run this script\n"); - -my $acrc = "accountrc"; -my $acc_number; - -if ($account) { - $acc_number = find_account_number(); -} -if ($account && !$acc_number) { - print "ERROR: Account '$account' NOT FOUND!\n"; - exit; -} - -my @claws_filters = (); - -## check if matcherrc already exists -if (-e "matcherrc") { - print "matcherrc exists!\n"; - read_current_filters(); -} else { - push(@claws_filters, "[preglobal]\n\n[postglobal]\n\n[filtering]\n") -} -## -my ($rule_count,@thunderbird_filters) = read_thunderbird_filters(); - -my ($conv_rule,$ignored_rule,$ignore_list) = convert_filters($rule_count,@thunderbird_filters); - -if (@claws_filters) { - system("mv matcherrc matcherrc-safecopy"); - print "Moved ". $ENV{HOME}. "/$config_dir/matcherrc to " - . $ENV{HOME}. "/$config_dir/matcherrc-safecopy\n"; -} -# write new config -open(MATCHERRC, ">>matcherrc"); - print MATCHERRC @claws_filters; -close(MATCHERRC); - -print "We're done!\n"; -print "-------------\n"; -print "Converted $conv_rule rules"; -if (defined($ignored_rule)) { - print ", ignored $ignored_rule rules"; -} -print "\n-------------\n"; -print "$ignore_list"; - -exit; - -sub help_me { - print<<'EOH'; -Usage: - thunderbird-filters-convertor.pl [options] -Options: - --help -h Show this screen. - --tbird-file=PATH TO FILE The full path to the file to be converted - --mailbox-name=NAME The name of the Claws Mail mailbox - --account-name=NAME The name of the account to be used (optional) -EOH -exit; -} - -sub find_account_number { - my $cur_acc_numb; - my $cur_acc_name; - - open (ACCOUNTRC, "<$acrc") || - die("Can't open the Accounts file [$acrc]\n"); - my @acrclines = ; - close ACCOUNTRC; - - foreach my $line (@acrclines) { - unless ($line =~ m/^\[Account/ || - $line =~ m/^account_name/) { next; } - chomp($line); - - if ($line =~ s/^\[Account: //) { - $line =~ s/]$//; - $cur_acc_numb = $line; - } - if ($line =~ s/^account_name=//) { - $cur_acc_name = $line; - } - if (defined($cur_acc_name) && $cur_acc_name eq $account) { - return($cur_acc_numb); - } - } -} - -sub read_current_filters { - print "Reading current filters\n"; - - open (CFILTERS, "; - close CFILTERS; - - remove_last_empty_lines(); -} - -sub remove_last_empty_lines { - my $line = pop(@claws_filters); - if ($line =~ m/^$/) { - remove_last_empty_lines(); - } else { - push(@claws_filters, $line); - } -} - -sub read_thunderbird_filters { - my @outer_array = (); - my @inner_array = (); - my $count = 0; - - open (TBIRDFILE, "<$tbirdfile") || - die("Can't open the tbird file [$tbirdfile]\n"); - my @tbirdlines = ; - close TBIRDFILE; - - foreach my $line (@tbirdlines) { - if ($line =~ m/^version/ || $line =~ m/^logging/) { next; } - - chomp($line); - - push(@inner_array, "$line") unless $line eq ""; - if ($line =~ m/^condition/) { - push(@outer_array, [@inner_array]); - @inner_array = (); - $count++; - } - } - return($count-1,@outer_array); -} - -sub convert_filters { - my ($rule_count,@thunderbird_filters) = @_; - - my $tbird_action_no_value = qr/^(?:"Mark read"|"Mark flagged"|"Delete"|"Delete from Pop3 server"|"Fetch body from Pop3Server")$/; - my $tbird_action_ignore = qr/^(?:"Label"|"Change priority"|"JunkScore"|"Fetch body from Pop3Server"|"Delete from Pop3 server"|"Reply")$/; - my $exact_matches = qr/^(?:subject|from|to|cc)$/; - my $ignore_matches = qr/^(?:date|priority|status)$/; - - my $conv_rules = my $ignored_rules = 0; - my $ignored_list = ""; - for (my $outerloop = 0; $outerloop <= $rule_count; $outerloop++) { - my $part_one = my $part_two = my $part_three = my $part_four = ""; - my $ignore_rule = my $move_rule = my $copy_rule = my $cond_count = 0; - my %ignore_hash; - my $bool = my $claws_condition = my $cur_name = ""; - for (my $innerloop = 0; exists($thunderbird_filters[$outerloop][$innerloop]); $innerloop++) { - my $entry = $thunderbird_filters[$outerloop][$innerloop]; - if ($entry =~ s/^name=//) { - $cur_name = $entry; - $part_one = "rulename $entry "; - } elsif ($entry =~ s/^enabled=//) { - if ($entry eq "\"yes\"") { - $part_one = "enabled $part_one"; - } else { - $part_one = "disabled $part_one"; - } - if (defined($acc_number)) { - $part_one .= "account $acc_number "; - } - } elsif ($entry =~ s/^type=//) { - # do nothing : what does 'type' mean?? - } elsif ($entry =~ s/^action=//) { - if ($entry =~ m/$tbird_action_ignore/ && !$ignore_rule) { - $ignore_rule = 1; - unless ($ignore_hash{$cur_name}) { - $ignored_list .= "Ignored $cur_name because it contains $entry\n"; - $ignored_rules++; - } - $ignore_hash{$cur_name}++; - $part_one = ""; - next; - } elsif ($entry =~ m/Move to folder/) { - $part_four = "move "; - $move_rule = 1; - } elsif ($entry =~ m/Copy to folder/) { - $part_three .= "copy"; - $copy_rule = 1; - } elsif ($entry =~ m/Mark read/) { - $part_three .= "mark_as_read "; - } elsif ($entry =~ m/Mark flagged/) { - $part_three .= "mark"; - } elsif ($entry =~ m/Delete/) { - $part_three .= "delete"; - } - } elsif ($entry =~ s/^actionValue=//) { - if ($ignore_rule) { - $ignore_rule = 0; - next; - } elsif ($move_rule) { - $entry = rewrite_mailbox_name($entry); - $part_four .= uri_unescape($entry); - $move_rule = 0; - } elsif ($copy_rule) { - $entry = rewrite_mailbox_name($entry); - $part_three .= " " . uri_unescape($entry); - $copy_rule = 0; - } - } elsif ($entry =~ s/^condition=//) { - if ($entry =~ s/^\"AND//) { - $bool= "&"; - } elsif ($entry =~ s/^\"OR//) { - $bool = "|"; - } - my @tbird_conditions = split(/ $/, $entry); - foreach my $cond (@tbird_conditions) { - my $exact = my $endswith = my $beginswith = my $addrbook = 0; - my $age_condition = my $size_condition = my $exact_age = 0; - $cond =~ s/$ OR$//; - $cond =~ s/\) AND$//; - $cond =~ s/\)"$//; - $cond =~ s/\\"/"/g; - my ($cpart_one, $cpart_two, $cpart_thr) = split(/,/, $cond, 3); - if ($cond) { - if ($cpart_one =~ m/$exact_matches/) { - $claws_condition .= "$cpart_one"; - } elsif ($cpart_one eq "to or cc") { - $claws_condition .= "to_or_cc"; - } elsif ($cpart_one eq "body") { - $claws_condition .= "body-part"; - } elsif ($cpart_one eq "age in days") { - $age_condition = 1; - } elsif ($cpart_one eq "size") { - $size_condition = 1; - } elsif ($cpart_one =~ m/$ignore_matches/) { - $part_one = $claws_condition = $part_three = $part_four = ""; - next; - } else { - $claws_condition = "header $cpart_one"; - } - - if ($cpart_two eq "doesn't contain") { - $claws_condition = "~$claws_condition matchcase"; - } elsif ($cpart_two eq "contains") { - $claws_condition = "$claws_condition matchcase"; - } elsif ($cpart_two eq "isn't") { - $exact = 1; - $claws_condition = "~$claws_condition regexpcase"; - } elsif ($cpart_two eq "is") { - if ($size_condition) { - $claws_condition .= "size_equal"; - } elsif ($age_condition) { - if ($bool ne "&") { - $part_one = $claws_condition = $part_three = $part_four = ""; - if (!$ignored_list) { - $ignored_list .= "Ignored $cur_name because it matches an exact age and is an OR match\n"; - } - next; - } else { - $ignored_rules--; - $exact_age = 1; - } - } else { - $exact = 1; - $claws_condition = "$claws_condition regexpcase"; - } - } elsif ($cpart_two eq "ends with") { - $endswith = 1; - $claws_condition = "$claws_condition regexpcase"; - } elsif ($cpart_two eq "begins with") { - $beginswith = 1; - $claws_condition = "$claws_condition regexpcase"; - } elsif ($cpart_two eq "is in ab") { - $addrbook = 1; - $claws_condition = "found_in_addressbook \"$claws_condition\" in \"Any\" "; - } elsif ($cpart_two eq "isn't in ab") { - $addrbook = 1; - $claws_condition = "~found_in_addressbook \"$claws_condition\" in \"Any\" "; - } elsif ($cpart_two eq "is greater than") { - if ($size_condition) { - $claws_condition .= "size_greater"; - } - if ($age_condition) { - $claws_condition .= "age_greater"; - } - } elsif ($cpart_two eq "is less than") { - if ($size_condition) { - $claws_condition .= "size_smaller"; - } - if ($age_condition) { - $claws_condition .= "age_lower"; - } - } - - if ($exact || $beginswith || $endswith) { - $cpart_thr = escape_regex($cpart_thr); - } - if ($exact) { - $cpart_thr = "^$cpart_thr\$"; - } elsif ($beginswith) { - $cpart_thr = "^$cpart_thr"; - } elsif ($endswith) { - $cpart_thr = "$cpart_thr\$"; - } - unless ($addrbook) { - if ($exact_age) { - my $lower_limit = $cpart_thr-1; - my $upper_limit = $cpart_thr+1; - $lower_limit =~ s/^\"//; - $lower_limit =~ s/\"$//; - $upper_limit =~ s/^\"//; - $upper_limit =~ s/\"$//; - $claws_condition = "$claws_condition"."age_lower" - . " $upper_limit $bool " - . "age_greater $lower_limit "; - } elsif ($size_condition || $age_condition) { - $claws_condition = "$claws_condition $cpart_thr "; - } else { - $claws_condition = "$claws_condition \"$cpart_thr\" "; - } - } - - if ($tbird_conditions[1] && $cond_count < $#tbird_conditions) { - $claws_condition = "$claws_condition$bool "; - } - } - $cond_count++; - } - if ($part_one) { - $conv_rules++; - push(@claws_filters, "$part_one$claws_condition$part_three$part_four\n"); - } - } - } - } - push(@claws_filters, "\n"); - return($conv_rules,$ignored_rules,$ignored_list); -} - -sub rewrite_mailbox_name { - my ($path) = @_; - - my $new_path; - - my ($front,$back) = split(/\/\//, $path, 2); - - if ($front =~ m/^"mailbox/) { - $new_path = "\"#mh/$mailbox/"; - } else { - $new_path = "\"#imap/$mailbox/"; - } - - my ($box,$name) = split(/\//, $back, 2); - - if ($new_path =~ m/^"#mh/) { - $name =~ s/^Inbox/inbox/; - $name =~ s/^Sent/sent/; - $name =~ s/^Drafts/draft/; - $name =~ s/^Trash/trash/; - } - $new_path = $new_path.$name; - - return($new_path); -} - -sub escape_regex { - my ($string) = @_; - - my $escstr = ""; - my $symbols = qr/^(?:\[|\]|\{|\}|$|$|\||\+|\*|\.|\-|\$|\^)$/; - my @chars = split(//, $string); - - foreach my $char (@chars) { - if ($char =~ m/$symbols/) { $char = "\\\\$char"; } - $escstr .= $char; - } - - return($escstr); -} blob - c79b526860754886fe1d6f4868a116f3e8e0b2f2 (mode 755) blob + /dev/null --- tools/update-po +++ /dev/null @@ -1,66 +0,0 @@ -#!/bin/sh - -# * Copyright � 2002 Wilbert Berendsen -# * -# * This file is free software; you can redistribute it and/or modify it -# * under the terms of the GNU General Public License as published by -# * the Free Software Foundation; either version 3 of the License, or -# * (at your option) any later version. -# * -# * This program is distributed in the hope that it will be useful, but -# * WITHOUT ANY WARRANTY; without even the implied warranty of -# * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# * General Public License for more details. -# * -# * You should have received a copy of the GNU General Public License -# * along with this program; if not, write to the Free Software -# * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. -# * - -# update-po -- for Claws Mail -# by Wilbert Berendsen -# This script updates the .po files named on the command line. -# Run this script from within the po/ directory! - -if [ "$1" -a -f "$1" ] ; then - - - # - # Make a messages.pot file containing all the msgid's from - # the source - - make -C .. -f - < $po - done - -else - - echo - echo "Usage:" - echo - echo " ./`basename $0` lang.po lang2.po ..." - echo - echo "to update one or more .po files from the sourcecode files" - echo "named in POTFILES.in. The old .po file is save in a .po.old file." - echo - echo "When you e.g. want to update fr.po, run ./`basename $0` fr.po, then" - echo "edit fr.po to update your translation." - echo - -fi blob - 9b106bb216b770ae6446948758416bf88ccee64b (mode 755) blob + /dev/null --- tools/uudec +++ /dev/null @@ -1,2 +0,0 @@ -#!/bin/sh -uudecode -o - "$1" | display - blob - 6a5dc060c4a3581d43aadd457a2eb5b5763f2610 (mode 755) blob + /dev/null --- tools/uuooffice +++ /dev/null @@ -1,25 +0,0 @@ -#!/bin/sh - -# * Copyright 2005 Tristan Chabredier -# * -# * This file is free software; you can redistribute it and/or modify it -# * under the terms of the GNU General Public License as published by -# * the Free Software Foundation; either version 3 of the License, or -# * (at your option) any later version. -# * -# * This program is distributed in the hope that it will be useful, but -# * WITHOUT ANY WARRANTY; without even the implied warranty of -# * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# * General Public License for more details. -# * -# * You should have received a copy of the GNU General Public License -# * along with this program; if not, write to the Free Software -# * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. -# -# uuooffice helper script to open documents attached to emails with OpenOffice - -FILENAME=$(grep -Em 1 "^begin [0-7][0-7][0-7] ." "$1" | cut -d ' ' -f 3-) -TMPFILE=/tmp/${0##*/}_$FILENAME -uudecode -o - "$1" > "$TMPFILE" -ooffice "$TMPFILE" -rm -f "$TMPFILE" blob - 473c85b6186f4692d08ed2a83ca202fe15d83b7a (mode 755) blob + /dev/null --- tools/vcard2xml.py +++ /dev/null @@ -1,310 +0,0 @@ -#!/usr/bin/env python3 -# -*- coding: latin-1 -*- -""" - -Copyright � 2003 Bogdan Sumanariu - - This file is free software; you can redistribute it and/or modify it - under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. - - script name : evolutionvcard2claws.py - - script purpose : convert an evolution addressbook VCARD file - into a Claws Mail addressbook - - tested with evolution 1.2.x, and 1.4.x - -""" - -import string -import sys -import time -import os -from io import StringIO - -keywds = ('x-evolution-file-as','fn', 'n','email;internet','nickname', 'url', 'org') - -def normalizeLongLines(file): - """ - Skip line breaks after 72 chars - """ - buf = '' - - line = file.readline() - while line: - if line[0] == ' ': - buf = buf.rstrip('\n') - line = line.lstrip(); - buf += line - else: - buf += line - line = file.readline() - - return buf - -def getEmailAddress(vcard): - """ - Get email address. - Supported formats: - - email;something - - email;type=something - something := (internet,work,home, other) - """ - - for key in vcard: - items = key.split(';') - if len(items) == 2: - if items[0].lower() == 'email': - list = vcard[key] - return list[0] - else: - if key.lower() == 'email': - list = vcard[key] - return list[0] - - return "" - -def findName(vcard): - """ - Find a version 3.0 name - """ - for key in vcard: - items = key.split(';') - if len(items) == 2: - if items[0].lower() == 'n': - return vcard[key] - else: - if key.lower() == 'n': - return vcard[key] - - return None - -################################################################################ -## reads a vcard and stores as hash pairs key/value where value is a list ## -################################################################################ - -def readVCARD (buffer) : - - """ - - skips fom until a 'begin' tag from VCARD is encountered. - from this point starts constructing a map (key, [values] ) - VCARD entry format -> tag:value - - key <- tag - [values] <- list with the values of if there are more tags with the same name - - """ - r=' ' - bgn,end = -1, -1; - d = dict() - while r and bgn < 0 : - r = buffer.readline() - if len (r) == 0 : return dict() - if r.strip().lower().find('begin') : - bgn = 1 - while r and end < 0 : - r = buffer.readline() - s = r.strip().lower().split(':') - if s[0] != '' : - if s[0] in d : - d[s[0]].append(s[1]) - elif len(s) > 1: - d[s[0]] = [s[1]] - else : - d[s[0]] = [''] - if s[0] == 'end' : end = 1 - return d - -################################################################################## - -############################################################################################### -## writes on a given file an xml representation for claws-mail addressbook received as a hash ## -############################################################################################### - -def writeXMLREPR (vcard,file,uid) : - - """ - based on and writes only recognized tags (the ones defined in list) - NOTE: and tag will be written as attributes (there are such tags in claws-mail's - XML schema) - """ - if len (vcard.keys()) == 0 : return - item = vcard.get(keywds[2]); - if item: - name = item[0].split(';') - else: - """ version 3.0 n ?""" - name = findName(vcard) - if not name: - return - - fn, ln, nick, cn, a = '', '', '', '', '' - - if len(name) >= 2 : - fn = name[0] - ln = name[1] - elif len(name) ==1 : - fn = name[0] - - if keywds[4] in vcard : - nick = vcard.get(keywds[4])[0] - if len(vcard.get(keywds[1])[0]) : - cn = vcard.get(keywds[1])[0] - else : - cn = vcard.get(keywds[0])[0]; - - a += str('\n\n') - a += '\t\n' - if vcard.get(keywds[3]) : - for c in vcard.get(keywds[3]) : - uid[0] = uid[0] + 1 - a += '\t\t

\n' - else : - email = getEmailAddress(vcard) - uid[0] = uid[0]+1 - a += '\t\t

\n' - a += '\t\n' - a += '\t\n' - for key in keywds[5:] : - if vcard.get(key) : - for c in vcard.get(key) : - uid[0] = uid[0] + 1 - a += '\t\t'+c+'\n' - a += '\t\n' - a += '\n' - file.write(a) - file.flush() - -################################################################################################### - -def convert (in_f, o_f, name='INBOX') : - d = {'d':1} - uid = [int(time.time())] - - try : - print('proccessing...\n') - o_f.write('\n\n'); - - buf = normalizeLongLines(in_f) - buffer = StringIO(buf) - while len(d.keys()) > 0 : - d = readVCARD(buffer) - writeXMLREPR (d, o_f, uid) - uid[0] = uid [0]+1 - - o_f.write('\n') - print('finished processing...\n') - except IOError as err : - print('Caught an IOError : ',err,'\t ABORTING!!!') - raise err - -################################################################################################# - -def execute () : - if len(sys.argv) != 3 and len(sys.argv) != 2 : - print(str("\nUsage: vcard2xml.py source_file [destination_file]\n\n" + - '\tWhen only is specified will overwrite the existing addressbook.\n'+ - '\tWhen both arguments are suplied will create a new additional addressbook named \n\tas the destination file.'+'\n\tNOTE: in both cases the Claws Mail must be closed and ran at least once.\n\n')) - sys.exit(1) - - in_file = None - out_file = None - path_to_out = os.environ['HOME']+'/.claws-mail/addrbook/' - adr_idx = 'addrbook--index.xml' - adr_idx_file = None - tmp_adr_idx_file= None - got_ex = 0 - - try : - in_file = open(sys.argv[1]) - except IOError as e: - print('Could not open input file <',sys.argv[1],'> ABORTING') - sys.exit(1) - - if len(sys.argv) == 2 : - try : - dlist = os.listdir(path_to_out); - flist=[] - for l in dlist : - if l.find('addrbook') == 0 and l.find("addrbook--index.xml") < 0 and l.find('bak') < 0 : - flist.append(l) - flist.sort() - out_file = flist.pop() - os.rename(path_to_out+out_file, path_to_out+out_file+'.tmp') - out_file = open(path_to_out+out_file,'w') - convert(in_file, out_file) - except Exception as e: - got_ex = 1 - print('got exception: ', e) - else : - try : - os.rename(path_to_out+adr_idx, path_to_out+adr_idx+'.tmp') - tmp_adr_idx_file = open(path_to_out+adr_idx+'.tmp') - adr_idx_file = open(path_to_out+adr_idx,'w') - except Exception as e : - print('Could not open <', path_to_out+adr_idx,'> file. Make sure you started Claws Mail at least once.') - sys.exit(1) - try : - out_file = open(path_to_out+sys.argv[2],'w') - convert(in_file, out_file, sys.argv[2].split('.xml')[0]) - l = tmp_adr_idx_file.readline() - while l : - if l.strip() == '' : - adr_idx_file.write('\t\n') - adr_idx_file.write(l) - else : - adr_idx_file.write(l) - l = tmp_adr_idx_file.readline() - except Exception as e: - got_ex = 1 - print('got exception: ', e) - - - if got_ex : - #clean up the mess - print('got exception, cleaning up the mess... changed files will be restored...\n') - if adr_idx_file : - adr_idx_file.close() - if out_file : - out_file.close() - if len(sys.argv) == 2 : - os.rename(out_file.name+'.tmp', out_file.name) - else : - os.remove(out_file.name) - os.rename(path_to_out+adr_idx+'.tmp', path_to_out+adr_idx) - if tmp_adr_idx_file : - tmp_adr_idx_file.close() - - else : - #closing all and moving temporary data into place - print('closing open files...\n') - in_file.close() - out_file.close() - if len(sys.argv) == 3 : - os.rename(path_to_out+adr_idx+'.tmp',path_to_out+adr_idx+'.bak' ) - if len(sys.argv) == 2 : - os.rename(out_file.name+'.tmp', out_file.name+'.bak') - if adr_idx_file : - adr_idx_file.close() - if tmp_adr_idx_file : - tmp_adr_idx_file.close() - print('done!') - - -if __name__ == '__main__': - execute () - -