GMail Class

Properties   Methods   Events   Configuration Settings   Errors  

The GMail class provides an easy way to manage sending and receiving mail in Gmail.

Syntax

GMail

Remarks

This class provides an easy to use interface for Gmail using version 3 of the Gmail REST API. To use the class, first set the Authorization property to a valid OAuth token. The GMail class can be used for sending or creating new messages; retrieving existing messages; creating, deleting, or sending drafts; and several other functionalities supported by the Gmail API.

This class requires authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth class or a separate process. Once complete you should have an authorization string which looks like:

Assign this value to the Authorization property before attempting any operations. For Example:

Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.

Sending Messages

There are two methods for sending messages using the Gmail component. The SendMail method will send a message directly. Alternatively, you can create a message draft and then send an existing draft using the SendDraft method. In both cases the properties of the new message are assigned through the Message properties (MessageSubject, MessageBodyContent, MessageCc, etc.).

Sending a Message with SendDraft:

Receiving Messages

Information about messages fetched by the component can be accessed through the MessageInfo* properties. The MessageInfo* properties is populated when the ListMessages, FetchMessageInfo, or Search methods are called.

The ListMessages method will list the messages.

By default, the component will fetch one page of 100 messages when ListMessages is called. If additional messages remain in the folder, the NextPageToken property will be populated. If ListMessages is then called again on the same folder the next page of messages will be fetched. The example below populates the MessageInfo* properties with all the messages in the mailbox.

The message page size may also be changed by using the MessagePageSize configuration setting.

Property List

---

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Attachment	Provides the raw attachment content.
Authorization	An OAuth Authorization String.
AutoDecodeParts	Determines whether to automatically decode message parts.
FirewallAutoDetect	This property tells the class 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.
Message	Provides the raw message content.
MessageAttachments	A semicolon separated list of files to attach to a message.
MessageBcc	A comma separated list of recipients for blind carbon copies for a message.
MessageBodyContent	The body content for a message.
MessageBodyContentType	The body content type for a message.
MessageCc	A comma separated list of recipients for carbon copies for a message.
MessageCount	The total number of messages on the mailbox.
MessageFrom	The author of a message.
MessageHeaderCount	The number of records in the MessageHeader arrays.
MessageHeaderField	The property of a message header in a message info listing.
MessageHeaderValue	The value of a message header in a message info listing.
MessageIndex	The index of the MessageInfo that should be used to populate the MessageHeaders and MessageParts collections.
MessageInfoCount	The number of records in the MessageInfo arrays.
MessageInfoBcc	The blind carbon copy recipient of a message in a message info listing.
MessageInfoCc	The carbon copy recipient of a message in a message info listing.
MessageInfoFrom	The sender of a message in a message info listing.
MessageInfoHistoryId	The history identifier of a message in a message info listing.
MessageInfoId	The unique identifier of a message in a message info listing.
MessageInfoInternalDate	The internal date of a message in a message info listing.
MessageInfoLabels	Message labels in a message info listing.
MessageInfoSize	The size of a message in a message info listing.
MessageInfoSnippet	The snippet of a message in a message info listing.
MessageInfoSubject	The subject of a message in a message info listing.
MessageInfoThreadId	The thread ID of a message in a message info listing.
MessageInfoTo	The recipients of a message in a message info listing.
MessagePartCount	The number of records in the MessagePart arrays.
MessagePartAttachmentId	The attachment ID of a message part in a message info listing.
MessagePartContentType	The content type of a message part in a message info listing.
MessagePartData	The data of a message part in a message info listing.
MessagePartFilename	The filename of a message part in a message info listing.
MessagePartId	The unique identifier of a message part in a message info listing.
MessagePartSize	The size of a message part in a message info listing.
MessageSubject	The subject of a message.
MessageTo	A comma separated list of recipients for a message.
NextPageToken	The token to retrieve the next page with data.
ProxyAuthScheme	This property is used to tell the class which type of authorization to perform when connecting to the proxy.
ProxyAutoDetect	This property tells the class whether or not to automatically detect and use proxy system settings, if available.
ProxyPassword	This property contains a password if authentication is to be used for the proxy.
ProxyPort	This property contains the TCP port for the proxy Server (default 80).
ProxyServer	If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSL	This property determines when to use SSL for the connection to the proxy.
ProxyUser	This property contains a user name, if authentication is to be used for the proxy.
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).

Method List

---

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

