package
0.0.0-20150429134902-531c36c3f12d
Repository: https://github.com/mxk/go-imap.git
Documentation: pkg.go.dev
# Functions
AsAtom returns the value of an atom field.
AsBytes returns the value of a data field.
AsDateTime returns the value of a date-time quoted string field (e.g.
AsFieldMap returns a map of key-value pairs extracted from a parenthesized list.
AsFlags returns a set of flags extracted from a parenthesized list.
AsList returns the value of a parenthesized list.
AsMailbox returns the value of a mailbox name field.
AsNumber returns the value of a numeric field.
AsString returns the value of an astring (string or atom) field.
ByeFilter accepts the response if rsp.Status is BYE.
Dial returns a new Client connected to an IMAP server at addr.
DialTLS returns a new Client connected to an IMAP server at addr using the specified config for encryption.
ExternalAuth returns an implementation of the EXTERNAL authentication mechanism, as described in RFC 4422.
FetchFilter accepts FETCH and STORE command responses by matching message sequence numbers or UIDs, depending on the command type.
LabelFilter returns a new filter configured to accept responses with the specified labels.
NameFilter accepts the response if rsp.Label matches the command name.
NewClient returns a new Client instance connected to an IMAP server via conn.
NewFlagSet returns a new flag set with the specified flags enabled.
NewLiteral creates a new literal string from a byte slice.
NewLiteral8 creates a new binary literal string from a byte slice.
NewMockServer is an internal function exposed for use by the mock package.
NewSeqSet returns a new SeqSet instance after parsing the set string.
PlainAuth returns an implementation of the PLAIN authentication mechanism, as described in RFC 4616.
Quote returns the input as a quoted string for use in a command.
QuoteBytes returns the input as a quoted byte slice.
Quoted returns true if a string or []byte appears to contain a quoted string, based on the presence of surrounding double quotes.
QuotedUTF8 returns true if a string or []byte appears to contain a quoted string encoded in utf8-quoted format.
TypeOf returns the field data type.
Unquote is the reverse of Quote.
UnquoteBytes is the reverse of QuoteBytes.
UTF7Decode converts a string from modified UTF-7 encoding to UTF-8.
UTF7DecodeBytes converts a byte slice from modified UTF-7 encoding to UTF-8.
UTF7Encode converts a string from UTF-8 encoding to modified UTF-7.
UTF7EncodeBytes converts a byte slice from UTF-8 encoding to modified UTF-7.
Wait is a convenience function for transforming asynchronous commands into synchronous ones.
# Constants
String consisting of non-special ASCII characters.
Authenticated.
Protocol-level error.
Connection closing (untagged-only).
Decoded Base64 data.
Connection closed.
Continuation request.
Untagged data.
Date-time format used by INTERNALDATE.
Tagged command completion.
Parenthesized list.
String or binary data.
All messages.
Command execution.
Connection events.
Goroutine execution.
Not authenticated.
No messages.
Connection closing.
Raw data stream excluding literals.
State changes.
Case-insensitive atom string "NIL".
Operational error.
Unsigned 32-bit integer.
Success.
Greeting status indicating Auth state (untagged-only).
String enclosed in double quotes.
Mailbox selected.
Untagged status.
# Variables
BufferSize sets the size of the send and receive buffers (in bytes).
Default debug logging configuration for new Client instances.
Default debug logging configuration for new Client instances.
ErrAborted is returned by Command.Result when the command execution is interrupted prior to receiving a completion response from the server.
ErrBadUTF7 is returned to indicate invalid modified UTF-7 encoding.
Errors returned by the low-level data transport.
Errors returned by the low-level data transport.
ErrExclusive is returned when an attempt is made to execute multiple commands in parallel, but one of the commands requires exclusive client access.
ErrNotAllowed is returned when a command cannot be issued in the current connection state.
ErrTimeout is returned when an operation does not finish successfully in the allocated time.
SelectFilter accepts SELECT and EXAMINE command responses.
# Structs
Client manages a single connection to an IMAP server.
Command represents a single command sent to the server.
CommandConfig specifies command execution parameters.
LiteralInfo describes the attributes of an incoming or outgoing literal string.
MailboxInfo represents the mailbox attributes returned in a LIST or LSUB response.
MailboxStatus represents the mailbox status information returned in a STATUS response.
MemoryReader implements the LiteralReader interface by saving all incoming literals to memory.
MessageInfo represents the message attributes returned in a FETCH response.
ParserError indicates a problem with the server response format.
ProtocolError indicates a low-level problem with the data being sent by the client or server.
Quota represents a single resource limit on a mailbox quota root returned in a QUOTA response, as described in RFC 2087.
Response represents a single status, data, or command continuation response.
ResponseError wraps a Response pointer for use in an error context, such as when a command fails with a NO or BAD status condition.
SeqSet is used to represent a set of message sequence numbers or UIDs (see sequence-set ABNF rule).
ServerInfo contains information about the IMAP server with which SASL authentication is about to be attempted.
# Interfaces
Field represents a single data item in a command or response.
Literal represents a single incoming or outgoing literal string, as described in RFC 3501 section 4.3.
LiteralReader is the interface for receiving literal strings from the server.
MockServer is an internal type exposed for use by the mock package.
SASL is the interface for performing challenge-response authentication.
# Type aliases
ConnState represents client connection states.
FieldMap represents key-value pairs of data items, such as those returned in a FETCH response.
FieldType describes the data type of a single response field.
FlagSet represents the flags enabled for a single mailbox or message.
LogMask represents the categories of debug messages that can be logged by the Client.
NotAvailableError is returned when the requested command, feature, or capability is not supported by the client and/or server.
ResponseFilter defines the signature of functions that determine response ownership.
RespStatus is the code sent in status messages to indicate success, failure, or changes in the connection state.
RespType indicates the type of information contained in the response.
SeqSetError is used to report problems with the format of a sequence set value.