GMail Class
Properties Methods Events Configuration Settings Errors
The GMail class provides an easy way to manage sending and receiving mail in Gmail.
Syntax
class cloudmail.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:
Bearer ya29.AHES6ZSZEJzATdZYjeihDn5W-VrXSsxEZu5p0pclxGdKKQ
Assign this value to the authorization property before attempting any operations. For Example:
Oauth oauth = new Oauth();
oauth.ClientId = "3c65828c-6376-4286-91b5-2381c3904a97";
oauth.ClientSecret = "mkk2a2M-B5TQI7o5p_N0fR-CHYVn7e3yH~";
oauth.AuthorizationScope = "https://www.googleapis.com/auth/gmail.readonly";
oauth.ServerTokenURL = "https://accounts.google.com/o/oauth2/token";
oauth.ServerAuthURL = "https://accounts.google.com/o/oauth2/auth";
oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode;
gmail.Authorization = oauth.GetAuthorization();
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 send_mail method will send a message directly. Alternatively, you can create a message draft and then send an existing draft using the send_draft method. In both cases the properties of the new message are assigned through the Message properties (message_subject, message_body_content, message_cc, etc.).
Sending a Message with SendDraft:
gmail.MessageSubject = "I am sending an email.";
gmail.MessageBodyContentType = "TEXT";
gmail.MessageBodyContent = "Just wanted to let you know.";
gmail.MessageTo = "reader@tautology.org";
gmail.CreateDraft();
string messageId = gmail.MessageInfo[0].Id;
gmail.SendDraft(messageId);
Receiving Messages
Information about messages fetched by the component can be accessed through the MessageInfo* properties. The MessageInfo* properties is populated when the list_messages, fetch_message_info, or search methods are called.
The list_messages method will list the messages.
By default, the component will fetch one page of 100 messages when list_messages is called. If additional messages remain in the folder, the next_page_token property will be populated. If list_messages 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.
do {
gmail.ListMessages("", "");
} while (gmail.NextPageToken.Length > 0);
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. |
| auto_decode_parts | Determines whether to automatically decode message parts. |
| firewall_auto_detect | This property tells the class whether or not to automatically detect and use firewall system settings, if available. |
| firewall_type | This property determines the type of firewall to connect through. |
| firewall_host | This property contains the name or IP address of firewall (optional). |
| firewall_password | This property contains a password if authentication is to be used when connecting through the firewall. |
| firewall_port | This property contains the TCP port for the firewall Host . |
| firewall_user | This property contains a user name if authentication is to be used connecting through a firewall. |
| message | Provides the raw message content. |
| message_attachments | A semicolon separated list of files to attach to a message. |
| message_bcc | A comma separated list of recipients for blind carbon copies for a message. |
| message_body_content | The body content for a message. |
| message_body_content_type | The body content type for a message. |
| message_cc | A comma separated list of recipients for carbon copies for a message. |
| message_count | The total number of messages on the mailbox. |
| message_from | The author of a message. |
| message_header_count | The number of records in the MessageHeader arrays. |
| message_header_field | The property of a message header in a message info listing. |
| message_header_value | The value of a message header in a message info listing. |
| message_index | The index of the MessageInfo that should be used to populate the MessageHeaders and MessageParts collections. |
| message_info_count | The number of records in the MessageInfo arrays. |
| message_info_bcc | The blind carbon copy recipient of a message in a message info listing. |
| message_info_cc | The carbon copy recipient of a message in a message info listing. |
| message_info_from | The sender of a message in a message info listing. |
| message_info_history_id | The history identifier of a message in a message info listing. |
| message_info_id | The unique identifier of a message in a message info listing. |
| message_info_internal_date | The internal date of a message in a message info listing. |
| message_info_labels | Message labels in a message info listing. |
| message_info_size | The size of a message in a message info listing. |
| message_info_snippet | The snippet of a message in a message info listing. |
| message_info_subject | The subject of a message in a message info listing. |
| message_info_thread_id | The thread ID of a message in a message info listing. |
| message_info_to | The recipients of a message in a message info listing. |
| message_part_count | The number of records in the MessagePart arrays. |
| message_part_attachment_id | The attachment ID of a message part in a message info listing. |
| message_part_content_type | The content type of a message part in a message info listing. |
| message_part_data | The data of a message part in a message info listing. |
| message_part_filename | The filename of a message part in a message info listing. |
| message_part_id | The unique identifier of a message part in a message info listing. |
| message_part_size | The size of a message part in a message info listing. |
| message_subject | The subject of a message. |
| message_to | A comma separated list of recipients for a message. |
| next_page_token | The token to retrieve the next page with data. |
| proxy_auth_scheme | This property is used to tell the class which type of authorization to perform when connecting to the proxy. |
| proxy_auto_detect | This property tells the class whether or not to automatically detect and use proxy system settings, if available. |
| proxy_password | This property contains a password if authentication is to be used for the proxy. |
| proxy_port | This property contains the TCP port for the proxy Server (default 80). |
| proxy_server | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
| proxy_ssl | This property determines when to use SSL for the connection to the proxy. |
| proxy_user | This property contains a user name, if authentication is to be used for the proxy. |
| ssl_accept_server_cert_encoded | The certificate (PEM/base64 encoded). |
| ssl_cert_encoded | The certificate (PEM/base64 encoded). |
| ssl_cert_store | The name of the certificate store for the client certificate. |
| ssl_cert_store_password | 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. |
| ssl_cert_store_type | The type of certificate store for this certificate. |
| ssl_cert_subject | The subject of the certificate used for client authentication. |
| ssl_server_cert_encoded | 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.
| add_message_labels | Adds the specified labels to the message specified by MessageId. |
| append_to_mailbox | 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. |
| count_messages | Get the total number of messages in the mailbox. |
| create_draft | Creates a new email draft. |
| delete | Deletes a message. |
| delete_draft | Deletes a draft permanently. |
| delete_permanently | Deletes the specified messages permanently. |
| fetch_attachment | Retrieves a raw attachment. |
| fetch_message | Retrieves a message including the message parts. |
| fetch_message_headers | Retrieves the headers of a message. |
| fetch_message_info | Retrieves a message info. |
| fetch_message_raw | Retrieves the raw message of the specified message ID. |
| list_drafts | Lists the drafts in a mailbox. |
| list_messages | Lists the messages in a mailbox. |
| remove_message_labels | Removes the specified labels from the message specified by MessageId. |
| reset | Reset the class. |
| restore | Restores a message. |
| search | Search for messages. |
| send_custom_request | Send a custom HTTP request. |
| send_draft | Sends an existing Draft. |
| send_mail | 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.
| on_error | Information about errors during data delivery. |
| on_log | Fires once for each log message. |
| on_message_header | Fired when a header is retrieved from the server. |
| on_message_info | Fired when a message is retrieved from the server. |
| on_message_part | Fired when a message part is retrieved from the server. |
| on_ssl_server_authentication | Fired after the server presents its certificate to the client. |
| on_ssl_status | Shows the progress of the secure connection. |
| on_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. |
| 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. |
| SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
| 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. |