![]() |
![]() |
![]() |
Reference Manual of the tinymail framework | ![]() |
---|---|---|---|---|
enum TnyStatusCode; enum TnyStatusDomain; enum TnyFolderCaps; enum TnyFolderChangeChanged; enum TnyFolderStoreChangeChanged; enum TnyErrorDomain; enum TnyError; enum TnyAccountType; enum TnyAccountSignal; enum TnyConnectionStatus; enum TnyAccountStoreSignal; enum TnyAlertType; enum TnyGetAccountsRequestType; enum TnyDeviceSignal; enum TnyFolderSignal; enum TnyFolderStoreQueryOption; enum TnyHeaderFlags; enum TnyHeaderPriorityFlags; enum TnyFolderType; enum TnySendQueueSignal; enum TnyStoreAccountSignal;
typedef enum { TNY_FOLDER_STATUS_CODE_REFRESH = 1, TNY_FOLDER_STATUS_CODE_GET_MSG = 2, TNY_GET_MSG_QUEUE_STATUS_GET_MSG = 3, TNY_FOLDER_STATUS_CODE_XFER_MSGS = 4, TNY_FOLDER_STATUS_CODE_COPY_FOLDER = 5, TNY_GET_SUPPORTED_SECURE_AUTH_STATUS_GET_SECURE_AUTH = 6, TNY_FOLDER_STATUS_CODE_SYNC = 7, } TnyStatusCode;
a status that occurs while a folder is being refreshed | |
a status that occurs while a message is being downloaded | |
typedef enum { TNY_FOLDER_STATUS = 1, TNY_GET_MSG_QUEUE_STATUS = 2, TNY_GET_SUPPORTED_SECURE_AUTH_STATUS = 3 } TnyStatusDomain;
typedef enum { TNY_FOLDER_CAPS_WRITABLE = 1<<0, TNY_FOLDER_CAPS_PUSHEMAIL = 1<<1 } TnyFolderCaps;
typedef enum { TNY_FOLDER_CHANGE_CHANGED_ALL_COUNT = 1<<0, TNY_FOLDER_CHANGE_CHANGED_UNREAD_COUNT = 1<<1, TNY_FOLDER_CHANGE_CHANGED_ADDED_HEADERS = 1<<2, TNY_FOLDER_CHANGE_CHANGED_EXPUNGED_HEADERS = 1<<3, TNY_FOLDER_CHANGE_CHANGED_FOLDER_RENAME = 1<<4, TNY_FOLDER_CHANGE_CHANGED_MSG_RECEIVED = 1<<5, } TnyFolderChangeChanged;
indicates that the total count of the folder got changed | |
indicates that the unread count of the folder got changed | |
indicates that a summary item or header got added (that a message got added, this is a typical Push E-mail event) | |
indicates that the folder got renamed | |
typedef enum { TNY_FOLDER_STORE_CHANGE_CHANGED_CREATED_FOLDERS = 1<<0, TNY_FOLDER_STORE_CHANGE_CHANGED_REMOVED_FOLDERS = 1<<1 } TnyFolderStoreChangeChanged;
typedef enum { TNY_FOLDER_ERROR = 1, TNY_FOLDER_STORE_ERROR = 2, TNY_TRANSPORT_ACCOUNT_ERROR = 3, TNY_ACCOUNT_ERROR = 4, TNY_ACCOUNT_STORE_ERROR = 5, TNY_SEND_QUEUE_ERROR = 6 } TnyErrorDomain;
An error domain for errors that occured with a folder | |
An error domain for errors that occured with a folder store | |
An error domain for errors that occured with a transport account | |
An error domain for errors that occured with a account | |
typedef enum { TNY_ERROR_UNSPEC = 1, TNY_FOLDER_ERROR_SYNC = 2, TNY_FOLDER_ERROR_REMOVE_MSG = 3, TNY_FOLDER_ERROR_ADD_MSG = 4, TNY_FOLDER_ERROR_REFRESH = 5, TNY_FOLDER_ERROR_GET_MSG = 6, TNY_FOLDER_ERROR_TRANSFER_MSGS = 7, TNY_FOLDER_ERROR_SET_NAME = 8, TNY_FOLDER_ERROR_COPY = 9, TNY_FOLDER_STORE_ERROR_REMOVE_FOLDER = 10, TNY_FOLDER_STORE_ERROR_GET_FOLDERS = 11, TNY_FOLDER_STORE_ERROR_CREATE_FOLDER = 12, TNY_TRANSPORT_ACCOUNT_ERROR_SEND = 13, TNY_TRANSPORT_ACCOUNT_ERROR_SEND_HOST_LOOKUP_FAILED = 23, TNY_TRANSPORT_ACCOUNT_ERROR_SEND_SERVICE_UNAVAILABLE = 24, TNY_TRANSPORT_ACCOUNT_ERROR_SEND_AUTHENTICATION_NOT_SUPPORTED = 25, TNY_TRANSPORT_ACCOUNT_ERROR_SEND_USER_CANCEL = 26, TNY_ACCOUNT_ERROR_TRY_CONNECT = 14, TNY_ACCOUNT_ERROR_TRY_CONNECT_HOST_LOOKUP_FAILED = 19, TNY_ACCOUNT_ERROR_TRY_CONNECT_SERVICE_UNAVAILABLE = 20, TNY_ACCOUNT_ERROR_TRY_CONNECT_AUTHENTICATION_NOT_SUPPORTED = 21, TNY_ACCOUNT_ERROR_TRY_CONNECT_CERTIFICATE = 22, TNY_ACCOUNT_ERROR_TRY_CONNECT_USER_CANCEL = 27, TNY_ACCOUNT_STORE_ERROR_UNKNOWN_ALERT = 15, TNY_ACCOUNT_ERROR_GET_SUPPORTED_AUTH = 16, TNY_SEND_QUEUE_ERROR_ADD = 17, TNY_ACCOUNT_STORE_ERROR_CANCEL_ALERT = 18, TNY_FOLDER_ERROR_REMOVE_MSGS = 19, } TnyError;
A GError error code.
typedef enum { TNY_ACCOUNT_TYPE_STORE, TNY_ACCOUNT_TYPE_TRANSPORT, TNY_ACCOUNT_TYPE_COMBINED } TnyAccountType;
typedef enum { TNY_ACCOUNT_CONNECTION_STATUS_CHANGED, TNY_ACCOUNT_LAST_SIGNAL } TnyAccountSignal;
typedef enum { TNY_CONNECTION_STATUS_DISCONNECTED, TNY_CONNECTION_STATUS_DISCONNECTED_BROKEN, TNY_CONNECTION_STATUS_CONNECTED_BROKEN, TNY_CONNECTION_STATUS_CONNECTED, TNY_CONNECTION_STATUS_RECONNECTING, TNY_CONNECTION_STATUS_INIT } TnyConnectionStatus;
typedef enum { TNY_ACCOUNT_STORE_ACCOUNT_CHANGED, TNY_ACCOUNT_STORE_ACCOUNT_INSERTED, TNY_ACCOUNT_STORE_ACCOUNT_REMOVED, TNY_ACCOUNT_STORE_ACCOUNTS_RELOADED, TNY_ACCOUNT_STORE_CONNECTING_STARTED, TNY_ACCOUNT_STORE_CONNECTING_FINISHED, TNY_ACCOUNT_STORE_LAST_SIGNAL } TnyAccountStoreSignal;
An account has been changed | |
An account was inserted | |
An account was removed | |
The accounts got reloaded | |
Number of signals |
typedef enum { TNY_ALERT_TYPE_INFO, TNY_ALERT_TYPE_WARNING, TNY_ALERT_TYPE_ERROR } TnyAlertType;
typedef enum { TNY_ACCOUNT_STORE_TRANSPORT_ACCOUNTS, TNY_ACCOUNT_STORE_STORE_ACCOUNTS, TNY_ACCOUNT_STORE_BOTH } TnyGetAccountsRequestType;
typedef enum { TNY_DEVICE_CONNECTION_CHANGED, TNY_DEVICE_LAST_SIGNAL } TnyDeviceSignal;
typedef enum { TNY_FOLDER_FOLDER_INSERTED, TNY_FOLDER_FOLDERS_RELOADED, TNY_FOLDER_LAST_SIGNAL } TnyFolderSignal;
typedef enum { TNY_FOLDER_STORE_QUERY_OPTION_SUBSCRIBED = 1<<0 TNY_FOLDER_STORE_QUERY_OPTION_UNSUBSCRIBED = 1<<1, TNY_FOLDER_STORE_QUERY_OPTION_MATCH_ON_NAME = 1<<2, TNY_FOLDER_STORE_QUERY_OPTION_MATCH_ON_ID = 1<<3 } TnyFolderStoreQueryOption;
Only subscribed folders will match this query | |
Only folders that will match the pattern on folder name will match this query | |
Only folders that wil match the pattern on folder id will match this query |
typedef enum { TNY_HEADER_FLAG_ANSWERED = 1<<0, TNY_HEADER_FLAG_DELETED = 1<<1, TNY_HEADER_FLAG_DRAFT = 1<<2, TNY_HEADER_FLAG_FLAGGED = 1<<3, TNY_HEADER_FLAG_SEEN = 1<<4, TNY_HEADER_FLAG_ATTACHMENTS = 1<<5, TNY_HEADER_FLAG_CACHED = 1<<6, TNY_HEADER_FLAG_PARTIAL = 1<<7, TNY_HEADER_FLAG_EXPUNGED = 1<<8, TNY_HEADER_FLAG_PRIORITY = 1<<9|1<<10 } TnyHeaderFlags;
When defining new flags, please stay below 1<<12. Starting 1<<12 is being used internally (and you would overwrite that, which can cause severe defects like crashes and memory leaks). You are rather advised not to add any new flags unless there is really no other way to achieve what you are trying to do (and then still, consider talking to the tinymail framework developers about simply getting your "special" cool flag added to tinymail itself).
The messages was answered | |
The messages is deleted, launching the expunge will wipe it | |
The message is a draft | |
The message is flagged | |
The message is seen | |
The message has attachments | |
The message is cached | |
The message is retrieved partially | |
The message got expunged and therefore is the header instance invalid | |
Priority information is available, use the TnyHeaderPriorityFlags type as mask |
typedef enum { TNY_HEADER_FLAG_HIGH_PRIORITY = 1<<9|1<<10, TNY_HEADER_FLAG_NORMAL_PRIORITY = 0<<9|0<<10, TNY_HEADER_FLAG_LOW_PRIORITY = 0<<9|1<<10, TNY_HEADER_FLAG_SUSPENDED_PRIORITY = 1<<9|0<<10 } TnyHeaderPriorityFlags;
typedef enum { TNY_FOLDER_TYPE_UNKNOWN, TNY_FOLDER_TYPE_NORMAL, TNY_FOLDER_TYPE_INBOX, TNY_FOLDER_TYPE_OUTBOX, TNY_FOLDER_TYPE_TRASH, TNY_FOLDER_TYPE_JUNK, TNY_FOLDER_TYPE_SENT, TNY_FOLDER_TYPE_ROOT, TNY_FOLDER_TYPE_NOTES, TNY_FOLDER_TYPE_DRAFTS, TNY_FOLDER_TYPE_CONTACTS, TNY_FOLDER_TYPE_CALENDAR, TNY_FOLDER_TYPE_ARCHIVE, TNY_FOLDER_TYPE_MERGE, TNY_FOLDER_TYPE_NUM } TnyFolderType;
The type is unknown | |
The folder type is a normal folder | |
The folder type is a INBOX folder | |
The folder type is an OUTBOX folder | |
The folder type is a TRASH folder | |
The folder type is a JUNK folder | |
The folder type is a SENT folder | |
The folder type is a TnyAccount that contains this folder (used for the TnyGtkAccountTreeModel) | |
typedef enum { TNY_SEND_QUEUE_MSG_SENDING, TNY_SEND_QUEUE_MSG_SENT, TNY_SEND_QUEUE_ERROR_HAPPENED, TNY_SEND_QUEUE_LAST_SIGNAL } TnySendQueueSignal;