AddMessageLabels	Adds the specified labels to the message specified by MessageId.
AppendToMailbox	Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. Does not send a message.
Config	Sets or retrieves a configuration setting.
CountMessages	Get the total number of messages in the mailbox.
CreateDraft	Creates a new email draft.
Delete	Deletes a message.
DeleteDraft	Deletes a draft permanently.
DeletePermanently	Deletes the specified messages permanently.
FetchAttachment	Retrieves a raw attachment.
FetchMessage	Retrieves a message including the message parts.
FetchMessageHeaders	Retrieves the headers of a message.
FetchMessageInfo	Retrieves a message info.
FetchMessageRaw	Retrieves the raw message of the specified message ID.
ListDrafts	Lists the drafts in a mailbox.
ListMessages	Lists the messages in a mailbox.
RemoveMessageLabels	Removes the specified labels from the message specified by MessageId.
Reset	Reset the class.
Restore	Restores a message.
Search	Search for messages.
SendCustomRequest	Send a custom HTTP request.
SendDraft	Sends an existing Draft.
SendMail	Sends a new email.

Event List

---

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Error	Information about errors during data delivery.
Log	Fires once for each log message.
MessageHeader	Fired when a header is retrieved from the server.
MessageInfo	Fired when a message is retrieved from the server.
MessagePart	Fired when a message part is retrieved from the server.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Shows the progress of the secure connection.
Transfer	Fired while a document transfers (delivers document).

Configuration Settings

---

The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.

IncludeSpamTrash	Whether or not to include the Spam and Trash folders during the message listing.
MessagePageSize	Page size for fetching messages.
MIMEMessage	MIME encoded message to send.
ResolveLabelNames	Whether or not to resolve the label names to show the display name instead of the id.
ResponseType	The level of information to retrieve for a specific email.
XPath	Provides a way to point to a specific element in the returned XML or JSON response.
XText	The text of the current element.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
AllowHTTPFallback	Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.
Append	Whether to append data to LocalFile.
Authorization	The Authorization string to be sent to the server.
BytesTransferred	Contains the number of bytes transferred in the response data.
ChunkSize	Specifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequest	Set to true to compress the body of a PUT or POST request.
EncodeURL	If set to true the URL will be encoded by the class.
FollowRedirects	Determines what happens when the server issues a redirect.
GetOn302Redirect	If set to true the class will perform a GET on the new location.
HTTP2HeadersWithoutIndexing	HTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersion	The version of HTTP used by the class.
IfModifiedSince	A date determining the maximum age of the desired document.
KeepAlive	Determines whether the HTTP connection is closed after completion of the request.
KerberosSPN	The Service Principal Name for the Kerberos Domain Controller.
LogLevel	The level of detail that is logged.
MaxRedirectAttempts	Limits the number of redirects that are followed in a request.
NegotiatedHTTPVersion	The negotiated HTTP version.
OtherHeaders	Other headers as determined by the user (optional).
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyAuthScheme	The authorization scheme to be used for the proxy.
ProxyPassword	A password if authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if authentication is to be used for the proxy.
SentHeaders	The full set of headers as sent by the client.
StatusLine	The first line of the last response from the server.
TransferredData	The contents of the last response from the server.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the class.
TransferredHeaders	The full set of headers as received from the server.
TransferredRequest	The full request as sent by the client.
UseChunkedEncoding	Enables or Disables HTTP chunked encoding for transfers.
UseIDNs	Whether to encode hostnames to internationalized domain names.
UsePlatformHTTPClient	Whether or not to use the platform HTTP client.
UserAgent	Information about the user agent (browser).
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the class 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.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveRetryCount	The number of keep-alive packets to be sent before the remotehost is considered disconnected.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
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 port in the local host where the class binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
ProxyExceptionsList	A semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
TcpNoDelay	Whether or not to delay when sending packets.
UseIPv6	Whether to use IPv6.
LogSSLPackets	Controls whether SSL packets are logged when using the internal security API.
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).
ReuseSSLSession	Determines if the SSL session is reused.
SSLCACertFilePaths	The paths to CA certificate files on Unix/Linux.
SSLCACerts	A newline separated list of CA certificate to use during SSL client authentication.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLEnableRenegotiation	Whether the renegotiation_info SSL extension is supported.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLNegotiatedCipher	Returns the negotiated ciphersuite.
SSLNegotiatedCipherStrength	Returns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuite	Returns the negotiated ciphersuite.
SSLNegotiatedKeyExchange	Returns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrength	Returns the negotiated key exchange algorithm strength.
SSLNegotiatedVersion	Returns the negotiated protocol version.
SSLProvider	The name of the security provider to use.
SSLSecurityFlags	Flags that control certificate verification.
SSLServerCACerts	A newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
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.