GMail Control
Properties Methods Events Configuration Settings Errors
The GMail component provides an easy to use interface to Gmail.
Syntax
GMail
Remarks
GMail provides a simple way to access and manage mail in Gmail.
The control connects to the Gmail server using IMAP and also supports Gmail specific IMAP extensions such as thread ids and labels.
To begin you may authenticate either by specifying User and Password, or by providing an OAuth authorization string in Authorization and setting AuthMechanism to amSASLXOAuth2. Call the Connect method to connect.
After connecting set the Mailbox property and call SelectMailbox to select a mailbox to examine. To retrieve information about the messages in the mailbox set MessageSet and call FetchMessageInfo. To download a message call FetchMessageText.
Many other operations are supported by the control including managing flags, moving and copying messages, working with Gmail labels, and more. Review the methods listed in this help file for more information on supported operations.
Property List
The following is the full list of the properties of the control with short descriptions. Click on the links for further details.
AuthMechanism | The authentication mechanism to be used when connecting to the mail server. |
Authorization | OAuth 2.0 Authorization Token. |
AutoDecodeParts | Determines whether to automatically decode message parts. |
Command | Can be used to send additional commands directly to the server. |
Connected | Shows whether the component is connected. |
EndByte | The byte index of the position where the transfer should end. |
FirewallAutoDetect | This property tells the component whether or not to automatically detect and use firewall system settings, if available. |
FirewallType | This property determines the type of firewall to connect through. |
FirewallHost | This property contains the name or IP address of firewall (optional). |
FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
FirewallPort | This property contains the TCP port for the firewall Host . |
FirewallUser | This property contains a user name if authentication is to be used connecting through a firewall. |
LastReply | The last reply from the server. |
LocalFile | The path to a local file for downloading the message body. If the file exists, it is overwritten (optional). |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
Mailbox | Name of the mailbox selected on the server. |
MailboxFlags | Defines flags in the selected mailbox. |
MailboxListCount | The number of records in the MailboxList arrays. |
MailboxListFlags | The mailbox flags in a mailbox listing. |
MailboxListName | The mailbox name in a mailbox listing. |
MailboxListSeparator | The Separator property contains the character that separates the different parts in the mailbox path hierarchy. |
MailPort | The port of the IMAP server (default is 143). |
MailServer | The name or address of the mail server (IMAP server). |
Message | Provides the raw message content. |
MessageContentEncoding | The ContentEncoding of the selected message. |
MessageContentType | The ContentType of the message. |
MessageCount | The total number of messages on the Mailbox . |
MessageDate | The time the message was created. |
MessageDeliveryTime | The time the message was delivered to the mail server. |
MessageFlags | Contains the flags of the current message. |
MessageFrom | The address of the author of the message. |
MessageGmailId | The unique Gmail Id of the message. |
MessageHeaderCount | The number of records in the MessageHeader arrays. |
MessageHeaderField | This property contains the name of the HTTP header (same case as it is delivered). |
MessageHeaderValue | This property contains the header contents. |
MessageHeadersString | String version of RFC822-encoded headers of the message. |
MessageId | The message identifier of the current message. |
MessageInfoCount | The number of records in the MessageInfo arrays. |
MessageInfoDate | The date of a message in a message info listing. |
MessageInfoFlags | Message flag in a message info listing. |
MessageInfoFrom | The sender of a message in a message info listing. |
MessageInfoGmailId | This property holds the Gmail assigned unique Id of the message. |
MessageInfoLabels | This property holds a space separated list of Gmail labels associated with the message. |
MessageInfoMessageId | The unique identifier of a message in a message info listing. |
MessageInfoSize | The size of a message in a message info listing. |
MessageInfoSubject | The subject of a message in a message info listing. |
MessageInfoThreadId | This property holds the thread Id of the current message. |
MessageInReplyTo | The unique message identifier of the message this one is in reply to. |
MessageLabels | A space separated list of labels. |
MessageNetId | The globally unique identifier of the message. |
MessagePartCount | The number of records in the MessagePart arrays. |
MessagePartContentDisposition | This property shows the value of the Content-Disposition header of the message part. |
MessagePartContentEncoding | This property shows how the data is encoded. |
MessagePartContentId | This property shows the value of the Content-Id header of the message part. |
MessagePartContentType | This property shows the type of data contained in the message part. |
MessagePartFilename | This property shows the filename corresponding to the part (if the part was included in the message as an attached file). |
MessagePartId | This property contains the identifier of a part listing which may be identified in other parts or messages. |
MessagePartMultipartMode | This property shows how this part relates to the message's whole multipart structure ('mixed', 'alternative', etc. |
MessagePartParameters | This property contains the additional parameters passed to the ContentType header such as the part charset etc. |
MessagePartSize | This property contains the size of a part in a message part listing. |
MessageRecipientCount | The number of records in the MessageRecipient arrays. |
MessageRecipientAddress | This property contains the email address of the recipient. |
MessageRecipientName | This property contains name of the recipient. |
MessageRecipientOptions | This property contains the recipient sending options (used only by SMTP). |
MessageRecipientType | This property contains the recipient type: To, Cc, or BCc. |
MessageReplyTo | Email address(s) where replies to the message should be sent. |
MessageSender | The address of the sender of the message. |
MessageSet | The set of messages to operate on. |
MessageSize | The size of the selected message. |
MessageSubject | The subject of the message. |
MessageText | The body of the retrieved message. |
MessageThreadId | The thread Id of the current message. |
Overwrite | Indicates whether or not the component should overwrite files during transfer. |
Password | The password used to authenticate to the MailServer . |
PeekMode | When set to True, the message Seen flag is not changed during reading. |
RecentMessageCount | Number of new messages in the Mailbox . |
SearchCriteriaId | The Gmail assigned id of the message. |
SearchCriteriaLabels | A space separated list of labels to use when searching. |
SearchCriteriaString | The Gmail search string. |
SearchCriteriaThreadId | The thread Id to search for. |
SortCriteria | Sorts criteria to use for message retrieval operations. |
SSLAcceptServerCertEncoded | The certificate (PEM/base64 encoded). |
SSLCertEncoded | The certificate (PEM/base64 encoded). |
SSLCertStore | The name of the certificate store for the client certificate. |
SSLCertStorePassword | If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
SSLCertStoreType | The type of certificate store for this certificate. |
SSLCertSubject | The subject of the certificate used for client authentication. |
SSLServerCertEncoded | The certificate (PEM/base64 encoded). |
SSLStartMode | Determines how the component starts the SSL negotiation. |
StartByte | The byte index of the position where the transfer should start. |
Timeout | A timeout for the component. |
UIDMode | If true, permanent message identifiers are used instead of the default temporary identifiers. |
UIDValidity | The UIDValidity parameter sent from the server in response to SelectMailbox command. |
User | The user name used to authenticate to the MailServer . |
Method List
The following is the full list of the methods of the control with short descriptions. Click on the links for further details.
AddMessageFlags | Adds the specified flags to the messages specified by MessageSet . |
AddMessageLabels | Adds the specified labels to the message specified by MessageSet. |
AppendToMailbox | Appends the message in MessageText to the mailbox specified by Mailbox . |
CheckMailbox | Sends a 'CHECK' command to the server. |
CloseMailbox | Removes all messages marked with 'Deleted' flag from the currently selected mailbox and unselect mailbox. |
Config | Sets or retrieves a configuration setting . |
Connect | Connects to an IMAP server. |
CopyToMailbox | Copies the messages specified by MessageSet to the mailbox specified by Mailbox . |
CreateMailbox | Creates a new mailbox specified by Mailbox . |
DeleteFromMailbox | Marks the messages specified by MessageSet as deleted. |
DeleteMailbox | Deletes a mailbox specified by Mailbox . |
DeleteMailboxACL | Deletes mailbox access control rights for a specific user. |
Disconnect | Disconnects from an IMAP server. |
DoEvents | Processes events from the internal message queue. |
ExamineMailbox | Selects a Mailbox (Read-only mode). |
ExpungeMailbox | Removes all messages marked with 'Deleted' flag from the currently selected mailbox. |
FetchMessageHeaders | Retrieves the message headers of messages specified by the MessageSet property. |
FetchMessageInfo | Retrieves information about messages specified by the MessageSet property. |
FetchMessagePart | Retrieves the message part specified by PartID. |
FetchMessagePartHeaders | Retrieves the headers of message part specified by PartID. |
FetchMessageText | Retrieves the message text of messages specified by the MessageSet property. |
GetMailboxACL | Retrieves mailbox access control rights. |
Interrupt | Interrupt the current method. |
ListMailboxes | Lists all mailboxes matching all criteria in the Mailbox property. |
ListSubscribedMailboxes | Lists all subscribed mailboxes matching all criteria in the Mailbox property. |
LocalizeDate | Converts a valid RFC 822 message date to local date and time. |
MoveToMailbox | Moves the messages specified by MessageSet to the mailbox specified by Mailbox . |
Noop | Sends a 'NOOP' command to the server. |
RenameMailbox | Change the name of Mailbox to NewName . |
ResetMessageFlags | Replaces the flags of the messages specified by MessageSet with the flags specified by MessageFlags . |
ResetMessageLabels | Replaces the labels of the message specified by MessageSet with the labels specified by MessageLabels. |
SearchMailbox | Search selected mailbox for specified text. |
SelectMailbox | Select a Mailbox. |
SetMailboxACL | Sets mailbox access control rights for a specific user. |
SubscribeMailbox | Subscribes to the mailbox specified by Mailbox . |
UnsetMessageFlags | Removes the flags specified by MessageFlags from the messages specified by MessageSet . |
UnsetMessageLabels | Removes the message labels specified by MessageLabels from the message specified by MessageSet. |
UnsubscribeMailbox | Unsubscribes from the mailbox specified by Mailbox . |
Event List
The following is the full list of the events fired by the control with short descriptions. Click on the links for further details.
ConnectionStatus | Fired to indicate changes in connection state. |
EndTransfer | Fired when the message or the part data finishes transferring. |
Error | Information about errors during data delivery. |
Header | Fired every time a header line comes in. |
MailboxACL | Fires for each set of access control rights returned by the server. |
MailboxList | Fired for each mailbox received through the ListMailboxes and ListSubscribedMailboxes methods. |
MessageInfo | Fired with information for the message(s) retrieved by the server. |
MessagePart | Fired for each message part when FetchMessageInfo is called. |
PITrail | Traces the commands sent to the mail server, and the respective replies. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Shows the progress of the secure connection. |
StartTransfer | Fired when the message or the part data starts transferring. |
Transfer | Fired while the message gets transferred from the MailServer . |
Configuration Settings
The following is a list of configuration settings for the control with short descriptions. Click on the links for further details.
Idle | The current status of the component. |
AlwaysReturnUIDs | Instructs the server to return UIDs even if not in UIDMode. |
AppendToMailboxDateTime | Specifies the date-time parameter used in the initial APPEND request. |
AuthorizationIdentity | The value to use as the authorization identity when SASL authentication is used. |
AutoDecodeSubject | Instructs the component to automatically decode message subjects. |
EnableIMAPIDLE | Enables or disables IDLE command support in the component. |
FetchAfterSearch | Determines if messages matching the SearchCriteria are fetched after calling SearchMailbox. |
IncludeHeaders | Instructs the component to include the headers in the LocalFile. |
UTF7MailboxNames | Specifies whether or not to automatically encode and decode UTF-7 mailbox names. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The TCP port in the local host where the component binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
RecordLength | The length of received data records. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
UseIPv6 | Whether to use IPv6. |
TcpNoDelay | Whether or not to delay when sending packets. |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLProvider | The name of the security provider to use. |
SSLSecurityFlags | Flags that control certificate verification. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
CodePage | The system code page used for Unicode to Multibyte translations. |