diff options
Diffstat (limited to 'src/objc/abstract/MCOConstants.h')
| -rw-r--r-- | src/objc/abstract/MCOConstants.h | 308 |
1 files changed, 154 insertions, 154 deletions
diff --git a/src/objc/abstract/MCOConstants.h b/src/objc/abstract/MCOConstants.h index a8cf7bd4..6f9dd446 100644 --- a/src/objc/abstract/MCOConstants.h +++ b/src/objc/abstract/MCOConstants.h @@ -2,321 +2,321 @@ #define __MAILCORE_MCOCONSTANTS_H_ -// It's the connection type. +/** It's the connection type.*/ typedef enum { - // Clear-text connection for the protocol. + /** Clear-text connection for the protocol.*/ MCOConnectionTypeClear = 1 << 0, - // Clear-text connection at the beginning, then switch to encrypted connection using TLS/SSL - // on the same TCP connection. + /** Clear-text connection at the beginning, then switch to encrypted connection using TLS/SSL*/ + /** on the same TCP connection.*/ MCOConnectionTypeStartTLS = 1 << 1, - // Encrypted connection using TLS/SSL. + /** Encrypted connection using TLS/SSL.*/ MCOConnectionTypeTLS = 1 << 2, } MCOConnectionType; -// It's the authentication type. +/** It's the authentication type.*/ typedef enum { - // Default authentication scheme of the protocol. + /** Default authentication scheme of the protocol.*/ MCOAuthTypeSASLNone = 0, - // CRAM-MD5 authentication RFC 2195. + /** CRAM-MD5 authentication RFC 2195.*/ MCOAuthTypeSASLCRAMMD5 = 1 << 0, - // PLAIN authentication RFC 4616. + /** PLAIN authentication RFC 4616.*/ MCOAuthTypeSASLPlain = 1 << 1, - // GSSAPI authentication. + /** GSSAPI authentication.*/ MCOAuthTypeSASLGSSAPI = 1 << 2, - // DIGEST-MD5 authentication RFC 2831. + /** DIGEST-MD5 authentication RFC 2831.*/ MCOAuthTypeSASLDIGESTMD5 = 1 << 3, - // LOGIN authentication http://tools.ietf.org/id/draft-murchison-sasl-login-00.txt + /** LOGIN authentication http://tools.ietf.org/id/draft-murchison-sasl-login-00.txt*/ MCOAuthTypeSASLLogin = 1 << 4, - // Secure Remote Password Authentication http://tools.ietf.org/html/draft-burdis-cat-srp-sasl-08 + /** Secure Remote Password Authentication http://tools.ietf.org/html/draft-burdis-cat-srp-sasl-08*/ MCOAuthTypeSASLSRP = 1 << 5, - // NTLM authentication. + /** NTLM authentication.*/ MCOAuthTypeSASLNTLM = 1 << 6, - // Kerberos 4 authentication. + /** Kerberos 4 authentication.*/ MCOAuthTypeSASLKerberosV4 = 1 << 7, } MCOAuthType; -// It's the IMAP flags of the folder. +/** It's the IMAP flags of the folder.*/ typedef enum { MCOIMAPFolderFlagNone = 0, - // \Marked + /** \Marked*/ MCOIMAPFolderFlagMarked = 1 << 0, - // \Unmarked + /** \Unmarked*/ MCOIMAPFolderFlagUnmarked = 1 << 1, - // \NoSelect: When a folder can't be selected. + /** \NoSelect: When a folder can't be selected.*/ MCOIMAPFolderFlagNoSelect = 1 << 2, - // \NoInferiors: When the folder has no children. + /** \NoInferiors: When the folder has no children.*/ MCOIMAPFolderFlagNoInferiors = 1 << 3, - // \Inbox: When the folder is the inbox. + /** \Inbox: When the folder is the inbox.*/ MCOIMAPFolderFlagInbox = 1 << 4, - // \Sent: When the folder is the sent folder. + /** \Sent: When the folder is the sent folder.*/ MCOIMAPFolderFlagSentMail = 1 << 5, - // \Starred: When the folder is the starred folder + /** \Starred: When the folder is the starred folder*/ MCOIMAPFolderFlagStarred = 1 << 6, - // \AllMail: When the folder is all mail. + /** \AllMail: When the folder is all mail.*/ MCOIMAPFolderFlagAllMail = 1 << 7, - // \Trash: When the folder is the trash. + /** \Trash: When the folder is the trash.*/ MCOIMAPFolderFlagTrash = 1 << 8, - // \Drafts: When the folder is the drafts folder. + /** \Drafts: When the folder is the drafts folder.*/ MCOIMAPFolderFlagDrafts = 1 << 9, - // \Spam: When the folder is the spam folder. + /** \Spam: When the folder is the spam folder.*/ MCOIMAPFolderFlagSpam = 1 << 10, - // \Important: When the folder is the important folder. + /** \Important: When the folder is the important folder.*/ MCOIMAPFolderFlagImportant = 1 << 11, - // \Archive: When the folder is archive. + /** \Archive: When the folder is archive.*/ MCOIMAPFolderFlagArchive = 1 << 12, - // \All: When the folder contains all mails, similar to \AllMail. + /** \All: When the folder contains all mails, similar to \AllMail.*/ MCOIMAPFolderFlagAll = MCOIMAPFolderFlagAllMail, - // \Junk: When the folder is the spam folder. + /** \Junk: When the folder is the spam folder.*/ MCOIMAPFolderFlagJunk = MCOIMAPFolderFlagSpam, - // \Flagged: When the folder contains all the flagged emails. + /** \Flagged: When the folder contains all the flagged emails.*/ MCOIMAPFolderFlagFlagged = MCOIMAPFolderFlagStarred, } MCOIMAPFolderFlag; -// It's the flags of a message. +/** It's the flags of a message.*/ typedef enum { MCOMessageFlagNone = 0, - // Seen/Read flag. + /** Seen/Read flag.*/ MCOMessageFlagSeen = 1 << 0, - // Replied/Answered flag. + /** Replied/Answered flag.*/ MCOMessageFlagAnswered = 1 << 1, - // Flagged/Starred flag. + /** Flagged/Starred flag.*/ MCOMessageFlagFlagged = 1 << 2, - // Deleted flag. + /** Deleted flag.*/ MCOMessageFlagDeleted = 1 << 3, - // Draft flag. + /** Draft flag.*/ MCOMessageFlagDraft = 1 << 4, - // $MDNSent flag. + /** $MDNSent flag.*/ MCOMessageFlagMDNSent = 1 << 5, - // $Forwarded flag. + /** $Forwarded flag.*/ MCOMessageFlagForwarded = 1 << 6, - // $SubmitPending flag. + /** $SubmitPending flag.*/ MCOMessageFlagSubmitPending = 1 << 7, - // $Submitted flag. + /** $Submitted flag.*/ MCOMessageFlagSubmitted = 1 << 8, } MCOMessageFlag; -// It's the encoding of a part. +/** It's the encoding of a part.*/ typedef enum { - // 7bit encoding. - MCOEncoding7Bit = 0, // should match MAILIMAP_BODY_FLD_ENC_7BIT - // 8bit encoding. - MCOEncoding8Bit = 1, // should match MAILIMAP_BODY_FLD_ENC_8BIT - // binary encoding. - MCOEncodingBinary = 2, // should match MAILIMAP_BODY_FLD_ENC_BINARY - // base64 encoding. - MCOEncodingBase64 = 3, // should match MAILIMAP_BODY_FLD_ENC_BASE64 - // quoted-printable encoding. - MCOEncodingQuotedPrintable = 4, // should match MAILIMAP_BODY_FLD_ENC_QUOTED_PRINTABLE - // other encoding. - MCOEncodingOther = 5, // should match MAILIMAP_BODY_FLD_ENC_OTHER + /** 7bit encoding.*/ + MCOEncoding7Bit = 0, /** should match MAILIMAP_BODY_FLD_ENC_7BIT*/ + /** 8bit encoding.*/ + MCOEncoding8Bit = 1, /** should match MAILIMAP_BODY_FLD_ENC_8BIT*/ + /** binary encoding.*/ + MCOEncodingBinary = 2, /** should match MAILIMAP_BODY_FLD_ENC_BINARY*/ + /** base64 encoding.*/ + MCOEncodingBase64 = 3, /** should match MAILIMAP_BODY_FLD_ENC_BASE64*/ + /** quoted-printable encoding.*/ + MCOEncodingQuotedPrintable = 4, /** should match MAILIMAP_BODY_FLD_ENC_QUOTED_PRINTABLE*/ + /** other encoding.*/ + MCOEncodingOther = 5, /** should match MAILIMAP_BODY_FLD_ENC_OTHER*/ - // Negative values should be used for encoding not supported by libetpan. + /** Negative values should be used for encoding not supported by libetpan.*/ - // UUEncode encoding. + /** UUEncode encoding.*/ MCOEncodingUUEncode = -1 } MCOEncoding; -// It's the information to fetch for a given message in the IMAP FETCH request. +/** It's the information to fetch for a given message in the IMAP FETCH request.*/ typedef enum { - // UID of the message. - MCOIMAPMessagesRequestKindUid = 0, // This is the default and it's always fetched - // Flags of the message. + /** UID of the message.*/ + MCOIMAPMessagesRequestKindUid = 0, /** This is the default and it's always fetched*/ + /** Flags of the message.*/ MCOIMAPMessagesRequestKindFlags = 1 << 0, - // Headers of the message (parsed by the server). + /** Headers of the message (parsed by the server).*/ MCOIMAPMessagesRequestKindHeaders = 1 << 1, - // MIME structure of the message. + /** MIME structure of the message.*/ MCOIMAPMessagesRequestKindStructure = 1 << 2, - // Received date. + /** Received date.*/ MCOIMAPMessagesRequestKindInternalDate = 1 << 3, - // Headers through headers data. + /** Headers through headers data.*/ MCOIMAPMessagesRequestKindFullHeaders = 1 << 4, - // Subject of the message. + /** Subject of the message.*/ MCOIMAPMessagesRequestKindHeaderSubject = 1 << 5, - // Gmail Labels. + /** Gmail Labels.*/ MCOIMAPMessagesRequestKindGmailLabels = 1 << 6, } MCOIMAPMessagesRequestKind; -// It defines the behavior of the STORE flags request. +/** It defines the behavior of the STORE flags request.*/ typedef enum { - // Add the given flags. + /** Add the given flags.*/ MCOIMAPStoreFlagsRequestKindAdd, - // Remove the given flags. + /** Remove the given flags.*/ MCOIMAPStoreFlagsRequestKindRemove, - // Set the given flags. + /** Set the given flags.*/ MCOIMAPStoreFlagsRequestKindSet, } MCOIMAPStoreFlagsRequestKind; -// It's the search type. +/** It's the search type.*/ typedef enum { - // No search. + /** No search.*/ MCOIMAPSearchKindNone, - // Match sender. + /** Match sender.*/ MCOIMAPSearchKindFrom, - // Match recipient. + /** Match recipient.*/ MCOIMAPSearchKindRecipient, - // Match subject. + /** Match subject.*/ MCOIMAPSearchKindSubject, - // Match content of the message. + /** Match content of the message.*/ MCOIMAPSearchKindContent, - // Match headers of the message. + /** Match headers of the message.*/ MCOIMAPSearchKindHeader, - // Or expresssion. + /** Or expresssion.*/ MCOIMAPSearchKindOr, - // And expression. + /** And expression.*/ MCOIMAPSearchKindAnd, } MCOIMAPSearchKind; -// Keys for the namespace dictionary. +/** Keys for the namespace dictionary.*/ #define MCOIMAPNamespacePersonal @"IMAPNamespacePersonal"; #define MCOIMAPNamespaceOther @"IMAPNamespaceOther"; #define MCOIMAPNamespaceShared @"IMAPNamespaceShared"; -// This is the constants for the IMAP capabilities. -// See corresponding RFC for more information. +/** This is the constants for the IMAP capabilities.*/ +/** See corresponding RFC for more information.*/ typedef enum { - // ACL Capability. + /** ACL Capability.*/ MCOIMAPCapabilityACL, - // BINARY Capability. + /** BINARY Capability.*/ MCOIMAPCapabilityBinary, - // CATENATE Capability. + /** CATENATE Capability.*/ MCOIMAPCapabilityCatenate, - // CHILDREN Capability. + /** CHILDREN Capability.*/ MCOIMAPCapabilityChildren, - // COMPRESS Capability. + /** COMPRESS Capability.*/ MCOIMAPCapabilityCompressDeflate, - // CONDSTORE Capability. + /** CONDSTORE Capability.*/ MCOIMAPCapabilityCondstore, - // ENABLE Capability. + /** ENABLE Capability.*/ MCOIMAPCapabilityEnable, - // IDLE Capability. + /** IDLE Capability.*/ MCOIMAPCapabilityIdle, - // ID Capability. + /** ID Capability.*/ MCOIMAPCapabilityId, - // LITERAL+ Capability. + /** LITERAL+ Capability.*/ MCOIMAPCapabilityLiteralPlus, - // MULTIAPPEND Capability. + /** MULTIAPPEND Capability.*/ MCOIMAPCapabilityMultiAppend, - // NAMESPACE Capability. + /** NAMESPACE Capability.*/ MCOIMAPCapabilityNamespace, - // QRESYNC Capability. + /** QRESYNC Capability.*/ MCOIMAPCapabilityQResync, - // QUOTE Capability. + /** QUOTE Capability.*/ MCOIMAPCapabilityQuota, - // SORT Capability. + /** SORT Capability.*/ MCOIMAPCapabilitySort, - // STARTTLS Capability. + /** STARTTLS Capability.*/ MCOIMAPCapabilityStartTLS, - // THREAD=ORDEREDSUBJECT Capability. + /** THREAD=ORDEREDSUBJECT Capability.*/ MCOIMAPCapabilityThreadOrderedSubject, - // THREAD=REFERENCES Capability. + /** THREAD=REFERENCES Capability.*/ MCOIMAPCapabilityThreadReferences, - // UIDPLUS Capability. + /** UIDPLUS Capability.*/ MCOIMAPCapabilityUIDPlus, - // UNSELECT Capability. + /** UNSELECT Capability.*/ MCOIMAPCapabilityUnselect, - // XLIST Capability. + /** XLIST Capability.*/ MCOIMAPCapabilityXList, - // AUTH=ANONYMOUS Capability. + /** AUTH=ANONYMOUS Capability.*/ MCOIMAPCapabilityAuthAnonymous, - // AUTH=CRAM-MD5 Capability. + /** AUTH=CRAM-MD5 Capability.*/ MCOIMAPCapabilityAuthCRAMMD5, - // AUTH=DIGEST-MD5 Capability. + /** AUTH=DIGEST-MD5 Capability.*/ MCOIMAPCapabilityAuthDigestMD5, - // AUTH=EXTERNAL Capability. + /** AUTH=EXTERNAL Capability.*/ MCOIMAPCapabilityAuthExternal, - // AUTH=GSSAPI Capability. + /** AUTH=GSSAPI Capability.*/ MCOIMAPCapabilityAuthGSSAPI, - // AUTH=KERBEROSV4 Capability. + /** AUTH=KERBEROSV4 Capability.*/ MCOIMAPCapabilityAuthKerberosV4, - // AUTH=LOGIN Capability. + /** AUTH=LOGIN Capability.*/ MCOIMAPCapabilityAuthLogin, - // AUTH=NTML Capability. + /** AUTH=NTML Capability.*/ MCOIMAPCapabilityAuthNTLM, - // AUTH=OTP Capability. + /** AUTH=OTP Capability.*/ MCOIMAPCapabilityAuthOTP, - // AUTH=PLAIN Capability. + /** AUTH=PLAIN Capability.*/ MCOIMAPCapabilityAuthPlain, - // AUTH=SKEY Capability. + /** AUTH=SKEY Capability.*/ MCOIMAPCapabilityAuthSKey, - // AUTH=SRP Capability. + /** AUTH=SRP Capability.*/ MCOIMAPCapabilityAuthSRP, } MCOIMAPCapability; -// Error domain for mailcore. +/** Error domain for mailcore.*/ #define MCOErrorDomain @"MCOErrorDomain" -// Here's the list of errors. +/** Here's the list of errors.*/ typedef enum { - // No error occurred. + /** No error occurred.*/ MCOErrorNone, - // An error related to the connection occurred. - // It could not connect or it's been disconnected. + /** An error related to the connection occurred.*/ + /** It could not connect or it's been disconnected.*/ MCOErrorConnection, - // TLS/SSL connection was not available. + /** TLS/SSL connection was not available.*/ MCOErrorTLSNotAvailable, - // The protocol could not be parsed. + /** The protocol could not be parsed.*/ MCOErrorParse, - // Certificate was not valid. + /** Certificate was not valid.*/ MCOErrorCertificate, - // An authentication error occurred. + /** An authentication error occurred.*/ MCOErrorAuthentication, - // Specific to Gmail: IMAP not enabled. + /** Specific to Gmail: IMAP not enabled.*/ MCOErrorGmailIMAPNotEnabled, - // Specific to Gmail: Exceeded bandwidth limit. + /** Specific to Gmail: Exceeded bandwidth limit.*/ MCOErrorGmailExceededBandwidthLimit, - // Specific to Gmail: Too many simultaneous connections. + /** Specific to Gmail: Too many simultaneous connections.*/ MCOErrorGmailTooManySimultaneousConnections, - // Specific to Mobile Me: Moved to iCloud. + /** Specific to Mobile Me: Moved to iCloud.*/ MCOErrorMobileMeMoved, - // Specific to Yahoo: not available. + /** Specific to Yahoo: not available.*/ MCOErrorYahooUnavailable, - // Non existant folder, select failed. + /** Non existant folder, select failed.*/ MCOErrorNonExistantFolder, - // IMAP: Error occurred while renaming a folder. + /** IMAP: Error occurred while renaming a folder.*/ MCOErrorRename, - // IMAP: Error occurred while deleting a folder. + /** IMAP: Error occurred while deleting a folder.*/ MCOErrorDelete, - // IMAP: Error occurred while creating a folder. + /** IMAP: Error occurred while creating a folder.*/ MCOErrorCreate, - // IMAP: Error occurred while subscribing/unsubcribing to a folder. + /** IMAP: Error occurred while subscribing/unsubcribing to a folder.*/ MCOErrorSubscribe, - // IMAP: Error occurred while adding a message to a folder. + /** IMAP: Error occurred while adding a message to a folder.*/ MCOErrorAppend, - // IMAP: Error occurred while copying a message. + /** IMAP: Error occurred while copying a message.*/ MCOErrorCopy, - // IMAP: Error occurred while expunging. + /** IMAP: Error occurred while expunging.*/ MCOErrorExpunge, - // IMAP: Error occurred while fetching messages. + /** IMAP: Error occurred while fetching messages.*/ MCOErrorFetch, - // IMAP: Error occurred while IDLing. + /** IMAP: Error occurred while IDLing.*/ MCOErrorIdle, - // IMAP: Error occurred while sending/getting identity. + /** IMAP: Error occurred while sending/getting identity.*/ MCOErrorIdentity, - // IMAP: Error occurred while getting namespace. + /** IMAP: Error occurred while getting namespace.*/ MCOErrorNamespace, - // IMAP: Error occurred while storing flags. + /** IMAP: Error occurred while storing flags.*/ MCOErrorStore, - // IMAP: Error wile getting capabilities. + /** IMAP: Error wile getting capabilities.*/ MCOErrorCapability, - // STARTTLS is not available. + /** STARTTLS is not available.*/ MCOErrorStartTLSNotAvailable, - // SMTP: Illegal attachment: certain kind of attachment cannot be sent. + /** SMTP: Illegal attachment: certain kind of attachment cannot be sent.*/ MCOErrorSendMessageIllegalAttachment, - // SMTP: Storage limit: message is probably too big. + /** SMTP: Storage limit: message is probably too big.*/ MCOErrorStorageLimit, - // SMTP: Sending message is not allowed. + /** SMTP: Sending message is not allowed.*/ MCOErrorSendMessageNotAllowed, - // SMTP: Specific to hotmail. Needs to connect to webmail. + /** SMTP: Specific to hotmail. Needs to connect to webmail.*/ MCOErrorNeedsConnectToWebmail, - // SMTP: Error while sending message. + /** SMTP: Error while sending message.*/ MCOErrorSendMessage, - // SMTP: Authentication required. + /** SMTP: Authentication required.*/ MCOErrorAuthenticationRequired, - // POP: Error occurred while fetching message list. + /** POP: Error occurred while fetching message list.*/ MCOErrorFetchMessageList, - // POP: Error occurred while deleting message. + /** POP: Error occurred while deleting message.*/ MCOErrorDeleteMessage, - // SMTP: Error while checking account. + /** SMTP: Error while checking account.*/ MCOErrorInvalidAccount, } MCOErrorCode; |