Net::IMAP - A client interface to IMAP (Internet Message Access Protocol).

WARNING: This code is in alpha release. Expect the interface to change release to release.

CWuse Net::IMAP;

CWNet::IMAP provides a perl interface to the client portion of IMAP (Internet Message Access Protocol).

add more meat - describe overall design (commands, responses, callbacks, convenience routines

Creates a new CWNet::IMAP object, connects to CW$host on port 143, performs some preliminary setup of the session, and returns a reference to the object.

Once connected, it processes the connection banner sent by the server. If the considers the session to be preauthenticated, CWnew notes the fact, allowing commands to be issued without logging in.

The method also issues a CWcapability command, and notes the result. If the server does support IMAP4rev1, the method closes the connection and returns CWundef.

The client will use non-synchronizing literals if the server supports the CWLITERAL+ extension (RFC2088) and the CWNonSyncLits options is set to CW1.

The following CWNet::xAP options are relevant to CWNet::IMAP:

CWNet::IMAP also understands the following options, specific to the module: Controls what style of end-of-line processing to presented to the end-programmer. The default, CW'lf', assumes that the programemr wants to fling messages terminated with bare LFs when invoking append, and when fetching messages. In this case, the module will map to/from CRLF accordingly. If CWEOL is set to CW'crlf', the assumption is that the programmer wants messages, or portions of messages, to be terminated with CRLF. It also assumes the programmer is providing messages terminated with the string when invoking the CWappend method, and will not provide an EOL mapping.

There are numerous commands in the IMAP protocol. Each of these are mapped to a corresponding method in the CWNet::IMAP module.

Some commands can only be issued in certain protocol states. Some commands alter the state of the session. These facts are indicated in the documentation for the individual command methods.

The following list enumerates the protocol states:

Non-authenticated

The client has not authenticated with the server. Most commands are unavailable in this state.

Authenticated

The client has authenticated with the server.

Selected

The client has opened a mailbox on the server.

Sends a CWnoop command to the server. It is valid in any protocol state.

This method is useful for placating the auto-logout god, or for triggering pending unsolicited responses from the server.

The CWcapability method retrieves the capabilities the IMAP server supports. This method is valid in any protocol state.

The server sends a CWcapability response back to the client.

If the response does not indicate support for the CWLITERAL+ extension, the CWNonSyncLits option is forced off.

Logs off of the server. This method is valid in any protocol state. Logs into the server using a simple plaintext password. This method is only valid when the protocol is in the non-authenticated state.

If the server supports RFC2221 (IMAP4 Login Referrals), the completion response could include a referral. See RFC2221 for further information about login referrals.

If successful, the session state is changed to authenticated. Logs into the server using the authentication mechanism specified in CW$authtype. This method is only valid when the protocol is in the non-authenticated state.

The IMAP CWauthenticate command is the same as that documented in RFC2222 (Simple Authentication and Security Layer (SASL)), despite the fact that IMAP predates SASL.

If successful, the session state is changed to authenticated.

The following authentication mechanisms are currently supported: This is a variation on the simple login technique, except that the information is transmitted in Base64. This does not provide any additional security, but does allow clients to use CWauthenticate. This implements the authentication mechanism defined in RFC2195 (IMAP/POP AUTHorize Extension for Simple Challenge/Response). It uses keyed MD5 to avoid sending the password over the wire. This implements the authentication mechanism defined in RFC2245 (Anonymous SASL Mechanism). Anonymous IMAP access is intended to provide access to public mailboxes or newsgroups.

The method returns CWundef is CW$authtype specifies an unsupported mechanism or if the server does not advertise support for the mechanism. The CWhas_authtype method can be used to see whether the server supports a particular authentication mechanism.

In general, if the server supports a mechanism supported by CWNet::IMAP, the CWauthenticate command should be used instead of the CWlogin method. Opens the specified mailbox with the intention of performing reading and writing. This method is valid only when the session is in the authenticated or selected states.

If successful, the server sends several responses: CWflags, CWexists, CWresent, as well as CWok responses containing a CWunseen, CWpermanentflags, CWuidnext, and CWuidvalidity codes. If also changes the session state to selected.

If server returns a CWno response containing a CWnewname response code, this means CW$mailbox does not exist but the server thinks this is because the folder was renamed. In this case, try specifiying the new folder name provided with the CWnewname response code. Opens the specified mailbox in read-only mode. This method is valid only when the session is in the authenticated or selected states. Creates the specified mailbox. This method is valid only when the session is in the authenticated or selected states.

The optional CW$partition argument is only valid with the Cyrus IMAP daemon. Refer to the section 'Specifying Partitions with create' the CWdoc/overview file for that package for further information. This feature can only be used by administrators creating new mailboxes. Other servers will probably reject the command if this argument is used. The results are undefined if another server accepts a second argument. Deletes the specified mailbox. Returns CWundef if CW$mailbox is the currently open mailbox. This method is valid only when the session is in the authenticated or selected states. Renames the mailbox specified in CW$oldmailbox to the name specified in CW$newmailbox. This method is valid only when the session is in the authenticated or selected states.

The optional CW$partition argument is only valid with the Cyrus IMAP daemon. Refer to the section 'Specifying Partitions with rename' the CWdoc/overview file for that package for further information. This feature can only be used by administrators. Other servers will probably reject the command if this argument is used. The results are undefined if another server accepts a third argument. Subscribe to the specified CW$mailbox. Subscribing in IMAP is subscribing in Usenet News, except that the server maintains the subscription list. This method is valid only when the session is in the authenticated or selected states. Unsubscribe from the specified CW$mailbox. This method is valid only when the session is in the authenticated or selected states. Send an IMAP CWlist command to the server. This method is valid only when the session is in the authenticated or selected states.

Although IMAP folders do not need to be implemented as directories, think of an IMAP reference name as a parameter given to a CWcd or CWchdir command, prior to checking for folders matching CW$mailbox_pattern.

The CW$mailbox_pattern parameter allows a couple wildcard characters to list subsets of the mailboxes on the server.

•

Matches zero or more characters at the specified location.

%

Like CW*, matches zero or more characters at the specified location, but does not match hierarchy delimiter characters. If the last character in CW$mailbox_pattern is a CW%, matching levels of hierarchy are also returned. In other words: subfolders.

This method will fail, returning CWundef, if CW$mailbox_pattern is CW*. This behavior is not built into the IMAP protocol; it is wired into CWNet::IMAP. Doing otherwise could be rude to both the client and server machines. If you want to know why, imagine doing CWlist('#news.', '*') on a machine with a full news feed. The CW% character should be used to build up a folder tree incrementally.

If successful, the server sends a series of CWlist responses.

Please note that the CW$referencename is an IMAPism, not a Perl reference. Also note that the wildcards usable in CW$mailbox_pattern are specific to IMAP. Perl regexps are not usable here. Sends an IMAP CWlsub command to the server. The CWlsub command is similar to the CWlist command, except that the server only returns subscribed mailboxes. This method is valid only when the session is in the authenticated or selected states.

The parameters are the same as those for the CWlist method.

If successful, the server sends a series of CWlsub responses. Retrieves status information for the specified CW$mailbox. This method is valid only when the session is in the authenticated or selected states.

Per RFC2060, the CW@statusattrs can contain any of the following strings:

* messages

The number of messages in the mailbox.

* recent

The number of messages with the CW\recent flag set.

* uidnext

The UID expected to be assigned to the next mailbox appended to the mailbox. This requires some explanation. Rather than using this value for prefetching the next UID, it should be used to detect whether messages have been added to the mailbox. The value will not change until messages are appended to the mailbox.

* uidvalidity

The unique identifier validity value of the mailbox.

* unseen

The number of messages without the CW\seen flag set.

This method will fail, returning CWundef if CW$mailbox is the currently open mailbox.

If successful, the server sends one or more CWstatus responses.

The status operation can be rather expensive on some folder implementations, so clients should use this method sparingly. Appends the email message specified in CW$message to the mailbox specified in CW$mailbox. This method is valid only when the session is in the authenticated or selected states.

In general, the email message should be a real RFC822 message, although exceptions such as draft messages are reasonable in some situations. Also note that the line terminators in CW$message need to be CRLF.

The CWFlags option allows a set of flags to be specified for the message when it is appended. Servers are not required to honor this, but most, if not all, do so.

The CWDate option forces the internaldate to the specified value. If CW$date is a string, the format of the string is CWdd-mmm-yyyy hh:mm:ss [-+]zzzz, where CWdd is the day of the month (starting from 1), CWmmm is the three-character abbreviation for the month name, CWyyyy is the 4-digit year, CWhh is the hour, CWmm is the minutes, CWss is the seconds, and CW[-+]zzzz is the numeric timezone offset. This happens to be the same format returned by the CWinternaldate item from the CWfetch command. If CW$date is a list reference, it is expected to contain two elements: a time integer and a timezone offset string. The timezone string is expected to be formatted as CW[-+]zzzz. These two values will be used to synthesize a string in the format expected by the IMAP server. As with the CWFlags options, servers are not required to honor the CWDate option, but most, if not all, do so.

Note that the options are specified at the end of the list of method arguments. This is due to the fact that it is possible to have a CW$mailbox named CWFlags or CWDate. Processing the options at the end of the argument list simplifies argument processing. The order of the arguments will be changed if enough people complain.

If server returns a CWno response containing a CWtrycreate response code, this means CW$mailbox does not exist but the server thinks the command would have succeeded if the an appropriate CWcreate command was issued. On the other hand, failure with no CWtrycreate response code generally means that a CWcreate should not be attempted.

Ask the server to perform a checkpoint of its data. This method is valid only when the session is in the selected state.

While not always needed, this should be called if the client issues a large quantity of updates to a folder in an extended session.

Close the current mailbox. This method is valid only when the session is in the selected state.

If successful, the session state is changed to authenticated.

Delete messages marked for deletion. This method is valid only when the session is in the selected state.

If successful, the server sends a series of CWexpunge responses.

It will return CWundef is the mailbox is marked read-only. Searches the mailbox for messages matching the criteria contained in CW@searchkeys. This method is valid only when the session is in the selected state.

The CW@searchkeys list contains strings matching the format described in Section 6.4.4 of RFC2060.

If successful, the server send zero or more CWsearch responses. Lack of a CWsearch response means the server found no matches. Note that the server can send the results of one search in multiple responses. Retrieves data about a set of messages. This method is valid only when the session is in the selected state.

The CW$msgset parameter identifies the set of messages from which to retrieve the items of interest. The notation accepted is similar to that found in CW.newsrc files, except that CW: is used to specify ranges, instead of CW-. Thus, to specify messages 1, 2, 3, 5, 7, 8, 9, the following string could be used: CW'1:3,5,7:9'. The character CW* can be used to indicate the highest message number in the mailbox. Thus, to specify the last 4 messages in an 8-message mailbox, you can use CW'5-*'.

The following list enumerates the items that can be retrieved with CWfetch. Refer to Section 6.4.5 of RFC2060 for a description of each of these items.

* body[$section]<$partial>

* body.peek[$section]<$partial>

Important: the response item returned for a CWbody.peek is CWbody.

* bodystructure

* body

* envelope

* flags

* internaldate

* rfc822

* rfc822.header

* rfc822.size

* rfc822.text

* uid

Please note that the items returning messages, or portion of messages, return strings terminated with CRLF.

RFC2060 also defines several items that are actually macros for other sets of items:

* all

A macro equivalent to CW('flags', 'internaldate', 'rfc822.size', 'envelope').

* full

A macro equivalent to CW('flags', 'rfc822.size', 'envelope', 'body').

* fast

A macro equivalent to CW('flags', 'internaldate', 'rfc822.size').

The CWall, CWfull, and CWfast items are not intended to be used with other items.

If successful, the server responses with one or more CWfetch responses.

If the completion response from a CWfetch command is CWno, the client should send a CWnoop command, to force any pending expunge responses from the server, and retry the CWfetch command with CW$msgset adjusted accordingly. Sets various attributes for the messages identified in CW$msgset. This method is valid only when the session is in the selected state.

The CW$msgset parameter is described in the section describing CWfetch.

The CW$itemname can be one of the following:

* flags

Replaces the current flags with the flags specified in CW@storeattrflags.

* +flags

Adds the flags specified in CW@storeattrflags to the current flags.

* -flags

Removes the flags specified in CW@storeattrflags from the current flags.

The CW$itemname can also have CW.silent appended, which causes the server to not send back update responses for the messages.

If successful, and CW.silent is used used in CW$itemname, the server response with a series of CWfetch responses reflecting the updates to the specified messages.

If the completion response from a CWstore command is CWno, the client should send a CWnoop command, to force any pending expunge responses from the server, and retry the CWstore command with CW$msgset adjusted accordingly.

The CW@storeattrflags is a list of flag strings. Copy the messages CW$msgset to the specified mailbox. This method is valid only when the session is in the selected state.

The CW$msgset parameter is described in the section describing CWfetch.

If server returns a CWno response containing a CWtrycreate response code, this means CW$mailbox does not exist but the server thinks the command would have succeeded if the an appropriate CWcreate command was issued. On the other hand, failure with no CWtrycreate response code generally means that a CWcreate should not be attempted. A variant of CWcopy that uses UIDs in CW$msgset, instead of message numbers. This method is valid only when the session is in the selected state. A variant of CWfetch that uses UIDs, instead of message numbers, in CW$msgset and CWfetch responses. This method is valid only when the session is in the selected state. A variant of CWsearch that uses UIDs, instead of message numbers, in CW$msgset and CWsearch responses. This method is valid only when the session is in the selected state. A variant of CWstore that uses UIDs, instead of message numbers, in CW$msgset and CWfetch responses. This method is valid only when the session is in the selected state.

In addition to the core protocol methods, CWNet::IMAP provides several methods for accessing various pieces of information.

Returns a boolean valud indicating whether the IMAP session is preauthenticated.

Returns the banner string issued by the server at connect time.

Returns the list of capabilities supported by the server, minus the authentication capabilities. The list is not guaranteed to be in any specific order. Returns a boolean value indicating whether the server supports the specified capability.

Returns a list of authentication types supported by the server. Returns a boolean value indicating whether the server supports the specified authentication type.

Returns the quantity of messages in the currently selected folder.

Returns the quantity of recent messages in the currently selected folder.

Returns the message number of the first unseen messages in the currently selected folder.

Returns the CWuidvalidity value for the currently selected folder. This is useful for IMAP clients that cache data in persistent storage. Cache data for a mailbox should only be considered valid if the CWuidvalidity is the same for both cached data and the remote mailbox. See Section 2.3.1.1 of RFC2060 for further details.

Returns the CWuidnext value for the currently selected folder.

Returns the list of permanent flags the server has identified for the currently open mailbox.

If a CW\* flag is present, the server allows new persistent keywords to be created. Returns a boolean value indicating whether the server considers CW$flag to be a permanent flag.

Returns a list of the flags associated with the mailbox. Returns a boolean value indicating whether the given CW$flag is defined for the mailbox.

Returns the name of the currently open mailbox. Returns CWundef if no mailbox is currently open.

Returns a boolean value indicating whether the currently open mailbox is read-only.

The following methods are available if the server advertises support for RFC2342 (IMAP4 Namespace). Refer to that RFC for additional information.

Sends a CWnamespace command to the server, if the server advertises support for the extension extension.

The following methods are available if the server advertises support for RFC2086 (IMAP4 ACL Extension). Refer to that RFC for additional information. Sets the access control list for CW$identifier on CW$mailbox according to the rights contained in CW$modrights.

The CW$identifier typically identifies an account name, but can also specify abstract entities, such as groups.

The format for CW$modrights is documented in RFC2086. Retrieves the access control list for CW$mailbox. Deletes all access control list entries for CW$identifier from CW$mailbox. List the rights available to CW$identifier for CW$mailbox. List the rights the current user has for CW$mailbox.

The following methods are available if the server advertises support for RFC2087 (IMAP4 Quota Extension). Refer to that RFC for additional information. Lists the resource usage and limits for CW$quotaroot. Sets the resource limits for CW$quotaroot to CW@setquotalist.

Valid values for CW@setquotalist are server-dependant. Lists the quota roots for CW$mailbox.

The following method is available if the server advertises support for RFC2359 (IMAP4 UIDPLUS Extension). Refer to that RFC for additional information. A variant of CWexpunge that allows the operation to be narrowed to the messages with UIDs specified in CW$msgset.

The CW$msgset parameter is described in the section describing CWfetch.

Many of the command methods result in the server sending back response data. CWNet::IMAP processes each response by parsing the data, packages it in an appropriate object, and optionally calls a programmer-defined callback for the response. This callback mechanism is how programmers get access to the data retrieved from the server. Assigns a programmer-defined code reference to the associated untagged response. When an untagged response matching CW$item is received, CW$coderef is called, with the IMAP object and the associated response object passed as parameters.

The default callback for the CWok, CWbye, CWbad, and CWno untagged responses includes code to output the text from CWalert responses to stderr, using CWcarp. If you set your own callback for these responses, be sure to code handle CWalert codes. Per Section 7.1 of RFC2060, clients are required to clearly display CWalert messages to users.

As mention in the previous section, responses are parsed and packaged into response objects, which are then passed to callbacks. Each type of response has a corresponding object class. This section describes the various response objects provided.

All of the class names itemized below are prefixed with CWNet::IMAP.

As a general rule, IMAP CWnil items are set to CWundef in the parsed data, and IMAP parenthetical lists are converted to list references (of one form or another). In addition, atoms, quoted strings, and literals are presented as Perl strings.

The condition responses (CWok, CWno, CWbad, CWbye, and CWpreauth) can include a response code. Refer to Section 7.1 in RFC2060 for a description of each of the standard response codes.

This is the object class for completion responses.

Returns a boolean value indicating whether the response is tagged. In the case of tagged completion responses, this value is always CW1.

Returns a boolean value indicating whether the CWTRYCREATE response code is present in the response. This can be used after a failed CWappend or CWcopy command to determine whether the server thinks the operation would succeed if a CWcreate was issued for the associated mailbox.

This class is common to all untagged server responses.

Returns a string containing the tag associated with the response. In the case of untagged responses, this is always CW*.

Returns a boolean value indicating whether the response is tagged. Obviously, in the case of untagged responses, this value is always CW0.

Returns a reference to the parent IMAP object.

This is a container for untagged CWok responses from the server.

Returns a list reference containing response code elements in the response. Returns CWundef if no response code is present.

Returns the name of the response. In the case of CWOk, this returns 'ok'. This method is provided as a convenience for end-programmers wanting to write one common subroutine for one or more of the responses CWOk, CWNo, CWBad, and CWBye.

This is a container for untagged CWno responses from the server.

This is a container for untagged CWbad responses from the server.

This is a container for untagged CWbye responses from the server.

This is a container for CWexpunge responses from the server.

The information returned by CWqty_messages is automatically updated when CWexpunge responses are received.

Returns the message number specified in the CWexpunge response.

This is a container for CWcapability responses.

Returns the list of capabilities supported by the server, minus the authentication capabilities. The list is not guaranteed to be in any specific order. Returns a boolean value indicating whether the server supports the specified capability.

Returns a list of authentication types supported by the server. Returns a boolean value indicating whether the server supports the specified authentication type.

This is a container for CWlist responses.

Returns the name of the mailbox contained in the object.

Returns the hierarchy delimiter associated with the mailbox.

Returns a list of the flags associated with the mailbox. Returns a boolean value indicating whether the given CW$flag is defined for the mailbox.

This is a container for CWlsub responses. It provides the same interface as the CWNet::IMAP::List class.

This is a container for CWfetch responses.

Responses for partial fetches bear special mention. While both the starting byte and quantity of bytes are specified when doing partial fetches with the CWfetch command, the corresponding response will only show the starting byte. In other words, the command CW$imap->fetch(1, 'body[]<0.1024>' will, if successful, result in a fetch response item of CWbody[]<0> containing a 1024 octet value. To match a given response for a partial fetch, you might need to use CWlength to match it up with the corresponding item specified in the CWfetch command.

Returns the message number identified in the response.

Returns the list of data item names contained in the response. The list is not guaranteed to be in any specific order. Returns the data associated with the specified data item.

The following list enumerates the data types associated with each fetch item:

envelope

Net::IMAP::Envelope

bodystructure

Net::IMAP::BodyStructure

body

Net::IMAP::BodyStructure

flags

Net::IMAP::Flags

UID

Integer

rfc822.size

Integer

default

String

This is a container for CWstatus responses.

Returns a string containing the mailbox the status information is associated with.

Returns the list of status items contains in the status response. Returns the value of the CW$item status item.

This is a container for CWsearch responses.

Returns the list of message numbers contained in the response.

This is a container for CWflags responses.

Returns the list of flags contained in the response. Returns a boolean value indicating whether the specified flag is contained in the response.

As a convenience, the information from the CWflags response is also stored in the parent CWNet::IMAP object, and is available via CWNet::IMAP versions of the CWflags and CWhas_flags methods.

This is a container for CWexists responses.

Returns the quantity of messages in the currently selected mailbox.

This is information is also available in the CWqty_messages method in the CWNet::IMAP class.

This is a container for CWrecent responses.

Returns the number of messages with the CW\recent flag set.

This information is also available in the CWqty_recent method in the CWNet::IMAP class.

This is a container for CWnamespace responses.

With no argument specified, returns a list of personal namespaces. If CW$namespace is specified, returns the delimiter character for the specific personal namespace.

With no argument specified, returns a list of other users' namespaces. If CW$namespace is specified, returns the delimiter character for the specific other users' namespace.

With no argument specified, returns a list of shared namespaces. If CW$namespace is specified, returns the delimiter character for the specific shared namespace.

This is a container for CWacl responses>

Returns the name of the mailbox associated with the given ACL data.

Returns a list of identifiers contained in the ACL data.

This is a container for CWlistrights responses.

Returns the name of the mailbox associated with the given rights.

Returns a string containing the identifier associated with the rights.

Returns a string containing the rights contained in the response.

This is a container for CWmyrights responses>

Returns the name of the mailbox associated with the given rights.

Returns a string containing the rights contained in the response.

This is a container for CWquota responses.

Returns a string containing the name of the quota root in the response.

Returns a list of the quotas contained in the response. Returns the usage value associated with the given CW$quota. Returns CWundef is the given CW$quota is not present in the response. Returns the usage limit associated with the given CW$quota. Returns CWundef is the given CW$quota is not present in the response.

This is a container for CWquotaroot responses.

Returns the name of the mailbox associated with the quotaroot data.

If called in an array context, returns the list of quotaroots associated with the mailbox. If called in a scalar context, returns a list reference.

A CWfetch response can be relatively complicated. This section documents various classes and methods associated with the various pieces of information available in CWfetch responses.

This is a container for CWbodystructure items in CWfetch responses.

Returns a string containing the MIME type of the message. This is the left-hand portion of a MIME media type. For example, the type of CWtext/plain is CWtext.

Returns a string containing the MIME subtype of the message. This is the right-hand portion of a MIME media type. For example, the subtype of CWtext/plain is CWplain.

Returns a reference to a hash containing the key/value attribute pairs in the CWContent-Type field.

If, for example, the CWContent-Type field was:

  Content-Type: text/plain; charset=us-ascii

The hash would contain one entry the a key of CWcharset, and a value of CWus-ascii. The key is always forced to be lowercase, but the case of the value is retained from the server.

Returns the disposition type in the CWContent-Disposition field. Returns CWundef if no such field exists.

Returns a reference to a hash containing the key/value attributer pairs in the CWContent-Disposition field. A reference to an empty hash is returned if no such field exists, or if there are no parameters in the field.

Returns a reference to a list of the language tags present in the CWContent-Language field. Returns a reference to an empty hash if no such field is present.

This is a container for CWBodyStructure objects that are multipart entities.

Returns a list reference of the body parts contained in the multipart entity.

This is a container for singlepart entities in CWBodyStructure and CWMultipart objects.

Return a string containing the contents of the CWContent-ID field, if one is present, otherwise returns undef.

Return a string containing the contents of the CWContent-Description field, if one is present, otherwise returns undef.

Returns a string containing the contents of the CWContent-Transfer-Encoding field. Returns CWundef if no such field is in the entity.

Returns the number of octets in the entity.

If the MIME content type is CWmessage/rfc822 or the major type is CWtext, returns the number of lines in the entity, else returns CWundef.

If the MIME content type is CWmessage/rfc822, returns a CWNet::IMAP::Envelope object, otherwise returns undef.

If the MIME content type is CWmessage/rfc822, returns a CWNet::IMAP::BodyStructure object, otherwise returns undef.

Returns a string containing the contents of the CWContent-MD5 field. Returns CWundef if no such field is in the entity.

This is a container for envelope data in CWfetch responses.

For those familiar with SMTP, this is not the same type envelope. Rather, it is a composite structure containing key source, destination, and reference information in the message. When retrieved from the server, it is populated into a CWNet::IMAP::Envelope object. The following methods are available.

Returns a string with the contents of the CWDate field.

Returns a string with the contents of the CWSubject field.

Returns a list reference of CWNet::IMAP::Addr objects with the contents of the CWFrom field.

Returns a list reference of CWNet::IMAP::Addr objects with the contents of the CWSender field. If no CWSender field is present in the message, the server will default it to the contents of the CWFrom field.

Returns a list reference of CWNet::IMAP::Addr objects with the contents of the CWReply-To field. If no CWReply-To field is present in the message, the server will default it to the contents of the CWFrom field.

Returns a list reference of CWNet::IMAP::Addr objects with the contents of the CWTofield. Will return CWundef if no CWTo field exists in the message.

Returns a list reference of CWNet::IMAP::Addr objects with the contents of the CWCc field. Will return CWundef if no CWCc field exists in the message.

Returns a list reference of CWNet::IMAP::Addr objects with the contents of the CWBcc field. Will return CWundef if no CWBcc field exists in the message.

Returns a string with the contents of the CWIn-Reply-To field. Returns CWundef if no such field is present in the message.

Returns a string with the contents of the CWDate field. Returns CWundef if no such field is present in the message.

This is a container for address structures in CWEnvelope objects.

Returns a string containing the phrase portion of the address, or CWundef if no phrase is present.

Returns a string containing the route portion of the address, or CWundef if no route information is present.

Returns a string containing the localpart portion of the address, or CWundef if no localpart is present.

Returns a string containing the domain portion of the address, or CWundef if no domain is present.

Returns a string representation of the contents of the object.

Minimal testing has been done against the various IMAP server implementations. Refer to CWBUGS for known bugs/malfeatures.

Kevin Johnson <kjj@pobox.com>

Copyright (c) 1997-1999 Kevin Johnson <kjj@pobox.com>.

All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.