Gmail Module
Properties Methods Events Config Settings Errors
The Gmail module provides an easy way to manage sending and receiving mail in Gmail. The module also includes support for creating, listing, and managing contacts.
Syntax
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 property to set the appropriate fields for the chosen OAuthClientProfile and OAuthGrantType.
The class has the following defaults:
| Authorization Server URL | "https://accounts.google.com/o/oauth2/auth" |
| Token Server URL | "https://accounts.google.com/o/oauth2/token" |
| Scopes | "https://www.googleapis.com/auth/gmail.readonly https://www.googleapis.com/auth/gmail.modify https://www.googleapis.com/auth/gmail.compose https://mail.google.com/" |
Below is a brief description of the different OAuthClientProfile and OAuthGrantType values that are supported by this class. For a more in-depth description of what needs to be set, refer to the service documentation.
Application Profile
This profile encompasses the most basic grant types that OAuth supports. When this profile is set, all the requests and response handling is done by the class. Depending on the grant type, this may involve launching a browser so a user can login to authenticate with a authorization server. It may also involve starting an embedded web server to receive a response from a redirect.
To start the authentication and authorization process, the Authorize method should be called. If the authorization and authentication was successful, then the OAuthAccessToken property will be populated. Additionally, if a refresh token was provided the OAuthRefreshToken property will be populated as well. These values of the fields are for informational purposes. The class will also cache these tokens along with when the OAuthAccessToken will be expired. When a method that makes requests to the service provider is called or the Authorize method is called the class will automatically check to see if the access token is expired. If it is, it will then automatically try to get a new OAuthAccessToken. If the Authorize method was not used and user interaction would be required, the class will throw an error which can be caught. When user interaction is needed depends on what grant type is set in the OAuthGrantType property. To force the component to only check the access token when the Authorize method is called, the OAuthAutomaticRefresh configuration setting can be set to false.
A brief description of the supported values for the OAuthGrantType property are below. For more information, see the service documentation.
Authorization Code
When using the Authorization Code grant type, the class will use an authorization code to get an access token. For this OAuthGrantType the class expects a OAuthClientId, OAuthClientSecret, OAuthServerAuthURL, and OAuthServerTokenURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the class will parse the authorization code, setting the OAuthAuthorizationCode property, from the redirect. Immediately, the class will make a request to the token server to exchange the authorization code for an access token. The token server will return an access token and possibly a refresh token. If the OAuthRefreshToken property is set, or a refresh token is cached, then the class will not launch the browser and use the refresh token in its request to the token server instead of an authorization code.
Example:
Gmail gmail = new Gmail();
gmail.OAuth.ClientProfile = CloudOAuthClientProfiles.cocpApplication;
gmail.OAuth.GrantType = OAuthSettingsGrantTypes.cogtAuthorizationCode;
gmail.OAuth.ClientId = CLIENT_ID;
gmail.OAuth.ClientSecret = CLIENT_SECRET;
gmail.Authorize();
Implicit
Note: This grant type is considered insecure and should only be used when necessary.
When using the Implicit grant type, the class will request the authorization server to get an access token. For this OAuthGrantType the class expects a OAuthClientId, OAuthClientSecret, and OAuthServerAuthURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the class will parse the access token from the redirect.
A disadvantage of the grant type is that can not use a refresh token to silently get a new access token. Most service providers offer a way to silently get a new access token. See the service documentation for specifics. This means the class will not be able to automatically get a fresh token once it expires.
Web Profile
This profile is similar to setting the class to the Application profile and Authorization Code grant type except the class will not launch the browser. It is typically used in situations where there is a back-end that is supporting some front end. This profile expects that OAuthClientId, OAuthClientSecret, OAuthServerAuthURL, OAuthServerTokenURL, and the OAuthReturnURL properties to be set. Before calling the Authorize method, the OAuthWebAuthURL property should be queried to get a URL. This URL should be used to redirect the user to the authorization page for the service provider. The redirect_uri parameter of this URL is mapped to the OAuthReturnURL property. The OAuthReturnURL property should be set to some web server that will parse the authorization code out of the query parameter from the redirect. Once the authorization code is parsed, it should be passed back to the server where it is then set to the OAuthAuthorizationCode property. Once that is set, the Authorize method can be called to exchange the authorization code for an access token and refresh token if provided. The class will then cache these values like normal and use them to make requests. If the OAuthRefreshToken field is set, or a refresh token is cached, then the Authorize method can immediately be called to make a request to the token server to get a new access token.
External OAuth Support
For complex profiles or grant types, or for more control of the flow, it is possible to perform OAuth authentication using the OAuth class or a separate process. Once complete you should have an authorization string which looks like:Bearer ACCESS_TOKEN_VALUE
Assign this value to the Authorization property before attempting any operations. Setting the Authorization property will cause the class to ignore the values set in the OAuth property.
For Example:
Oauth oauth = new Oauth();
oauth.ClientId = "CLIENT_ID";
oauth.ClientSecret = "CLIENT_SECRET";
oauth.AuthorizationScope = "https://www.googleapis.com/auth/gmail.readonly https://www.googleapis.com/auth/contacts http://www.google.com/m8/feeds/contacts/default/full";
oauth.ServerAuthURL = "https://accounts.google.com/o/oauth2/auth";
oauth.ServerTokenURL = "https://accounts.google.com/o/oauth2/token";
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 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:
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 ListMessages, RetrieveMessageInfo, 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.
do {
gmail.ListMessages("", "");
} while (gmail.NextPageToken.Length > 0);
The message page size may also be changed by using the MessagePageSize configuration setting.
Listing Contact Groups
To list the contact groups of a user use the ListContactGroups method. It populates the ContactGroups collection with the retrieved groups. For each retrieved group the ContactGroupList event is fired.
Example (List All Contact Groups):
gmail.ListContactGroups(); // List root groups.
foreach(GLContactGroup group in gmail.ContactGroups){
group.Id; // Group id
group.Name; // Group name
}
Listing Contacts
Use the ListContacts to populate the Contacts collection with the the contacts that are in groups, including main group (Contacts). For each retrieved contact the ContactList event is fired.
Example (List all Contacts):
gmail.ListContacts();
If the number of contacts exceeds the page size, the ListContactsMarker will be populated. You can call ListContacts again to retrieve the next page of contacts. These contacts will be added to the end of the Contacts collection.
Example (List all Contact Pages):
do{
gmail.ListContacts();
} while(!gmail.ListContactsMarker.isEmpty());
Creating and Updating Contacts
To create a new contact use the CreateContact method. The newly created contact is added at the end of the Contacts collection.
Example (Create a Contact in the main group (Contacts))
gmail.CreateContact("Pavel", "Bansky", "pavelb@contoso.com"); // Create the contact in the main group (Contacts).
After creating a contact with basic information, select the contact to be edited in the Contacts collection,
edit its fields and make a call to the UpdateContact method. To edit the newly created contact select the last contact of
the collection.
Example (Update The First Contact Of The List)
gmail.Contacts[0].CompanyName = "nsoftware";
// Set notes
gmail.Contacts[0].Notes = "notes";
// Set multiple phone numbers
gmail.Contacts[0].PhonesCount = 2;
gmail.Contacts[0].PhoneIndex = 0;
gmail.Contacts[0].PhoneType = TGLPhoneTypes.ptMobile;
gmail.Contacts[0].PhoneNumber = "0123456789";
gmail.Contacts[0].PhoneIndex = 1;
gmail.Contacts[0].PhoneType = TGLPhoneTypes.ptWork;
gmail.Contacts[0].PhoneNumber = "9876543210";
gmail.UpdateContact(0);
The OLContact type used in the Contacts collection includes the most commonly used fields for contacts.
Refer to the OLContact type for a complete list of fields. If you need to add other fields, you can use
the SetContactField method. For a complete list of fields a contact can have please refer to the official google
documentation for the People API.
Example (Add Other Fields To A Contact)
// Set birthday
gmail.SetContactField(0, "/json/birthdays", "[{ date: {
"year": 1999,
"month": 12,
"day": 1
}}]", 1); // The last argument is the type of the field. 1 (Array)
// Set address
gmail.SetContactField(0, "/json/addresses", "[{\"metadata\":{\"primary\":true,\"sourcePrimary\":true,\"verified\":true},\"formattedValue\":\"formattedValue\",\"type\":\"type\",\"formattedType\":\"type\"}]", 1); // The last argument is the type of the field. 1 (Array)
// Update the contact
gmail.UpdateContact(0);
Example (Create A Contact In A Specific Group)
Notice that when creating a contact, the group/label is not specified. This can be added through the memberships field
using SetContactField.
gmail.CreateContact("Pavel", "Bansky", "pavelb@contoso.com"); //Notice that no group is specified for this contact
gmail.SetContactField(0, "/json/memberships", "[{\"contactGroupMembership\": { \"contactGroupId\": \"" + gmail.ContactGroups[0].Id + "\" }}]", 1);
gmail.UpdateContact(0);
Retrieving Contacts
To retrieve a contact use the GetContact method and provide the Id of the contact as the argument. The contact is added to the end of the Contacts collection.Example (Retrieve a Contact)
// Retrieve a contact by its ID
string contactId = "12345"; // Replace with the actual contact ID
gmail.GetContact(contactId);
// Access the retrieved contact
var retrievedContact = gmail.Contacts[gmail.Contacts.Count - 1];
retrievedContact.FirstName; //first name
retrievedContact.LastName; //last name
retrievedContact.EmailAddressIndex=0; //set the index to zero to retrieve access the first email address
retrievedContact.EmailAddress; //first email address value
retrievedContact.PhonesIndex=0; //set the index to zero to retrieve access the first phone number
retrievedContact.PhoneNumber; //first phone number value
gmail.GetContactField(gmail.Contacts.Count - 1, "/json/birthdays/[1]/date"); //birthday of the contact
gmail.GetContactField(gmail.Contacts.Count - 1, "/json/nicknames/[1]"); //nickname of the contact
Deleting Contacts
To delete a contact use the DeleteContact method and provide the Id of the contact as the argument. The contact is also removed from the Contacts collection.
Example (Delete a Contact)
// List contacts and search for a contact with the name "John Doe"
gmail.ListContacts();
for (int i = 0; i < gmail.Contacts.Count; i++) {
if (gmail.Contacts[i].DisplayName == "John Doe") {
//Delete the contact
gmail.DeleteContact(gmail.Contacts[i].Id);
break;
}
}
Property List
The following is the full list of the properties of the module 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. |
| ContactGroups | Collection of contact groups listed by the server. |
| Contacts | The collection of contacts listed by the server. |
| Firewall | A set of properties related to firewall access. |
| ListContactsMarker | The page marker for listing contacts. |
| 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. |
| MessageHeaders | Collection of the headers of the message. |
| MessageIndex | The index of the MessageInfo that should be used to populate the MessageHeaders and MessageParts collections. |
| MessageInfo | Collection of information about retrieved messages. |
| MessageOtherHeaders | The additional message headers for a message. |
| MessageParts | Collection of message parts listed by the server. |
| 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. |
| OAuth | This property holds the OAuth Settings. |
| Proxy | A set of properties related to proxy access. |
| SSLAcceptServerCert | Instructs the module to unconditionally accept the server certificate that matches the supplied certificate. |
| SSLCert | The certificate to be used during Secure Sockets Layer (SSL) negotiation. |
| SSLProvider | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
| SSLServerCert | The server certificate for the last established connection. |
Method List
The following is the full list of the methods of the module 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. |
| Authorize | Get the authorization string required to access the protected resource. |
| Config | Sets or retrieves a configuration setting. |
| CountMessages | Get the total number of messages in the mailbox. |
| CreateContact | Creates a contact. |
| CreateDraft | Creates a new email draft. |
| Delete | Deletes a message. |
| DeleteContact | Deletes a contact. |
| DeleteDraft | Deletes a draft permanently. |
| DeletePermanently | Deletes the specified messages permanently. |
| GetContact | Retrieves the contact by Id. |
| GetContactField | Retrieves the contact property value by JSONPath. |
| Interrupt | Interrupt the current method. |
| ListContactGroups | Lists the contact groups of the user. |
| ListContacts | Lists all user's personal contact that are in groups, including main group (Contacts). |
| 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 | This method will reset the module. |
| Restore | Restores a message. |
| RetrieveAttachment | Retrieves a raw attachment. |
| RetrieveMessage | Retrieves a message including the message parts. |
| RetrieveMessageHeaders | Retrieves the headers of a message. |
| RetrieveMessageInfo | Retrieves a message info. |
| RetrieveMessageRaw | Retrieves the raw message of the specified message ID. |
| Search | Search for messages. |
| SendCustomRequest | Send a custom HTTP request. |
| SendDraft | Sends an existing Draft. |
| SendMail | Sends a new email. |
| SetContactField | Sets the contact property value by JSONPath. |
| UpdateContact | Updates a contact. |
Event List
The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.
| ContactGroupList | Fired when a contact group is retrieved by the server. |
| ContactList | Fired when a contact is retrieved from the server. |
| Error | Fired when information is available about errors during data delivery. |
| Log | Fired 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 | Fired when secure connection progress messages are available. |
| Transfer | Fired while a document transfers (delivers document). |
Config Settings
The following is a list of config settings for the module with short descriptions. Click on the links for further details.
| ContactGroupsPageSize | Page size for fetching contact groups. |
| ContactsPageSize | Page size for fetching contacts. |
| IncludeSpamTrash | Whether or not to include the Spam and Trash folders during the message listing. |
| ListContactGroupsMarker | The page marker for listing contact groups. |
| MessagePageSize | Page size for fetching messages. |
| MessageReplyTo | A comma separated list of recipients for a reply to this message. |
| 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. |
| SentMessageID | The ID of the sent message. |
| XPath | Provides a way to point to a specific element in the returned XML or JSON response. |
| XText | The text of the current element. |
| OAuthAccessTokenExpiration | The lifetime of the access token. |
| OAuthAuthorizationTokenType | The type of access token returned. |
| OAuthAutomaticRefresh | Whether or not to refresh an expired access token automatically. |
| OAuthBrowserResponseTimeout | Specifies the amount of time to wait for a response from the browser. |
| OAuthIncludeEmptyRedirectURI | Whether an empty redirect_uri parameter is included in requests. |
| OAuthJWTPayload | The payload of the JWT access token if present. |
| OAuthJWTXChildCount | The number of child elements of the current element. |
| OauthJWTXChildName[i] | The name of the child element. |
| OAuthJWTXChildXText[i] | The inner text of the child element. |
| OAuthJWTXElement | The name of the current element. |
| OauthJWTXParent | The parent of the current element. |
| OAuthJWTXPath | Provides a way to point to a specific element in the returned payload of a JWT based access token. |
| OAuthJWTXSubTree | A snapshot of the current element in the document. |
| OAuthJWTXText | The text of the current element. |
| OAuthParamCount | Specifies the number of additional parameters variables to include in the request. |
| OAuthParamName[i] | Specifies the parameter name at the specified index. |
| OAuthParamValue[i] | Specifies the parameter value at the specified index. |
| OAuthPasswordGrantUsername | Used in the Resource Owner Password grant type. |
| OAuthPKCEChallengeEncoding | The PKCE code challenge method to use. |
| OAuthPKCEVerifier | The PKCE verifier used to generate the challenge. |
| OAuthResetData | Determines if the Reset method applies to the OAuth settings. |
| OAuthReUseWebServer | Determines if the same server instance is used between requests. |
| OAuthTransferredRequest | The full OAuth request last sent by the client. |
| OAuthUsePKCE | Specifies if PKCE should be used. |
| OAuthWebServerActive | Specifies and controls whether the embedded web server is active. |
| OAuthWebServerCertStore | The certificate with private key to use when SSL is enabled. |
| OAuthWebServerCertStorePassword | The certificate with private key to use when SSL is enabled. |
| OAuthWebServerCertStoreType | The certificate with private key to use when SSL is enabled. |
| OAuthWebServerCertSubject | The certificate with private key to use when SSL is enabled. |
| OAuthWebServerFailedResponse | The custom response that will be displayed to the user if authentication failed. |
| OAuthWebServerHost | The hostname used by the embedded web server displayed in the ReturnURL. |
| OAuthWebServerPort | The local port on which the embedded web server listens. |
| OAuthWebServerResponse | The custom response that will be displayed to the user. |
| OAuthWebServerSSLEnabled | Whether the web server requires SSL connections. |
| 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 module. |
| FollowRedirects | Determines what happens when the server issues a redirect. |
| GetOn302Redirect | If set to True the module 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 module. |
| 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. |
| StatusCode | The status code of the last response from the server. |
| 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 module. |
| 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. |
| UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
| UserAgent | Information about the user agent (browser). |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the module 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 module 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. |
| SSLCACerts | A newline separated list of CA certificates to be included when performing an SSL handshake. |
| SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
| SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLClientCACerts | A newline separated list of CA certificates to use during SSL client certificate validation. |
| 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. |
| SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
| SSLNegotiatedCipher | Returns the negotiated cipher suite. |
| SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
| SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
| SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
| SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
| SSLNegotiatedVersion | Returns the negotiated protocol version. |
| SSLSecurityFlags | Flags that control certificate verification. |
| SSLServerCACerts | A newline separated list of CA certificates to use during SSL server certificate validation. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
| 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. |
| BuildInfo | Information about the product's build. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| LicenseInfo | Information about the current license. |
| MaskSensitiveData | Whether sensitive data is masked in log messages. |
| UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
Attachment Property (Gmail Module)
Provides the raw attachment content.
Syntax
@property (nonatomic,readonly,assign,getter=attachment) NSString* attachment; - (NSString*)attachment; @property (nonatomic,readonly,assign,getter=attachmentB) NSData* attachmentB; - (NSData*)attachmentB;
Default Value
""
Remarks
This property is populated after calling RetrieveAttachment and holds the raw attachment content. This can be used to access the data before any processing is done by the class.
This property is read-only.
Authorization Property (Gmail Module)
An OAuth Authorization String.
Syntax
public var authorization: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=authorization,setter=setAuthorization:) NSString* authorization; - (NSString*)authorization; - (void)setAuthorization :(NSString*)newAuthorization;
Default Value
""
Remarks
This property is used to specify an OAuth authorization string. Setting it is a requirement for using the component.
Example
Oauth oauth = new Oauth();
oauth.ClientId = "cd3ac0b7-c936-4b69-a958-ba45a4fb7963";
oauth.ClientSecret = "";
oauth.ServerAuthURL = "https://accounts.google.com/o/oauth2/auth";
oauth.ServerTokenURL = "https://accounts.google.com/o/oauth2/token";
oauth.AuthorizationScope = "https://www.googleapis.com/auth/gmail.readonly";
oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode;
gmail.Authorization = oauth.GetAuthorization();
AutoDecodeParts Property (Gmail Module)
Determines whether to automatically decode message parts.
Syntax
public var autoDecodeParts: Bool { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=autoDecodeParts,setter=setAutoDecodeParts:) BOOL autoDecodeParts; - (BOOL)autoDecodeParts; - (void)setAutoDecodeParts :(BOOL)newAutoDecodeParts;
Default Value
True
Remarks
This property determines whether or not to automatically decode message parts. Message parts, especially binary message parts, are normally sent by the server encoded (Base64 or other format). If this setting is False, the parts will not be automatically decoded.
ContactGroups Property (Gmail Module)
Collection of contact groups listed by the server.
Syntax
public var contactGroups: Array<GLContactGroup> { get {...} }
@property (nonatomic,readwrite,assign,getter=contactGroupCount,setter=setContactGroupCount:) int contactGroupCount; - (int)contactGroupCount; - (void)setContactGroupCount :(int)newContactGroupCount; - (NSString*)contactGroupId:(int)contactGroupIndex; - (NSString*)contactGroupName:(int)contactGroupIndex;
Default Value
""
Remarks
This collection contains a list of contact groups returned by the server. It is populated when ListContactGroups is called.
This property is read-only.
If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:
public func setContactGroupsB(contactGroups: Data) throws public func setContactGroups(contactGroups: String) throws
Contacts Property (Gmail Module)
The collection of contacts listed by the server.
Syntax
public var contacts: Array<GLContact> { get {...} }
@property (nonatomic,readwrite,assign,getter=contactsCount,setter=setContactsCount:) int contactsCount; - (int)contactsCount; - (void)setContactsCount :(int)newContactsCount; - (NSString*)contactDisplayName:(int)contactIndex; - (void)setContactDisplayName:(int)contactIndex :(NSString*)newContactDisplayName; - (NSString*)contactEmailAddress:(int)contactIndex; - (void)setContactEmailAddress:(int)contactIndex :(NSString*)newContactEmailAddress; - (NSString*)contactEmailAddressDisplayName:(int)contactIndex; - (void)setContactEmailAddressDisplayName:(int)contactIndex :(NSString*)newContactEmailAddressDisplayName; - (int)contactEmailAddressesCount:(int)contactIndex; - (void)setContactEmailAddressesCount:(int)contactIndex :(int)newContactEmailAddressesCount; - (int)contactEmailAddressIndex:(int)contactIndex; - (void)setContactEmailAddressIndex:(int)contactIndex :(int)newContactEmailAddressIndex; - (int)contactEmailAddressType:(int)contactIndex; - (void)setContactEmailAddressType:(int)contactIndex :(int)newContactEmailAddressType; - (NSString*)contactEmailAddressTypeCustom:(int)contactIndex; - (void)setContactEmailAddressTypeCustom:(int)contactIndex :(NSString*)newContactEmailAddressTypeCustom; - (NSString*)contactFirstName:(int)contactIndex; - (void)setContactFirstName:(int)contactIndex :(NSString*)newContactFirstName; - (NSString*)contactId:(int)contactIndex; - (NSString*)contactJSON:(int)contactIndex; - (void)setContactJSON:(int)contactIndex :(NSString*)newContactJSON; - (NSString*)contactLastName:(int)contactIndex; - (void)setContactLastName:(int)contactIndex :(NSString*)newContactLastName; - (NSString*)contactNotes:(int)contactIndex; - (void)setContactNotes:(int)contactIndex :(NSString*)newContactNotes; - (NSString*)contactParentId:(int)contactIndex; - (void)setContactParentId:(int)contactIndex :(NSString*)newContactParentId; - (int)contactParentIdIndex:(int)contactIndex; - (void)setContactParentIdIndex:(int)contactIndex :(int)newContactParentIdIndex; - (int)contactParentIdsCount:(int)contactIndex; - (void)setContactParentIdsCount:(int)contactIndex :(int)newContactParentIdsCount; - (int)contactPhoneIndex:(int)contactIndex; - (void)setContactPhoneIndex:(int)contactIndex :(int)newContactPhoneIndex; - (NSString*)contactPhoneNumber:(int)contactIndex; - (void)setContactPhoneNumber:(int)contactIndex :(NSString*)newContactPhoneNumber; - (int)contactPhonesCount:(int)contactIndex; - (void)setContactPhonesCount:(int)contactIndex :(int)newContactPhonesCount; - (int)contactPhoneType:(int)contactIndex; - (void)setContactPhoneType:(int)contactIndex :(int)newContactPhoneType; - (NSString*)contactPhoneTypeCustom:(int)contactIndex; - (void)setContactPhoneTypeCustom:(int)contactIndex :(NSString*)newContactPhoneTypeCustom;
Default Value
""
Remarks
This collection contains a list of contacts returned by the server. It is populated when ListContacts or GetContact is called. A GetContact call adds the retrieved contact to the end of the list. If the contact already exists in the Contacts collection, it will be removed and then added to the end, preventing duplication.
Example (Retrieve Contacts from a Folder)
//List user's personal contacts that are in groups, including main group (Contacts)
gmail.ListContacts();
// Data for each Contact
foreach (GLContact contact in gmail.Contacts) {
contact.FirstName;
contact.LastName;
contact.EmailAddressIndex=0;
contact.EmailAddress; //first email address
contact.PhoneIndex=0;
contact.PhoneNumber; //first phone number
}
This property is read-only.
If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:
public func setContactsB(contacts: Data) throws public func setContacts(contacts: String) throws
Firewall Property (Gmail Module)
A set of properties related to firewall access.
Syntax
public var firewall: Firewall { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=firewallAutoDetect,setter=setFirewallAutoDetect:) BOOL firewallAutoDetect; - (BOOL)firewallAutoDetect; - (void)setFirewallAutoDetect :(BOOL)newFirewallAutoDetect; @property (nonatomic,readwrite,assign,getter=firewallType,setter=setFirewallType:) int firewallType; - (int)firewallType; - (void)setFirewallType :(int)newFirewallType; @property (nonatomic,readwrite,assign,getter=firewallHost,setter=setFirewallHost:) NSString* firewallHost; - (NSString*)firewallHost; - (void)setFirewallHost :(NSString*)newFirewallHost; @property (nonatomic,readwrite,assign,getter=firewallPassword,setter=setFirewallPassword:) NSString* firewallPassword; - (NSString*)firewallPassword; - (void)setFirewallPassword :(NSString*)newFirewallPassword; @property (nonatomic,readwrite,assign,getter=firewallPort,setter=setFirewallPort:) int firewallPort; - (int)firewallPort; - (void)setFirewallPort :(int)newFirewallPort; @property (nonatomic,readwrite,assign,getter=firewallUser,setter=setFirewallUser:) NSString* firewallUser; - (NSString*)firewallUser; - (void)setFirewallUser :(NSString*)newFirewallUser;
Default Value
""
Remarks
This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.
This property is read-only.
If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:
public func setFirewallB(firewall: Data) throws public func setFirewall(firewall: String) throws
ListContactsMarker Property (Gmail Module)
The page marker for listing contacts.
Syntax
public var listContactsMarker: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=listContactsMarker,setter=setListContactsMarker:) NSString* listContactsMarker; - (NSString*)listContactsMarker; - (void)setListContactsMarker :(NSString*)newListContactsMarker;
Default Value
""
Remarks
This property is populated if there are still unlisted contacts after ListContacts is called. It contains the nextLink that will be included as a parameter if ListContacts is called again. This will cause the next page of contacts to be listed.
Example (List All Contacts)
do
{
gMail.ListContacts();
} while (!gmail.ListContactsMarker.IsEmpty());
Message Property (Gmail Module)
Provides the raw message content.
Syntax
@property (nonatomic,readonly,assign,getter=message) NSString* message; - (NSString*)message; @property (nonatomic,readonly,assign,getter=messageB) NSData* messageB; - (NSData*)messageB;
Default Value
""
Remarks
This property is populated after calling RetrieveMessageRaw and holds the raw message content. This can be used to access the data before any processing is done by the class.
This property is read-only.
MessageAttachments Property (Gmail Module)
A semicolon separated list of files to attach to a message.
Syntax
public var messageAttachments: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=messageAttachments,setter=setMessageAttachments:) NSString* messageAttachments; - (NSString*)messageAttachments; - (void)setMessageAttachments :(NSString*)newMessageAttachments;
Default Value
""
Remarks
This property contains a semicolon separated list of files to attach to a message. These files are added to a message created with CreateDraft or messages sent with SendMail.
MessageBcc Property (Gmail Module)
A comma separated list of recipients for blind carbon copies for a message.
Syntax
public var messageBcc: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=messageBcc,setter=setMessageBcc:) NSString* messageBcc; - (NSString*)messageBcc; - (void)setMessageBcc :(NSString*)newMessageBcc;
Default Value
""
Remarks
This property contains a comma separated list of destinations for blind carbon copies of a mail message. These recipients are added to a message created with CreateDraft or messages sent with SendMail.
Example (Add a BCC Recipient)
gmail.MessageBcc = "bbobbertson@bobmail.com";
gmail.SendMail();
Example (Add a BCC Recipient with a Name and Address)
gmail.MessageBcc = "Brandrew Bobbertson < bbobbertson@bobmail.com >";
gmail.SendMail();
MessageBodyContent Property (Gmail Module)
The body content for a message.
Syntax
public var messageBodyContent: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=messageBodyContent,setter=setMessageBodyContent:) NSString* messageBodyContent; - (NSString*)messageBodyContent; - (void)setMessageBodyContent :(NSString*)newMessageBodyContent;
Default Value
""
Remarks
This property contains the content of a message. These addresses are added to a message created with CreateDraft or messages sent with SendMail.
MessageBodyContentType Property (Gmail Module)
The body content type for a message.
Syntax
public var messageBodyContentType: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=messageBodyContentType,setter=setMessageBodyContentType:) NSString* messageBodyContentType; - (NSString*)messageBodyContentType; - (void)setMessageBodyContentType :(NSString*)newMessageBodyContentType;
Default Value
""
Remarks
This property contains the content type of a message. Valid values include text or html. These addresses are added to a message created with CreateDraft or messages sent with SendMail.
MessageCc Property (Gmail Module)
A comma separated list of recipients for carbon copies for a message.
Syntax
public var messageCc: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=messageCc,setter=setMessageCc:) NSString* messageCc; - (NSString*)messageCc; - (void)setMessageCc :(NSString*)newMessageCc;
Default Value
""
Remarks
This property contains a comma separated list of destinations for carbon copies of a mail message. These recipients are added to a message created with CreateDraft or messages sent with SendMail.
Example (Add a CC Recipient)
gmail.MessageCc = "bbobbertson@bobmail.com";
gmail.SendMail();
Example (Add a CC Recipient with a Name and Address)
gmail.MessageCc = "Brandrew Bobbertson < bbobbertson@bobmail.com >";
gmail.SendMail();
MessageCount Property (Gmail Module)
The total number of messages on the mailbox.
Syntax
public var messageCount: Int32 { get {...} }
@property (nonatomic,readonly,assign,getter=messageCount) int messageCount; - (int)messageCount;
Default Value
0
Remarks
This property contains the total number of messages on the mailbox. The class fills out MessageCount after calling the CountMessages method.
This property is read-only.
MessageFrom Property (Gmail Module)
The author of a message.
Syntax
public var messageFrom: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=messageFrom,setter=setMessageFrom:) NSString* messageFrom; - (NSString*)messageFrom; - (void)setMessageFrom :(NSString*)newMessageFrom;
Default Value
""
Remarks
This property contains the author of a message. This property is optional. If it left blank, the message's author will be the Google account used in Authorization.
This property is applied to a message created with CreateDraft or messages sent with SendMail.
Example (Define who a Message is From)
gmail.MessageFrom = "stephen@company.com";
gmail.SendMail();
Example (Define who a Message is From with a Name and Address)
gmail.MessageFrom = "Stephen Withavee < stephen@company.com >";
gmail.SendMail();
MessageHeaders Property (Gmail Module)
Collection of the headers of the message.
Syntax
public var messageHeaders: Array<GLMessageHeader> { get {...} }
@property (nonatomic,readwrite,assign,getter=messageHeaderCount,setter=setMessageHeaderCount:) int messageHeaderCount; - (int)messageHeaderCount; - (void)setMessageHeaderCount :(int)newMessageHeaderCount; - (NSString*)messageHeaderField:(int)messageHeaderIndex; - (void)setMessageHeaderField:(int)messageHeaderIndex :(NSString*)newMessageHeaderField; - (NSString*)messageHeaderValue:(int)messageHeaderIndex; - (void)setMessageHeaderValue:(int)messageHeaderIndex :(NSString*)newMessageHeaderValue;
Default Value
""
Remarks
This property contains the full headers of the message. The headers are retrieved by calling the RetrieveMessageHeaders method.
This property is read-only.
If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:
public func setMessageHeadersB(messageHeaders: Data) throws public func setMessageHeaders(messageHeaders: String) throws
MessageIndex Property (Gmail Module)
The index of the MessageInfo that should be used to populate the MessageHeaders and MessageParts collections.
Syntax
public var messageIndex: Int32 { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=messageIndex,setter=setMessageIndex:) int messageIndex; - (int)messageIndex; - (void)setMessageIndex :(int)newMessageIndex;
Default Value
0
Remarks
The index of the MessageInfo that should be used to populate the MessageHeaders and MessageParts collections.
MessageInfo Property (Gmail Module)
Collection of information about retrieved messages.
Syntax
public var messageInfo: Array<GLMessageInfo> { get {...} }
@property (nonatomic,readwrite,assign,getter=messageInfoCount,setter=setMessageInfoCount:) int messageInfoCount; - (int)messageInfoCount; - (void)setMessageInfoCount :(int)newMessageInfoCount; - (NSString*)messageInfoBcc:(int)messageInfoIndex; - (void)setMessageInfoBcc:(int)messageInfoIndex :(NSString*)newMessageInfoBcc; - (NSString*)messageInfoCc:(int)messageInfoIndex; - (void)setMessageInfoCc:(int)messageInfoIndex :(NSString*)newMessageInfoCc; - (NSString*)messageInfoFrom:(int)messageInfoIndex; - (NSString*)messageInfoHistoryId:(int)messageInfoIndex; - (NSString*)messageInfoId:(int)messageInfoIndex; - (NSString*)messageInfoInternalDate:(int)messageInfoIndex; - (NSString*)messageInfoLabels:(int)messageInfoIndex; - (void)setMessageInfoLabels:(int)messageInfoIndex :(NSString*)newMessageInfoLabels; - (int)messageInfoSize:(int)messageInfoIndex; - (void)setMessageInfoSize:(int)messageInfoIndex :(int)newMessageInfoSize; - (NSString*)messageInfoSnippet:(int)messageInfoIndex; - (void)setMessageInfoSnippet:(int)messageInfoIndex :(NSString*)newMessageInfoSnippet; - (NSString*)messageInfoSubject:(int)messageInfoIndex; - (void)setMessageInfoSubject:(int)messageInfoIndex :(NSString*)newMessageInfoSubject; - (NSString*)messageInfoThreadId:(int)messageInfoIndex; - (void)setMessageInfoThreadId:(int)messageInfoIndex :(NSString*)newMessageInfoThreadId; - (NSString*)messageInfoTo:(int)messageInfoIndex; - (void)setMessageInfoTo:(int)messageInfoIndex :(NSString*)newMessageInfoTo;
Default Value
""
Remarks
This collection contains a list of GLMessageInfo for messages fetched by the server. This property is populated when ListMessages, ListDrafts RetrieveMessageInfo, or Search is called.
This property is read-only.
If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:
public func setMessageInfoB(messageInfo: Data) throws public func setMessageInfo(messageInfo: String) throws
MessageOtherHeaders Property (Gmail Module)
The additional message headers for a message.
Syntax
public var messageOtherHeaders: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=messageOtherHeaders,setter=setMessageOtherHeaders:) NSString* messageOtherHeaders; - (NSString*)messageOtherHeaders; - (void)setMessageOtherHeaders :(NSString*)newMessageOtherHeaders;
Default Value
""
Remarks
This property contains additional message headers to the sent or created message. These addresses are added to a message created with CreateDraft or messages sent with SendMail.
MessageParts Property (Gmail Module)
Collection of message parts listed by the server.
Syntax
public var messageParts: Array<GLMessagePart> { get {...} }
@property (nonatomic,readonly,assign,getter=messagePartCount) int messagePartCount; - (int)messagePartCount; - (NSString*)messagePartAttachmentId:(int)messagePartIndex; - (NSString*)messagePartContentType:(int)messagePartIndex; - (NSString*)messagePartData:(int)messagePartIndex; - (NSString*)messagePartFileName:(int)messagePartIndex; - (NSString*)messagePartId:(int)messagePartIndex; - (int)messagePartSize:(int)messagePartIndex;
Default Value
""
Remarks
This collection contains a list of message parts returned by the server when ListMessages or ListDrafts is called.
This property is read-only.
If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:
public func setMessagePartsB(messageParts: Data) throws public func setMessageParts(messageParts: String) throws
MessageSubject Property (Gmail Module)
The subject of a message.
Syntax
public var messageSubject: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=messageSubject,setter=setMessageSubject:) NSString* messageSubject; - (NSString*)messageSubject; - (void)setMessageSubject :(NSString*)newMessageSubject;
Default Value
""
Remarks
This property contains the subject of a message. This property will be applied to a message created with CreateDraft or messages sent with SendMail.
MessageTo Property (Gmail Module)
A comma separated list of recipients for a message.
Syntax
public var messageTo: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=messageTo,setter=setMessageTo:) NSString* messageTo; - (NSString*)messageTo; - (void)setMessageTo :(NSString*)newMessageTo;
Default Value
""
Remarks
This property contains a comma separated list of destinations for a mail message. These recipients are added to a message created with CreateDraft or messages sent with SendMail.
Example (Add a Recipient)
gmail.MessageTo = "bbobbertson@bobmail.com";
gmail.SendMail();
Example (Add a Recipient with a Name and Address)
gmail.MessageTo = "Brandrew Bobbertson < bbobbertson@bobmail.com >";
gmail.SendMail();
NextPageToken Property (Gmail Module)
The token to retrieve the next page with data.
Syntax
public var nextPageToken: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=nextPageToken,setter=setNextPageToken:) NSString* nextPageToken; - (NSString*)nextPageToken; - (void)setNextPageToken :(NSString*)newNextPageToken;
Default Value
""
Remarks
This property contains the token that will be used to retrieve the next page with information. This field will become available when using the ListMessages or ListDrafts method.
OAuth Property (Gmail Module)
This property holds the OAuth Settings.
Syntax
public var oAuth: OAuthSettings { get {...} }
@property (nonatomic,readwrite,assign,getter=OAuthAccessToken,setter=setOAuthAccessToken:) NSString* OAuthAccessToken; - (NSString*)OAuthAccessToken; - (void)setOAuthAccessToken :(NSString*)newOAuthAccessToken; @property (nonatomic,readwrite,assign,getter=OAuthAuthorizationCode,setter=setOAuthAuthorizationCode:) NSString* OAuthAuthorizationCode; - (NSString*)OAuthAuthorizationCode; - (void)setOAuthAuthorizationCode :(NSString*)newOAuthAuthorizationCode; @property (nonatomic,readwrite,assign,getter=OAuthAuthorizationScope,setter=setOAuthAuthorizationScope:) NSString* OAuthAuthorizationScope; - (NSString*)OAuthAuthorizationScope; - (void)setOAuthAuthorizationScope :(NSString*)newOAuthAuthorizationScope; @property (nonatomic,readwrite,assign,getter=OAuthClientId,setter=setOAuthClientId:) NSString* OAuthClientId; - (NSString*)OAuthClientId; - (void)setOAuthClientId :(NSString*)newOAuthClientId; @property (nonatomic,readwrite,assign,getter=OAuthClientProfile,setter=setOAuthClientProfile:) int OAuthClientProfile; - (int)OAuthClientProfile; - (void)setOAuthClientProfile :(int)newOAuthClientProfile; @property (nonatomic,readwrite,assign,getter=OAuthClientSecret,setter=setOAuthClientSecret:) NSString* OAuthClientSecret; - (NSString*)OAuthClientSecret; - (void)setOAuthClientSecret :(NSString*)newOAuthClientSecret; @property (nonatomic,readwrite,assign,getter=OAuthGrantType,setter=setOAuthGrantType:) int OAuthGrantType; - (int)OAuthGrantType; - (void)setOAuthGrantType :(int)newOAuthGrantType; @property (nonatomic,readwrite,assign,getter=OAuthRefreshToken,setter=setOAuthRefreshToken:) NSString* OAuthRefreshToken; - (NSString*)OAuthRefreshToken; - (void)setOAuthRefreshToken :(NSString*)newOAuthRefreshToken; @property (nonatomic,readwrite,assign,getter=OAuthRequestRefreshToken,setter=setOAuthRequestRefreshToken:) BOOL OAuthRequestRefreshToken; - (BOOL)OAuthRequestRefreshToken; - (void)setOAuthRequestRefreshToken :(BOOL)newOAuthRequestRefreshToken; @property (nonatomic,readwrite,assign,getter=OAuthReturnURL,setter=setOAuthReturnURL:) NSString* OAuthReturnURL; - (NSString*)OAuthReturnURL; - (void)setOAuthReturnURL :(NSString*)newOAuthReturnURL; @property (nonatomic,readwrite,assign,getter=OAuthServerAuthURL,setter=setOAuthServerAuthURL:) NSString* OAuthServerAuthURL; - (NSString*)OAuthServerAuthURL; - (void)setOAuthServerAuthURL :(NSString*)newOAuthServerAuthURL; @property (nonatomic,readwrite,assign,getter=OAuthServerTokenURL,setter=setOAuthServerTokenURL:) NSString* OAuthServerTokenURL; - (NSString*)OAuthServerTokenURL; - (void)setOAuthServerTokenURL :(NSString*)newOAuthServerTokenURL; @property (nonatomic,readonly,assign,getter=OAuthWebAuthURL) NSString* OAuthWebAuthURL; - (NSString*)OAuthWebAuthURL;
Default Value
""
Remarks
This property is used to define the necessary fields to authenticate with the service provider. See the introduction for more information.
This property is read-only.
If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:
public func setOAuthB(oAuth: Data) throws public func setOAuth(oAuth: String) throws
Proxy Property (Gmail Module)
A set of properties related to proxy access.
Syntax
public var proxy: Proxy { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=proxyAuthScheme,setter=setProxyAuthScheme:) int proxyAuthScheme; - (int)proxyAuthScheme; - (void)setProxyAuthScheme :(int)newProxyAuthScheme; @property (nonatomic,readwrite,assign,getter=proxyAutoDetect,setter=setProxyAutoDetect:) BOOL proxyAutoDetect; - (BOOL)proxyAutoDetect; - (void)setProxyAutoDetect :(BOOL)newProxyAutoDetect; @property (nonatomic,readwrite,assign,getter=proxyPassword,setter=setProxyPassword:) NSString* proxyPassword; - (NSString*)proxyPassword; - (void)setProxyPassword :(NSString*)newProxyPassword; @property (nonatomic,readwrite,assign,getter=proxyPort,setter=setProxyPort:) int proxyPort; - (int)proxyPort; - (void)setProxyPort :(int)newProxyPort; @property (nonatomic,readwrite,assign,getter=proxyServer,setter=setProxyServer:) NSString* proxyServer; - (NSString*)proxyServer; - (void)setProxyServer :(NSString*)newProxyServer; @property (nonatomic,readwrite,assign,getter=proxySSL,setter=setProxySSL:) int proxySSL; - (int)proxySSL; - (void)setProxySSL :(int)newProxySSL; @property (nonatomic,readwrite,assign,getter=proxyUser,setter=setProxyUser:) NSString* proxyUser; - (NSString*)proxyUser; - (void)setProxyUser :(NSString*)newProxyUser;
Default Value
""
Remarks
This property contains fields describing the proxy through which the class will attempt to connect.
This property is read-only.
If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:
public func setProxyB(proxy: Data) throws public func setProxy(proxy: String) throws
SSLAcceptServerCert Property (Gmail Module)
Instructs the module to unconditionally accept the server certificate that matches the supplied certificate.
Syntax
public var sslAcceptServerCert: Certificate { get {...} set {...} }
@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertEffectiveDate) NSString* SSLAcceptServerCertEffectiveDate; - (NSString*)SSLAcceptServerCertEffectiveDate; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertExpirationDate) NSString* SSLAcceptServerCertExpirationDate; - (NSString*)SSLAcceptServerCertExpirationDate; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertExtendedKeyUsage) NSString* SSLAcceptServerCertExtendedKeyUsage; - (NSString*)SSLAcceptServerCertExtendedKeyUsage; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertFingerprint) NSString* SSLAcceptServerCertFingerprint; - (NSString*)SSLAcceptServerCertFingerprint; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertFingerprintSHA1) NSString* SSLAcceptServerCertFingerprintSHA1; - (NSString*)SSLAcceptServerCertFingerprintSHA1; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertFingerprintSHA256) NSString* SSLAcceptServerCertFingerprintSHA256; - (NSString*)SSLAcceptServerCertFingerprintSHA256; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertIssuer) NSString* SSLAcceptServerCertIssuer; - (NSString*)SSLAcceptServerCertIssuer; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPrivateKey) NSString* SSLAcceptServerCertPrivateKey; - (NSString*)SSLAcceptServerCertPrivateKey; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPrivateKeyAvailable) BOOL SSLAcceptServerCertPrivateKeyAvailable; - (BOOL)SSLAcceptServerCertPrivateKeyAvailable; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPrivateKeyContainer) NSString* SSLAcceptServerCertPrivateKeyContainer; - (NSString*)SSLAcceptServerCertPrivateKeyContainer; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPublicKey) NSString* SSLAcceptServerCertPublicKey; - (NSString*)SSLAcceptServerCertPublicKey; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPublicKeyAlgorithm) NSString* SSLAcceptServerCertPublicKeyAlgorithm; - (NSString*)SSLAcceptServerCertPublicKeyAlgorithm; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPublicKeyLength) int SSLAcceptServerCertPublicKeyLength; - (int)SSLAcceptServerCertPublicKeyLength; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertSerialNumber) NSString* SSLAcceptServerCertSerialNumber; - (NSString*)SSLAcceptServerCertSerialNumber; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertSignatureAlgorithm) NSString* SSLAcceptServerCertSignatureAlgorithm; - (NSString*)SSLAcceptServerCertSignatureAlgorithm; @property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStore,setter=setSSLAcceptServerCertStore:) NSString* SSLAcceptServerCertStore; - (NSString*)SSLAcceptServerCertStore; - (void)setSSLAcceptServerCertStore :(NSString*)newSSLAcceptServerCertStore; @property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStoreB,setter=setSSLAcceptServerCertStoreB:) NSData* SSLAcceptServerCertStoreB; - (NSData*)SSLAcceptServerCertStoreB; - (void)setSSLAcceptServerCertStoreB :(NSData*)newSSLAcceptServerCertStore; @property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStorePassword,setter=setSSLAcceptServerCertStorePassword:) NSString* SSLAcceptServerCertStorePassword; - (NSString*)SSLAcceptServerCertStorePassword; - (void)setSSLAcceptServerCertStorePassword :(NSString*)newSSLAcceptServerCertStorePassword; @property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStoreType,setter=setSSLAcceptServerCertStoreType:) int SSLAcceptServerCertStoreType; - (int)SSLAcceptServerCertStoreType; - (void)setSSLAcceptServerCertStoreType :(int)newSSLAcceptServerCertStoreType; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertSubjectAltNames) NSString* SSLAcceptServerCertSubjectAltNames; - (NSString*)SSLAcceptServerCertSubjectAltNames; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertThumbprintMD5) NSString* SSLAcceptServerCertThumbprintMD5; - (NSString*)SSLAcceptServerCertThumbprintMD5; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertThumbprintSHA1) NSString* SSLAcceptServerCertThumbprintSHA1; - (NSString*)SSLAcceptServerCertThumbprintSHA1; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertThumbprintSHA256) NSString* SSLAcceptServerCertThumbprintSHA256; - (NSString*)SSLAcceptServerCertThumbprintSHA256; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertUsage) NSString* SSLAcceptServerCertUsage; - (NSString*)SSLAcceptServerCertUsage; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertUsageFlags) int SSLAcceptServerCertUsageFlags; - (int)SSLAcceptServerCertUsageFlags; @property (nonatomic,readonly,assign,getter=SSLAcceptServerCertVersion) NSString* SSLAcceptServerCertVersion; - (NSString*)SSLAcceptServerCertVersion; @property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertSubject,setter=setSSLAcceptServerCertSubject:) NSString* SSLAcceptServerCertSubject; - (NSString*)SSLAcceptServerCertSubject; - (void)setSSLAcceptServerCertSubject :(NSString*)newSSLAcceptServerCertSubject; @property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncoded,setter=setSSLAcceptServerCertEncoded:) NSString* SSLAcceptServerCertEncoded; - (NSString*)SSLAcceptServerCertEncoded; - (void)setSSLAcceptServerCertEncoded :(NSString*)newSSLAcceptServerCertEncoded; @property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncodedB,setter=setSSLAcceptServerCertEncodedB:) NSData* SSLAcceptServerCertEncodedB; - (NSData*)SSLAcceptServerCertEncodedB; - (void)setSSLAcceptServerCertEncodedB :(NSData*)newSSLAcceptServerCertEncoded;
Default Value
""
Remarks
If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.
You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.
Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.
This property is read-only.
If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:
public func setSSLAcceptServerCertB(sslAcceptServerCert: Data) throws public func setSSLAcceptServerCert(sslAcceptServerCert: String) throws
SSLCert Property (Gmail Module)
The certificate to be used during Secure Sockets Layer (SSL) negotiation.
Syntax
public var sslCert: Certificate { get {...} set {...} }
@property (nonatomic,readonly,assign,getter=SSLCertEffectiveDate) NSString* SSLCertEffectiveDate; - (NSString*)SSLCertEffectiveDate; @property (nonatomic,readonly,assign,getter=SSLCertExpirationDate) NSString* SSLCertExpirationDate; - (NSString*)SSLCertExpirationDate; @property (nonatomic,readonly,assign,getter=SSLCertExtendedKeyUsage) NSString* SSLCertExtendedKeyUsage; - (NSString*)SSLCertExtendedKeyUsage; @property (nonatomic,readonly,assign,getter=SSLCertFingerprint) NSString* SSLCertFingerprint; - (NSString*)SSLCertFingerprint; @property (nonatomic,readonly,assign,getter=SSLCertFingerprintSHA1) NSString* SSLCertFingerprintSHA1; - (NSString*)SSLCertFingerprintSHA1; @property (nonatomic,readonly,assign,getter=SSLCertFingerprintSHA256) NSString* SSLCertFingerprintSHA256; - (NSString*)SSLCertFingerprintSHA256; @property (nonatomic,readonly,assign,getter=SSLCertIssuer) NSString* SSLCertIssuer; - (NSString*)SSLCertIssuer; @property (nonatomic,readonly,assign,getter=SSLCertPrivateKey) NSString* SSLCertPrivateKey; - (NSString*)SSLCertPrivateKey; @property (nonatomic,readonly,assign,getter=SSLCertPrivateKeyAvailable) BOOL SSLCertPrivateKeyAvailable; - (BOOL)SSLCertPrivateKeyAvailable; @property (nonatomic,readonly,assign,getter=SSLCertPrivateKeyContainer) NSString* SSLCertPrivateKeyContainer; - (NSString*)SSLCertPrivateKeyContainer; @property (nonatomic,readonly,assign,getter=SSLCertPublicKey) NSString* SSLCertPublicKey; - (NSString*)SSLCertPublicKey; @property (nonatomic,readonly,assign,getter=SSLCertPublicKeyAlgorithm) NSString* SSLCertPublicKeyAlgorithm; - (NSString*)SSLCertPublicKeyAlgorithm; @property (nonatomic,readonly,assign,getter=SSLCertPublicKeyLength) int SSLCertPublicKeyLength; - (int)SSLCertPublicKeyLength; @property (nonatomic,readonly,assign,getter=SSLCertSerialNumber) NSString* SSLCertSerialNumber; - (NSString*)SSLCertSerialNumber; @property (nonatomic,readonly,assign,getter=SSLCertSignatureAlgorithm) NSString* SSLCertSignatureAlgorithm; - (NSString*)SSLCertSignatureAlgorithm; @property (nonatomic,readwrite,assign,getter=SSLCertStore,setter=setSSLCertStore:) NSString* SSLCertStore; - (NSString*)SSLCertStore; - (void)setSSLCertStore :(NSString*)newSSLCertStore; @property (nonatomic,readwrite,assign,getter=SSLCertStoreB,setter=setSSLCertStoreB:) NSData* SSLCertStoreB; - (NSData*)SSLCertStoreB; - (void)setSSLCertStoreB :(NSData*)newSSLCertStore; @property (nonatomic,readwrite,assign,getter=SSLCertStorePassword,setter=setSSLCertStorePassword:) NSString* SSLCertStorePassword; - (NSString*)SSLCertStorePassword; - (void)setSSLCertStorePassword :(NSString*)newSSLCertStorePassword; @property (nonatomic,readwrite,assign,getter=SSLCertStoreType,setter=setSSLCertStoreType:) int SSLCertStoreType; - (int)SSLCertStoreType; - (void)setSSLCertStoreType :(int)newSSLCertStoreType; @property (nonatomic,readonly,assign,getter=SSLCertSubjectAltNames) NSString* SSLCertSubjectAltNames; - (NSString*)SSLCertSubjectAltNames; @property (nonatomic,readonly,assign,getter=SSLCertThumbprintMD5) NSString* SSLCertThumbprintMD5; - (NSString*)SSLCertThumbprintMD5; @property (nonatomic,readonly,assign,getter=SSLCertThumbprintSHA1) NSString* SSLCertThumbprintSHA1; - (NSString*)SSLCertThumbprintSHA1; @property (nonatomic,readonly,assign,getter=SSLCertThumbprintSHA256) NSString* SSLCertThumbprintSHA256; - (NSString*)SSLCertThumbprintSHA256; @property (nonatomic,readonly,assign,getter=SSLCertUsage) NSString* SSLCertUsage; - (NSString*)SSLCertUsage; @property (nonatomic,readonly,assign,getter=SSLCertUsageFlags) int SSLCertUsageFlags; - (int)SSLCertUsageFlags; @property (nonatomic,readonly,assign,getter=SSLCertVersion) NSString* SSLCertVersion; - (NSString*)SSLCertVersion; @property (nonatomic,readwrite,assign,getter=SSLCertSubject,setter=setSSLCertSubject:) NSString* SSLCertSubject; - (NSString*)SSLCertSubject; - (void)setSSLCertSubject :(NSString*)newSSLCertSubject; @property (nonatomic,readwrite,assign,getter=SSLCertEncoded,setter=setSSLCertEncoded:) NSString* SSLCertEncoded; - (NSString*)SSLCertEncoded; - (void)setSSLCertEncoded :(NSString*)newSSLCertEncoded; @property (nonatomic,readwrite,assign,getter=SSLCertEncodedB,setter=setSSLCertEncodedB:) NSData* SSLCertEncodedB; - (NSData*)SSLCertEncodedB; - (void)setSSLCertEncodedB :(NSData*)newSSLCertEncoded;
Default Value
""
Remarks
This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the field to the encoded certificate. To select a certificate, use the store and subject fields.
This property is read-only.
If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:
public func setSSLCertB(sslCert: Data) throws public func setSSLCert(sslCert: String) throws
SSLProvider Property (Gmail Module)
The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
Syntax
public var sslProvider: GmailSSLProviders { get {...} set {...} }
public enum GmailSSLProviders: Int32 { case sslpAutomatic = 0 case sslpPlatform = 1 case sslpInternal = 2 }
@property (nonatomic,readwrite,assign,getter=SSLProvider,setter=setSSLProvider:) int SSLProvider; - (int)SSLProvider; - (void)setSSLProvider :(int)newSSLProvider;
Default Value
0
Remarks
This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.
Possible values are as follows:
| 0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
| 1 (sslpPlatform) | Uses the platform/system implementation. |
| 2 (sslpInternal) | Uses the internal implementation. |
In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.
When Automatic is selected, the platform implementation will be used by default in all cases in the macOS edition.
SSLServerCert Property (Gmail Module)
The server certificate for the last established connection.
Syntax
public var sslServerCert: Certificate { get {...} }
@property (nonatomic,readonly,assign,getter=SSLServerCertEffectiveDate) NSString* SSLServerCertEffectiveDate; - (NSString*)SSLServerCertEffectiveDate; @property (nonatomic,readonly,assign,getter=SSLServerCertExpirationDate) NSString* SSLServerCertExpirationDate; - (NSString*)SSLServerCertExpirationDate; @property (nonatomic,readonly,assign,getter=SSLServerCertExtendedKeyUsage) NSString* SSLServerCertExtendedKeyUsage; - (NSString*)SSLServerCertExtendedKeyUsage; @property (nonatomic,readonly,assign,getter=SSLServerCertFingerprint) NSString* SSLServerCertFingerprint; - (NSString*)SSLServerCertFingerprint; @property (nonatomic,readonly,assign,getter=SSLServerCertFingerprintSHA1) NSString* SSLServerCertFingerprintSHA1; - (NSString*)SSLServerCertFingerprintSHA1; @property (nonatomic,readonly,assign,getter=SSLServerCertFingerprintSHA256) NSString* SSLServerCertFingerprintSHA256; - (NSString*)SSLServerCertFingerprintSHA256; @property (nonatomic,readonly,assign,getter=SSLServerCertIssuer) NSString* SSLServerCertIssuer; - (NSString*)SSLServerCertIssuer; @property (nonatomic,readonly,assign,getter=SSLServerCertPrivateKey) NSString* SSLServerCertPrivateKey; - (NSString*)SSLServerCertPrivateKey; @property (nonatomic,readonly,assign,getter=SSLServerCertPrivateKeyAvailable) BOOL SSLServerCertPrivateKeyAvailable; - (BOOL)SSLServerCertPrivateKeyAvailable; @property (nonatomic,readonly,assign,getter=SSLServerCertPrivateKeyContainer) NSString* SSLServerCertPrivateKeyContainer; - (NSString*)SSLServerCertPrivateKeyContainer; @property (nonatomic,readonly,assign,getter=SSLServerCertPublicKey) NSString* SSLServerCertPublicKey; - (NSString*)SSLServerCertPublicKey; @property (nonatomic,readonly,assign,getter=SSLServerCertPublicKeyAlgorithm) NSString* SSLServerCertPublicKeyAlgorithm; - (NSString*)SSLServerCertPublicKeyAlgorithm; @property (nonatomic,readonly,assign,getter=SSLServerCertPublicKeyLength) int SSLServerCertPublicKeyLength; - (int)SSLServerCertPublicKeyLength; @property (nonatomic,readonly,assign,getter=SSLServerCertSerialNumber) NSString* SSLServerCertSerialNumber; - (NSString*)SSLServerCertSerialNumber; @property (nonatomic,readonly,assign,getter=SSLServerCertSignatureAlgorithm) NSString* SSLServerCertSignatureAlgorithm; - (NSString*)SSLServerCertSignatureAlgorithm; @property (nonatomic,readonly,assign,getter=SSLServerCertStore) NSString* SSLServerCertStore; - (NSString*)SSLServerCertStore; @property (nonatomic,readonly,assign,getter=SSLServerCertStoreB) NSData* SSLServerCertStoreB; - (NSData*)SSLServerCertStoreB; @property (nonatomic,readonly,assign,getter=SSLServerCertStorePassword) NSString* SSLServerCertStorePassword; - (NSString*)SSLServerCertStorePassword; @property (nonatomic,readonly,assign,getter=SSLServerCertStoreType) int SSLServerCertStoreType; - (int)SSLServerCertStoreType; @property (nonatomic,readonly,assign,getter=SSLServerCertSubjectAltNames) NSString* SSLServerCertSubjectAltNames; - (NSString*)SSLServerCertSubjectAltNames; @property (nonatomic,readonly,assign,getter=SSLServerCertThumbprintMD5) NSString* SSLServerCertThumbprintMD5; - (NSString*)SSLServerCertThumbprintMD5; @property (nonatomic,readonly,assign,getter=SSLServerCertThumbprintSHA1) NSString* SSLServerCertThumbprintSHA1; - (NSString*)SSLServerCertThumbprintSHA1; @property (nonatomic,readonly,assign,getter=SSLServerCertThumbprintSHA256) NSString* SSLServerCertThumbprintSHA256; - (NSString*)SSLServerCertThumbprintSHA256; @property (nonatomic,readonly,assign,getter=SSLServerCertUsage) NSString* SSLServerCertUsage; - (NSString*)SSLServerCertUsage; @property (nonatomic,readonly,assign,getter=SSLServerCertUsageFlags) int SSLServerCertUsageFlags; - (int)SSLServerCertUsageFlags; @property (nonatomic,readonly,assign,getter=SSLServerCertVersion) NSString* SSLServerCertVersion; - (NSString*)SSLServerCertVersion; @property (nonatomic,readonly,assign,getter=SSLServerCertSubject) NSString* SSLServerCertSubject; - (NSString*)SSLServerCertSubject; @property (nonatomic,readonly,assign,getter=SSLServerCertEncoded) NSString* SSLServerCertEncoded; - (NSString*)SSLServerCertEncoded; @property (nonatomic,readonly,assign,getter=SSLServerCertEncodedB) NSData* SSLServerCertEncodedB; - (NSData*)SSLServerCertEncodedB;
Default Value
""
Remarks
This property contains the server certificate for the last established connection.
SSLServerCert is reset every time a new connection is attempted.
This property is read-only.
If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:
public func setSSLServerCertB(sslServerCert: Data) throws public func setSSLServerCert(sslServerCert: String) throws
AddMessageLabels Method (Gmail Module)
Adds the specified labels to the message specified by MessageId.
Syntax
- (void)addMessageLabels:(NSString*)messageId :(NSString*)labels;
Remarks
This method adds the specified labels to the message specified by the MessageId. The labels parameter should be set to a semicolon separated list of labels. Labels which contain spaces should be surrounded by quotes.
AppendToMailbox Method (Gmail Module)
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.
Syntax
public func appendToMailbox() throws -> Void
- (void)appendToMailbox;
Remarks
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.
Example (Append Message to Mailbox)
gmail.MessageSubject = "I saw a Tree";
gmail.MessageBodyContentType = "TEXT";
gmail.MessageBodyContent = "It was in my back yard initially. It was still there when I last checked.";
gmail.MessageTo = "TreeLookOut@gmail.com";
gmail.MessageCc = "TreeLookOut@gmail.com";
gmail.AppendToMailbox();
Authorize Method (Gmail Module)
Get the authorization string required to access the protected resource.
Syntax
public func authorize() throws -> Void
- (void)authorize;
Remarks
This method is used to get an access token that is required to access the protected resource. The method will act differently based on what is set in the OAuthClientProfile property and the OAuthGrantType property. This method is not to be used in conjunction with the Authorization property. It should instead be used when setting the OAuth property.
For more information, see the introduction section.
Config Method (Gmail Module)
Sets or retrieves a configuration setting.
Syntax
- (NSString*)config:(NSString*)configurationString;
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
CountMessages Method (Gmail Module)
Get the total number of messages in the mailbox.
Syntax
public func countMessages() throws -> Void
- (void)countMessages;
Remarks
This method gets the total number of messages. This method populates the MessageCount property.
CreateContact Method (Gmail Module)
Creates a contact.
Syntax
- (void)createContact:(NSString*)firstName :(NSString*)lastName :(NSString*)emailAddress;
Remarks
This method creates a new contact with the specified first name, last name, and email address. At least one of the arguments must be provided. If all parameters are null or empty, an error is thrown. The new contact is added to the end of the Contacts list.
After creating a contact with basic information, you can update it and set additional fields by editing the contact in the Contacts collection and calling the UpdateContact method. For more details, refer to the UpdateContact method.
Example (Create a Contact in the main group (Contacts))
gmail.CreateContact("Pavel", "Bansky", "pavelb@contoso.com"); // Create the contact in the main group (Contacts).
CreateDraft Method (Gmail Module)
Creates a new email draft.
Syntax
public func createDraft() throws -> Void
- (void)createDraft;
Remarks
This method creates a new draft in the Drafts folder. The created message's id is also added to the MessageInfo properties.
Example
gmail.MessageSubject = "Subject Text";
gmail.MessageBodyContentType = "TEXT";
gmail.MessageBodyContent = "Body Text";
gmail.MessageTo = "email@example.com";
gmail.CreateDraft();
Delete Method (Gmail Module)
Deletes a message.
Syntax
Remarks
This method deletes a message. Deleted messages will be moved to the Trash folder. messageId takes the message ID of the message to be deleted.
DeleteContact Method (Gmail Module)
Deletes a contact.
Syntax
Remarks
This method deletes a contact specified by its ID. The id parameter takes the contact ID of the contact to be deleted. The contact is also removed from the Contacts collection.
Example (Delete a Contact)
// List contacts and search for a contact with the name "John Doe"
gmail.ListContacts();
for (int i = 0; i < gmail.Contacts.Count; i++) {
if (gmail.Contacts[i].DisplayName == "John Doe") {
//Delete the contact
gmail.DeleteContact(gmail.Contacts[i].Id);
break;
}
}
DeleteDraft Method (Gmail Module)
Deletes a draft permanently.
Syntax
Remarks
This method deletes a draft permanently. draftId takes the draft ID of the draft to be deleted.
DeletePermanently Method (Gmail Module)
Deletes the specified messages permanently.
Syntax
- (void)deletePermanently:(NSString*)messageIds;
Remarks
This method permanently deletes the specified messages by the MessageId. The messageIds parameter should be set to a semicolon separate list of message IDs.
GetContact Method (Gmail Module)
Retrieves the contact by Id.
Syntax
Remarks
This method retrieves a contact specified by its ID and adds the contact to the end of the Contacts list. If the contact already exists in the Contacts collection, it will be removed and then added to the end, preventing duplication.
Example (Get a Contact)
// Retrieve a contact by its ID
string contactId = "12345"; // Replace with the actual contact ID
gmail.GetContact(contactId);
// Access the retrieved contact
var retrievedContact = gmail.Contacts[gmail.Contacts.Count - 1];
retrievedContact.FirstName; //first name
retrievedContact.LastName; //last name
retrievedContact.EmailAddressIndex=0; //set the index to zero to retrieve access the first email address
retrievedContact.EmailAddress; //first email address value
retrievedContact.PhonesIndex=0; //set the index to zero to retrieve access the first phone number
retrievedContact.PhoneNumber; //first phone number value
gmail.GetContactField(gmail.Contacts.Count - 1, "/json/birthdays/[1]/date"); //birthday of the contact
gmail.GetContactField(gmail.Contacts.Count - 1, "/json/nicknames/[1]"); //nickname of the contact
GetContactField Method (Gmail Module)
Retrieves the contact property value by JSONPath.
Syntax
- (NSString*)getContactField:(int)index :(NSString*)jsonPath;
Remarks
This method retrieves a specific field within the contact's JSON field. The first parameter, index, is an integer representing the index of the contact in the Contacts collection from which to retrieve the field. The second parameter, JsonPath, is the JSON path to the field you want to retrieve. Please refer to XPath for more details on how to set the Json path. The method returns a string that represents the value of the specified JSON field.
Example (Access Fields of a Contact)
gmail.GetContact("ContactId");
gmail.GetContactField(gmail.Contacts.Count - 1, "/json/birthdays[1]/date"); //birthday of the contact
gmail.GetContactField(gmail.Contacts.Count - 1, "/json/nickNames/[1]/value"); //middle name of the contact
gmail.GetContactField(gmail.Contacts.Count - 1, "/json/phoneNumbers/[1]/value"); //first phone number of the contact
gmail.GetContactField(gmail.Contacts.Count - 1, "/json/Addresses/[1]/extendedAddress"); //address of the contact
gmail.GetContactField(gmail.Contacts.Count - 1, "/json/Addresses/[1]/type"); //type of address of the contact
Interrupt Method (Gmail Module)
Interrupt the current method.
Syntax
public func interrupt() throws -> Void
- (void)interrupt;
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
ListContactGroups Method (Gmail Module)
Lists the contact groups of the user.
Syntax
public func listContactGroups() throws -> Void
- (void)listContactGroups;
Remarks
This method retrieves and lists the contact groups of the user. It clears and then populates the ContactGroups collection with the retrieved groups. Also, for every listed contact group, the ContactGroupList event is fired.
Example (List All Contact Groups):
gmail.ListContactGroups(); // List root groups.
foreach(GLContactGroup group in gmail.ContactGroups){
group.Id; // Group id
group.Name; // Group name
}
If the number of contact groups exceeds the page size, the ListContactGroupsMarker config value will be populated. You can call ListContactGroups again to retrieve the next page of groups. These groups will be added to the end of the ContactGroups collection.
Example (List All Contact Groups):
do{
gmail.ListContactGroups(); // List root groups.
} while (!gmail.Config("ListContactGroupsMarker").IsEmpty());
ListContacts Method (Gmail Module)
Lists all user's personal contact that are in groups, including main group (Contacts).
Syntax
public func listContacts() throws -> Void
- (void)listContacts;
Remarks
This method retrieves and lists the contacts that are in groups, including main group (Contacts). It clears and then populates the Contacts collection with the retrieved contacts. Also, for every listed contact, the ContactList event is fired.
Example (List all Contacts):
gmail.ListContacts();
If the number of contacts exceeds the page size, the ListContactsMarker will be populated. You can call ListContacts again to retrieve the next page of contacts. These contacts will be added to the end of the Contacts collection.
Example (List All Contacts In All Contact Pages):
do{
gmail.ListContacts();
} while(!gmail.ListContactsMarker.isEmpty());
ListDrafts Method (Gmail Module)
Lists the drafts in a mailbox.
Syntax
Remarks
This method lists the drafts found in the mailbox. This method populates the MessageInfo properties.
If the number of drafts is greater than the message page size, NextPageToken will be populated and calling ListDrafts again will list the next page of drafts.
filter can be used to retrieve a specific subset of drafts, or it can be left as an empty string to retrieve all drafts in a mailbox.
Example (List all drafts in a mailbox)
gmail.ListDrafts("");
Example (List drafts from a specific address)
gmail.ListDrafts("from:someuser@example.com");
Example (List drafts with the 'Unread' label)
gmail.ListDrafts("is:unread");
Example (List drafts with a specific message ID)
gmail.ListDrafts("rfc822msgid:123456");
ListMessages Method (Gmail Module)
Lists the messages in a mailbox.
Syntax
- (void)listMessages:(NSString*)filter :(NSString*)threadId;
Remarks
This method lists the messages found in the mailbox. This method populates the MessageInfo properties.
If the number of messages is greater than the message page size, NextPageToken will be populated and calling ListMessages again will list the next page of messages.
filter can be used to retrieve a specific subset of messages, or it can be left as an empty string to retrieve all messages in a mailbox.
threadId can be used to retrieve a specific subset of messages from a specific thread, or it can be left as an empty string to retrieve all messages in a mailbox.
Example (List all messages in a mailbox)
gmail.ListMessages("", "");
Example (List messages from a specific address)
gmail.ListMessages("from:someuser@example.com", "");
Example (List messages with the 'Unread' label)
gmail.ListMessages("is:unread", "");
Example (List messages with a specific message ID)
gmail.ListMessages("rfc822msgid:123456", "");
Example (List Messages from a specific thread)
gmail.ListMessages("", "123456789");
RemoveMessageLabels Method (Gmail Module)
Removes the specified labels from the message specified by MessageId.
Syntax
- (void)removeMessageLabels:(NSString*)messageId :(NSString*)labels;
Remarks
This method removes the specified labels from the message specified by the MessageId property. The labels parameter should be set to a semicolon separate list of labels. Labels which contain spaces should be surrounded by quotes.
Reset Method (Gmail Module)
This method will reset the component.
Syntax
public func reset() throws -> Void
- (void)reset;
Remarks
This method will reset the class's properties to their default values.
Restore Method (Gmail Module)
Restores a message.
Syntax
Remarks
This method restores a deleted message. Messages that are located in the Trash folder can be restored. id takes the message ID of the message to be restored.
RetrieveAttachment Method (Gmail Module)
Retrieves a raw attachment.
Syntax
- (void)retrieveAttachment:(NSString*)messageId :(NSString*)attachmentId;
Remarks
This method retrieves a message attachment in raw format.
Information about the retrieved message attachment can be accessed through Attachment.
RetrieveMessage Method (Gmail Module)
Retrieves a message including the message parts.
Syntax
- (void)retrieveMessage:(NSString*)messageId;
Remarks
This method retrieves a message including its parts. messageId specifies the message ID for the message.
The fetched part can be accessed through the MessageParts property.
RetrieveMessageHeaders Method (Gmail Module)
Retrieves the headers of a message.
Syntax
- (void)retrieveMessageHeaders:(NSString*)messageId;
Remarks
This method retrieves headers of a message and stores them in the MessageHeaders properties.
RetrieveMessageInfo Method (Gmail Module)
Retrieves a message info.
Syntax
- (void)retrieveMessageInfo:(NSString*)messageId;
Remarks
This method retrieves a message info.
Information about the retrieved message can be accessed through MessageInfo properties.
RetrieveMessageRaw Method (Gmail Module)
Retrieves the raw message of the specified message ID.
Syntax
- (void)retrieveMessageRaw:(NSString*)messageId;
Remarks
This method retrieves the RFC822-encoded text of the specified message ID. The text is stored in the Message property, as well as provided through the Transfer event.
Search Method (Gmail Module)
Search for messages.
Syntax
Remarks
This method can be used to search for messages. Results are returned through the MessageInfo properties. searchKey specifies a string to be searched for.
SendCustomRequest Method (Gmail Module)
Send a custom HTTP request.
Syntax
- (void)sendCustomRequest:(NSString*)HTTPMethod :(NSString*)URL :(NSString*)postData;
Remarks
This method can be used to send a custom HTTP request to the server.
SendDraft Method (Gmail Module)
Sends an existing Draft.
Syntax
Remarks
This method sends an existing draft.
SendMail Method (Gmail Module)
Sends a new email.
Syntax
public func sendMail() throws -> Void
- (void)sendMail;
Remarks
This method sends a new message.
Example
gmail.MessageSubject = "I saw a Tree";
gmail.MessageBodyContentType = "TEXT";
gmail.MessageBodyContent = "It was in my back yard initially. It was still there when I last checked.";
gmail.MessageTo = "TreeLookOut@gmail.com";
gmail.MessageCc = "TreeLookOut@gmail.com";
gmail.SendMail();
SetContactField Method (Gmail Module)
Sets the contact property value by JSONPath.
Syntax
public func setContactField(index: Int32, jsonPath: String, value: String, valueType: Int32) throws -> Void
- (void)setContactField:(int)index :(NSString*)jsonPath :(NSString*)value :(int)valueType;
Remarks
This method updates a specific field within the contact's JSON representation. The parameters for this method are as follows: the first parameter, index, is an integer representing the index of the contact in the Contacts collection to be edited. The second parameter, JsonPath, specifies the JSON path to the field you want to set. Please refer to XPath for more details on how to set the Json path. The third parameter, Value, is the value to be assigned to the JSON field. The fourth parameter, ValueType, is the type of the value, which must be one of the defined types:
- 0 (Object)
- 1 (Array)
- 2 (String)
- 3 (Number)
- 4 (Bool)
- 5 (Null)
- 6 (Raw)
Example (Set/Edit Fields of a Contact before Updating):
gmail.CreateContact("Pavel", "Bansky", "pavelb@contoso.com");// Create a contact in the main group.
// Set address
gmail.SetContactField(0, "/json/addresses", "[{\"metadata\":{\"primary\":true,\"sourcePrimary\":true,\"verified\":true},\"formattedValue\":\"formattedValue\",\"type\":\"type\",\"formattedType\":\"type\"}]", 1); // The last argument is the type of the field. 1 (Array)
//Set skills
gmail.SetContactField(0, "/json/skills", "[{\"metadata\" : {}, \"value\": \"shell scripting\"}, {\"metadata\" : {}, \"value\": \"java\"}]", 1);
// The last argument is the type of the field. 0 (Object)
gmail.SetContactField(0, "/json/skills/[1]/metadata", {\"primary\": false, \"verified\": true}, 0);
// The last argument is the type of the field. 0 (Object)
gmail.SetContactField(0, "/json/skills/[2]/metadata", {\"primary\": true, \"verified\": true}, 0);
// Update the contact
gmail.UpdateContact(0);
UpdateContact Method (Gmail Module)
Updates a contact.
Syntax
Remarks
This method allows you to update an existing contact. The index parameter specifies the position of the contact in the Contacts collection. The method uses this index to take all the data from the specified contact and update the corresponding contact on the server.
To update a contact, edit the desired contact fields within the Contacts collection. Then, call the UpdateContact method with the index of the contact. Note that changing the JSON data will overwrite the entire contact, ignoring other field edits made before setting the JSON.
The OLContact type used in the Contacts collection includes the most commonly used fields for contacts. Refer to the OLContact type for a complete list of fields. If you need to add another field, you can use the SetContactField method. For a complete list of fields a contact can have please refer to the official google documentation for the People API.
Example:
// Create a contact in the main contacts folder.
gmail.CreateContact("Pavel", "Bansky", "pavelb@contoso.com", "");
// Set a company name
gmail.Contacts[0].CompanyName = "Volkswagen";
// Set notes
gmail.Contacts[0].Notes = "testNotes";
// Set multiple phone numbers
gmail.Contacts[0].PhonesCount = 2;
gmail.Contacts[0].PhoneIndex = 0;
gmail.Contacts[0].PhoneType = TGLPhoneTypes.ptMobile;
gmail.Contacts[0].PhoneNumber = "0123456789";
gmail.Contacts[0].PhoneIndex = 1;
gmail.Contacts[0].PhoneType = TGLPhoneTypes.ptWork;
gmail.Contacts[0].PhoneNumber = "9876543210";
// Set birthday
gmail.SetContactField(0, "/json/birthdays", "[{ date: {
"year": 1999,
"month": 12,
"day": 1
}}]", 1); // The last argument is the type of the field. 1 (Array)
// Set address
gmail.SetContactField(0, "/json/addresses", "[{\"metadata\":{\"primary\":true,\"sourcePrimary\":true,\"verified\":true},\"formattedValue\":\"formattedValue\",\"type\":\"type\",\"formattedType\":\"type\"}]", 1); // The last argument is the type of the field. 1 (Array)
// Update the contact
gmail.UpdateContact(0);
ContactGroupList Event (Gmail Module)
Fired when a contact group is retrieved by the server.
Syntax
- (void)onContactGroupList:(NSString*)id :(NSString*)displayName;
Remarks
The ContactGroupList event is fired for each contact group retrieved from the server when ListContactGroups is called.
ContactList Event (Gmail Module)
Fired when a contact is retrieved from the server.
Syntax
- (void)onContactList:(NSString*)id :(NSString*)displayName :(NSString*)firstEmail;
Remarks
The ContactList event is fired for each contact retrieved from the server when ListContacts is called. This event provides the Id, DisplayName and FirstEmail address of the contact.
Error Event (Gmail Module)
Fired when information is available about errors during data delivery.
Syntax
- (void)onError:(int)errorCode :(NSString*)description;
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the class .
The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
Log Event (Gmail Module)
Fired once for each log message.
Syntax
- (void)onLog:(int)logLevel :(NSString*)message :(NSString*)logType;
Remarks
This event is fired once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.
LogLevel indicates the level of message. Possible values are as follows:
| 0 (None) | No events are logged. |
| 1 (Info - default) | Informational events are logged. |
| 2 (Verbose) | Detailed data are logged. |
| 3 (Debug) | Debug data are logged. |
The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.
The value 2 (Verbose) logs additional information about the request and response.
The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).
Message is the log entry.
LogType identifies the type of log entry. Possible values are as follows:
- "Info"
- "RequestHeaders"
- "ResponseHeaders"
- "RequestBody"
- "ResponseBody"
- "ProxyRequest"
- "ProxyResponse"
- "FirewallRequest"
- "FirewallResponse"
MessageHeader Event (Gmail Module)
Fired when a header is retrieved from the server.
Syntax
- (void)onMessageHeader:(NSString*)field :(NSString*)value;
Remarks
The MessageHeaderList event is fired for each header retrieved from the server when RetrieveMessageHeaders is called.
MessageInfo Event (Gmail Module)
Fired when a message is retrieved from the server.
Syntax
func onMessageInfo(id: String, threadId: String, historyId: String, internalDate: String, subject: String, labels: String, from: String, sentTo: String, cc: String, bcc: String, snippet: String, size: Int32)
- (void)onMessageInfo:(NSString*)id :(NSString*)threadId :(NSString*)historyId :(NSString*)internalDate :(NSString*)subject :(NSString*)labels :(NSString*)from :(NSString*)sentTo :(NSString*)cc :(NSString*)bcc :(NSString*)snippet :(int)size;
Remarks
The MessageList event is fired for each message retrieved from the server when ListMessages or ListDrafts is called.
MessagePart Event (Gmail Module)
Fired when a message part is retrieved from the server.
Syntax
func onMessagePart(id: String, attachmentId: String, filename: String, contentType: String, size: Int32, data: String)
- (void)onMessagePart:(NSString*)id :(NSString*)attachmentId :(NSString*)filename :(NSString*)contentType :(int)size :(NSString*)data;
Remarks
The MessagePartList event is fired for each message part retrieved from the server when ListMessages or ListDrafts is called.
SSLServerAuthentication Event (Gmail Module)
Fired after the server presents its certificate to the client.
Syntax
func onSSLServerAuthentication(certEncoded: Data, certSubject: String, certIssuer: String, status: String, accept: inout Bool)
- (void)onSSLServerAuthentication:(NSData*)certEncoded :(NSString*)certSubject :(NSString*)certIssuer :(NSString*)status :(int*)accept;
Remarks
During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.
SSLStatus Event (Gmail Module)
Fired when secure connection progress messages are available.
Syntax
func onSSLStatus(message: String)
- (void)onSSLStatus:(NSString*)message;
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
Transfer Event (Gmail Module)
Fired while a document transfers (delivers document).
Syntax
- (void)onTransfer:(int)direction :(long long)bytesTransferred :(int)percentDone :(NSData*)text;
Remarks
The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.
The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.
Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.
Certificate Type
This is the digital certificate being used.
Remarks
This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.
Fields
effectiveDate
String (read-only)
Default Value: ""
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
expirationDate
String (read-only)
Default Value: ""
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
extendedKeyUsage
String (read-only)
Default Value: ""
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
fingerprint
String (read-only)
Default Value: ""
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
fingerprintSHA1
String (read-only)
Default Value: ""
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
fingerprintSHA256
String (read-only)
Default Value: ""
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
issuer
String (read-only)
Default Value: ""
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
privateKey
String (read-only)
Default Value: ""
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The may be available but not exportable. In this case, returns an empty string.
privateKeyAvailable
Bool (read-only)
Default Value: False
Whether a is available for the selected certificate. If is True, the certificate may be used for authentication purposes (e.g., server authentication).
privateKeyContainer
String (read-only)
Default Value: ""
The name of the container for the certificate (if available). This functionality is available only on Windows platforms.
publicKey
String (read-only)
Default Value: ""
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
publicKeyAlgorithm
String (read-only)
Default Value: ""
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
publicKeyLength
Int32 (read-only)
Default Value: 0
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
serialNumber
String (read-only)
Default Value: ""
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
signatureAlgorithm
String (read-only)
Default Value: ""
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
storeB
Data
Default Value: "MY"
The name of the certificate store for the client certificate.
The property denotes the type of the certificate store specified by . If the store is password-protected, specify the password in .
is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |
When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
store
String
Default Value: "MY"
The name of the certificate store for the client certificate.
The property denotes the type of the certificate store specified by . If the store is password-protected, specify the password in .
is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |
When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
storePassword
String
Default Value: ""
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
storeType
CertStoreTypes
Default Value: 0
The type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
subjectAltNames
String (read-only)
Default Value: ""
Comma-separated lists of alternative subject names for the certificate.
thumbprintMD5
String (read-only)
Default Value: ""
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
thumbprintSHA1
String (read-only)
Default Value: ""
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
thumbprintSHA256
String (read-only)
Default Value: ""
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
usage
String (read-only)
Default Value: ""
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
usageFlags
Int32 (read-only)
Default Value: 0
The flags that show intended use for the certificate. The value of is a combination of the following flags:
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |
Please see the property for a text representation of .
This functionality currently is not available when the provider is OpenSSL.
version
String (read-only)
Default Value: ""
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
subject
String
Default Value: ""
The subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
| Field | Meaning |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma, it must be quoted.
encodedB
Data
Default Value: ""
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate.
When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string.
encoded
String
Default Value: ""
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate.
When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string.
Constructors
public init()
Creates a instance whose properties can be set. This is useful for use with when generating new certificates.
public init(encoded: )
Parses Encoded as an X.509 public key.
public init(storeType: , store: , storePassword: , subject: )
StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store.
After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
public init(storeType: , store: , storePassword: , subject: )
StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.
After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
Firewall Type
The firewall the component will connect through.
Remarks
When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall and the .
Fields
autoDetect
Bool
Default Value: False
Whether to automatically detect and use firewall system settings, if available.
firewallType
FirewallTypes
Default Value: 0
The type of firewall to connect through. The applicable values are as follows:
host
String
Default Value: ""
The name or IP address of the firewall (optional). If a is given, the requested connections will be authenticated through the specified firewall when connecting.
If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class .
password
String
Default Value: ""
A password if authentication is to be used when connecting through the firewall. If is specified, the and properties are used to connect and authenticate to the given firewall. If the authentication fails, the class .
port
Int32
Default Value: 0
The Transmission Control Protocol (TCP) port for the firewall . See the description of the property for details.
Note: This property is set automatically when is set to a valid value. See the description of the property for details.
user
String
Default Value: ""
A username if authentication is to be used when connecting through a firewall. If is specified, this property and the property are used to connect and authenticate to the given Firewall. If the authentication fails, the class .
Constructors
public init()
GLContact Type
Holds information about a contact.
Remarks
Holds information about a contact.
Fields
displayName
String
Default Value: ""
The contact's display name.
emailAddress
String
Default Value: ""
The email address at the specified EmailAddressIndex. For example, when updating a contact, setting EmailAddressIndex to 0 and then assigning "example@example.com" to this property will set the first email address of the contact. Similarly, when retrieving a contact, setting EmailAddressIndex to 0 allows you to read the first email address of the contact.
emailAddressDisplayName
String
Default Value: ""
The display name of the E-mail address selected by EmailAddressIndex. For example, when updating a contact, setting EmailAddressIndex to 0 and then assigning "example@example.com" to this property will set the display name of the first email address. Similarly, when retrieving a contact, setting EmailAddressIndex to 0 allows you to read the display name of the first email address of the contact.
emailAddressesCount
Int32
Default Value: 0
When retrieving contacts, it indicates the number of email addresses linked to the contact. When creating or updating a contact, this property is set to the number of email addresses the contact will have.
emailAddressIndex
Int32
Default Value: 0
Index of email address to get or set in the EmailAddress property. For example, setting EmailAddressIndex to 0 and then assigning a value to this field sets the first email address of a contact. If you are retrieving a contact, setting EmailAddressIndex to 0, will populate EmailAddress with the first email address.
Example (Set the email addresses before updating a contact)
gmail.Contacts[0].EmailAddressesCount = 2;
gmail.Contacts[0].EmailAddressIndex = 0;
gmail.Contacts[0].EmailAddress = "email1@domain1.com"; // set the first email address of the contact
gmail.Contacts[0].EmailAddressIndex = 1;
gmail.Contacts[0].EmailAddress = "email2@domain2.com"; // set the second email address of the contact
gmail.UpdateContact(0);
Example (Read email addresses of a retrieved contact)
gmail.GetContact(contactId);
GLContact lastContact = gmail.Contacts[gmail.Contacts.Count - 1];
for(int i = 0; i < lastContact.EmailAddressesCount; i++){
lastContact.EmailAddressIndex = i; // set the index of the next email to read
lastContact.EmailAddress; // read the next email address of the contact
}
emailAddressType
TGLEmailAddressTypes
Default Value: 0
Type of the E-mail address.
This property indicates the type of a contact's phone number selected by PhoneIndex.
Possible values are:
- 0 (eatHome)
- 1 (eatWork)
- 2 (eatOther)
emailAddressTypeCustom
String
Default Value: ""
Custom type name of the E-mail address selected by EmailAddressIndex.
Example (Adding an email address with a custom type):
gmail.Contacts[0].EmailAddressesCount = 1;
gmail.Contacts[0].EmailAddressIndex = 0;
gmail.Contacts[0].EmailAddressTypeCustom = "customType";
gmail.Contacts[0].EmailAddress = "email@address.com"
//Update the contact
gmail.UpdateContact(0);
firstName
String
Default Value: ""
The contact's first name.
id
String (read-only)
Default Value: ""
The unique identifier of the contact (resource name)
json
String
Default Value: ""
A JSON representation of the contact. Change this field to set raw JSON content to send on next update. Other fields values will be ignored in this case.
lastName
String
Default Value: ""
The contact's last name.
notes
String
Default Value: ""
The user's notes about the contact. (biographies field)
parentId
String
Default Value: ""
The ID of the contact's group selected by ParentIdIndex. For example, when updating a contact, setting ParentIdIndex to 0 and then assigning a group id to this property will set the first group a contact belongs to. Similarly, when retrieving a contact, setting ParentIdIndex to 0 allows you to read the first contact group of the contact. Set this property to an empty string to remove a contact from the group.
parentIdIndex
Int32
Default Value: 0
Index of group ID to get or set in the ParentId property.
Example (Set the groups before updating a contact)
gmail.Contacts[0].ParentIdsCount = 2;
gmail.Contacts[0].ParentIdIndex = 0;
gmail.Contacts[0].ParentId = gmail.ContactGroups[0].Id; // set the first group the contact belongs to
gmail.Contacts[0].ParentIdIndex = 1;
gmail.Contacts[0].ParentId = gmail.ContactGroups[1].Id; // set the first group the contact belongs to
gmail.UpdateContact(0);
Example (Read groups of a retrieved contact)
gmail.GetContact(contactId);
GLContact lastContact = gmail.Contacts[gmail.Contacts.Count - 1];
for(int i = 0; i < lastContact.ParentIdsCount; i++){
lastContact.ParentIdIndex = i; // set the index of the next group to read
lastContact.ParentId; // read the next group of the contact
}
parentIdsCount
Int32
Default Value: 0
When retrieving contacts, it indicates the number groups the contact belongs to. When creating or updating a contact, this property should be set to the number of groups the contact will belong to.
phoneIndex
Int32
Default Value: 0
Index of phone number to get or set in the PhoneNumber property. For example, setting PhoneIndex to 0 and then assigning a value to this field sets the first phone number of a contact. If you are retrieving a contact, setting PhoneIndex to 0, will populate PhoneNumber with the first phone number.
Example (Set the phone numbers before updating a contact):
gmail.Contacts[0].PhonesCount = 2;
gmail.Contacts[0].PhoneIndex = 0;
gmail.Contacts[0].PhoneNumber = "0123456789"; // set the first email address of the contact
gmail.Contacts[0].PhoneIndex = 1;
gmail.Contacts[0].PhoneNumber = "9876543210"; // set the second email address of the contact
gmail.UpdateContact(0);
Example (Read phone numbers of a retrieved contact):
gmail.GetContact(contactId);
GLContact lastContact = gmail.Contacts[gmail.Contacts.Count - 1];
for(int i = 0; i < lastContact.PhonesCount; i++){
lastContact.PhoneIndex = i; // set the index of the next phone number to read
lastContact.PhoneNumber; // read the next phone number of the contact
}
phoneNumber
String
Default Value: ""
This property is used to get or set a phone number at the index specified by PhoneIndex. For example, when updating a contact, setting PhoneIndex to 0 and then assigning "0123456789" to this property will set the first phone number of the contact. Similarly, when retrieving a contact, setting PhoneIndex to 0 allows you to read the first phone number of the contact.
phonesCount
Int32
Default Value: 0
Number of the contact's phone numbers.
When retrieving contacts, this property indicates the number of phone numbers linked to the contact. When updating a contact, this property is set to the number of phone numbers to be linked to the contact.
phoneType
TGLPhoneTypes
Default Value: 0
The phone number type.
This property indicates the type of a contact's phone number selected by PhoneIndex. Possible values are:
- 0 (ptHome)
- 1 (ptWork)
- 2 (ptMobile)
- 3 (ptHomeFax)
- 4 (ptWorkFax)
- 5 (ptOtherFax)
- 6 (ptPager)
- 7 (ptWorkMobile)
- 8 (ptWorkPager)
- 9 (ptMain)
- 10 (ptGoogleVoice)
- 11 (ptOther)
phoneTypeCustom
String
Default Value: ""
The custom type of a contact's phone number selected by PhoneIndex.
Example (Adding a phone number with a custom type):
gmail.Contacts[0].PhoneCount = 1;
gmail.Contacts[0].PhoneIndex = 0;
gmail.Contacts[0].PhoneTypeCustom = "customType";
gmail.Contacts[0].PhoneNumber = "0123456789";
//Update the contact
gmail.UpdateContact(0);
Constructors
public init()
GLContactGroup Type
Holds information about a contact group.
Remarks
Holds information about a contact group.
Fields
id
String (read-only)
Default Value: ""
The unique identifier (resource name) of the contact group.
name
String (read-only)
Default Value: ""
The display name of the contact group.
Constructors
public init()
GLMessageHeader Type
Holds information about a message headers.
Remarks
Holds information about a message headers.
Fields
field
String
Default Value: ""
The field of a message header in a message info listing.
value
String
Default Value: ""
The value of a message header in a message info listing.
Constructors
public init()
GLMessageInfo Type
Holds information about a message.
Remarks
Holds information about a message.
Fields
bcc
String
Default Value: ""
The blind carbon copy recipient of a message in a message info listing.
cc
String
Default Value: ""
The carbon copy recipient of a message in a message info listing.
from
String (read-only)
Default Value: ""
The sender of a message in a message info listing.
historyId
String (read-only)
Default Value: ""
The history identifier of a message in a message info listing.
id
String (read-only)
Default Value: ""
The unique identifier of a message in a message info listing.
internalDate
String (read-only)
Default Value: ""
The internal date of a message in a message info listing.
labels
String
Default Value: ""
Message labels in a message info listing.
size
Int32
Default Value: 0
The size of a message in a message info listing.
snippet
String
Default Value: ""
The snippet of a message in a message info listing.
subject
String
Default Value: ""
The subject of a message in a message info listing.
threadId
String
Default Value: ""
The thread ID of a message in a message info listing.
to
String
Default Value: ""
The recipients of a message in a message info listing.
Constructors
public init()
GLMessagePart Type
Holds information about a message part.
Remarks
Holds information about a message part.
Fields
attachmentId
String (read-only)
Default Value: ""
The attachment ID of a message part in a message info listing.
contentType
String (read-only)
Default Value: ""
The content type of a message part in a message info listing.
data
String (read-only)
Default Value: ""
The data of a message part in a message info listing.
fileName
String (read-only)
Default Value: ""
The filename of a message part in a message info listing.
id
String (read-only)
Default Value: ""
The unique identifier of a message part in a message info listing.
size
Int32
Default Value: 0
The size of a message part in a message info listing.
Constructors
public init()
OAuthSettings Type
The settings to use to authenticate with the service provider.
Remarks
Used to set give the class the necessary information needed to complete OAuth authentication.
Fields
accessToken
String
Default Value: ""
The access token returned by the authorization server. This is set when the class makes a request to the token server.
authorizationCode
String
Default Value: ""
The authorization code that is exchanged for an access token. This is required to be set when the OAuthClientProfile property is set to the Web profile. Otherwise, this field is for information purposes only.
authorizationScope
String
Default Value: ""
The scope request or response parameter used during authorization.
clientId
String
Default Value: ""
The id of the client assigned when registering the application.
clientProfile
CloudOAuthClientProfiles
Default Value: 0
The type of client that is requesting authorization. See the introduction section for more information. Possible values are:
| 0 (cocpApplication - Default) | The application profile is applicable to applications that are run by the user directly. For instance a windows form application would use the application profile. To authorize your application (client) using the application profile see the introduction section. |
| 1 (cocpWeb) | The Web profile is applicable to applications that are run on the server side where the user uses the application from a web browser. To authorize your application (client) using this profile follow see the introduction section. |
clientSecret
String
Default Value: ""
The secret value for the client assigned when registering the application.
grantType
OAuthSettingsGrantTypes
Default Value: 0
The OAuth grant type used to acquire an OAuth access token. See the introduction section for more information. Possible values are:
| 0 (cogtAuthorizationCode - Default) | Authorization Code grant type |
| 1 (cogtImplicit) | Implicit grant type |
| 2 (cogtPassword) | Resource Owner Password Credentials grant type |
| 3 (cogtClientCredentials) | Client Credentials grant type |
refreshToken
String
Default Value: ""
Specifies the refresh token received from or sent to the authorization server. This property is set automatically if a refresh token is retrieved from the token server. If the OAuthAutomaticRefresh configuration setting is set to true, and the OAuthGrantType property is set to a grant that can use refresh tokens.
requestRefreshToken
Bool
Default Value: True
Specifies whether the class will request a refresh token during authorization. By default, this value is True.
When True, the class will automatically add the necessary scopes or parameters to obtain a refresh token. When False, this property will have no effect. If the necessary scopes or parameters are specified manually, a refresh token can still be obtained.
Note: This property is only applicable when the OAuthGrantType property is set to cogtAuthorizationCode.
returnURL
String
Default Value: ""
The URL where the user (browser) returns after authenticating. This property is mapped to the redirect_uri parameter when making a request to the authorization server. Typically, this is automatically set by the class when using the embedded web server. If the OAuthWebServerPort or OAuthWebServerHost configuration settings is set, then this property should be set to match. If using the Web client profile, this should be set to the place where the authorization code will be parsed out of the response after the user finishes authorizing.
serverAuthURL
String
Default Value: ""
The URL of the authorization server.
serverTokenURL
String
Default Value: ""
The URL of the token server used to obtain the access token.
webAuthURL
String (read-only)
Default Value: ""
The URL to which the user should be re-directed for authorization. This field is used to get the URL that the user should be redirected to when using the Web client profile. See introduction section for more information.
Constructors
public init()
Proxy Type
The proxy the component will connect to.
Remarks
When connecting through a proxy, this type is used to specify different properties of the proxy, such as the and the .
Fields
authScheme
ProxyAuthSchemes
Default Value: 0
The type of authorization to perform when connecting to the proxy. This is used only when the and properties are set.
should be set to authNone (3) when no authentication is expected.
By default, is authBasic (0), and if the and properties are set, the class will attempt basic authentication.
If is set to authDigest (1), digest authentication will be attempted instead.
If is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.
If is set to authNtlm (4), NTLM authentication will be used.
For security reasons, setting this property will clear the values of and .
autoDetect
Bool
Default Value: False
Whether to automatically detect and use proxy system settings, if available. The default value is .
password
String
Default Value: ""
A password if authentication is to be used for the proxy.
If is set to Basic Authentication, the and properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If is set to Digest Authentication, the and properties are used to respond to the Digest Authentication challenge from the server.
If is set to NTLM Authentication, the and properties are used to authenticate through NTLM negotiation.
port
Int32
Default Value: 80
The Transmission Control Protocol (TCP) port for the proxy (default 80). See the description of the property for details.
server
String
Default Value: ""
If a proxy is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
If the property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the property is set to the corresponding address. If the search is not successful, an error is returned.
ssl
ProxySSLTypes
Default Value: 0
When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:
| psAutomatic (0) | Default setting. If the URL is an https URL, the class will use the psTunnel option. If the URL is an http URL, the class will use the psNever option. |
| psAlways (1) | The connection is always SSL-enabled. |
| psNever (2) | The connection is not SSL-enabled. |
| psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. |
user
String
Default Value: ""
A username if authentication is to be used for the proxy.
If is set to Basic Authentication, the and properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If is set to Digest Authentication, the and properties are used to respond to the Digest Authentication challenge from the server.
If is set to NTLM Authentication, the and properties are used to authenticate through NTLM negotiation.
Constructors
public init()
public init(server: , port: )
public init(server: , port: , user: , password: )
Config Settings (Gmail Module)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.Gmail Config Settings
The default value is 100.
The default value is 100.
Example (List All Contact Groups)
do
{
gMail.ListContactGroups();
} while (gMail.Config("ListContactGroupsMarker").Length > 0);
The default value is 100.
gmail.Config("MessageReplyTo=test1@email.com,test2@email.com");
component.Config("MIMEMessage" + MIME_MESSAGE);
component.SendMail();
| ResponseType | Meaning |
| 0 (default) | ALL (Returns the full email message data including body parts, attachments, headers and metadata.) |
| 1 | InfoHeadersParts (Returns the message parts, headers and metadata but does not return the attachments) |
| 2 | InfoHeaders (Returns the message headers and message metadata.) |
| 3 | Info (Returns only the message metadata.) |
| 4 | ID (Returns only the message IDs and thread IDs.) |
XPath syntax is available for both XML and JSON documents. An XPath is a series of one or more element accessors separated by the / character, for example, /A/B/C/D. An XPath can be absolute (i.e., it starts with /), or it can be relative to the current XPath location.
The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors, which proceed it in the overall XPath string:
| Accessor | Description |
| name | The first element with a particular name. Can be *. |
| [i] | The i-th element. |
| name[i] | The i-th element with a particular name. |
| [last()] | The last element. |
| [last()-i] | The element i before the last element. |
| name[@attrname="attrvalue"] | The first element with a particular name that contains the specified attribute-value pair.
Supports single and double quotes. (XML Only) |
| . | The current element. |
| .. | The parent element. |
For example, assume the following XML and JSON responses.
XML:
<firstlevel>
<one>value</one>
<two>
<item>first</item>
<item>second</item>
</two>
<three>value three</three>
</firstlevel>
JSON:
{
"firstlevel": {
"one": "value",
"two": ["first", "second"],
"three": "value three"
}
}
The following are examples of valid XPaths for these responses:
| Description | XML XPath | JSON XPath |
| Document root | / | /json |
| Specific element | /firstlevel/one | /json/firstlevel/one |
| i-th child | /firstlevel/two/item[2] | /json/firstlevel/two/[2] |
This list is not exhaustive, but it provides a general idea of the possibilities.
The current element is specified in the XPath configuration setting. This configuration setting is read-only.
OAuth Config Settings
| Bearer (default) | When the access token returned by the server is a Bearer type, the authorization string returned by Authorize will be in the format "Bearer access_token". This can be supplied as the value of the HTTP Authorization header. |
For example, when using the Authorization Code grant type, the OAuthRefreshToken property should be set to a valid refresh token. When using the Client Credential grant type however, the class does not need any additional properties set as it can already get a new access token without user interaction.
If set to (default) the redirect_uri will be sent in all cases. If set to the redirect_uri will only be sent if it has a value.
To parse the payload for specific claims, see OAuthJWTXPath.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
XPath syntax is available for the payload of JWT based access tokens if available. An XPath is a series of one or more element accessors separated by the / character, for example: /A/B/C/D.
The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors which proceed it in the overall XPath string:
| Accessor | Description |
| name | The first element with a particular name. Can be *. |
| [i] | The i-th element. |
| name[i] | The i-th element with a particular name. |
| [last()] | The last element. |
| [last()-i] | The element i before the last element. |
| Description | JSON XPath |
| Document root | /json |
| Specific element | /json/element_one |
| Username Claim (Microsoft Specific) | /json/preferred_username |
| Registered Application Name Claim (Microsoft Specific) | /json/app_displayname |
This is not an exhaustive list by any means, but should provide a general idea of the possibilities. To get the text of the specified element, see OAuthJWTXText.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
component.Config("OAuthParamCount=2");
component.Config("OAuthParamName[0]=myvar");
component.Config("OAuthParamValue[0]=myvalue");
component.Config("OAuthParamName[1]=testname");
component.Config("OAuthParamValue[1]=testvalue");
Additionally, this will also be updated to hold the parameters returned in the response.
for (int i = 0; i < int.Parse(component.Config("OAuthParamCount")); i++)
{
string name = component.Config("OAuthParamName[" + i + "]");
string value = component.Config("OAuthParamValue[" + i + "]");
}
- 1 (Plain)
- 2 (S256/SHA256 - default)
.NET
Gmail gmail = new Gmail();
gmail.Config("OAuthTransferredRequest=on");
gmail.Authorize();
Console.WriteLine(gmail.Config("OAuthTransferredRequest"));
C++
Gmail gmail;
gmail.Config("OAuthTransferredRequest=on");
gmail.Authorize();
printf("%s\r\n", gmail.Config("OAuthTransferredRequest"));
This setting can also be set to activate or deactivate the web server. Under normal circumstances, this would not be required as the class will automatically start and stop the web server when Authorize is called. In certain cases, it is required to start the webserver before calling Authorize. For example, if the OAuthReturnURL needs to be set to a relay server, then you will need to start the web server manually. Another example would be when the OAuthReUseWebServer is set to true, the server will not be automatically stopped, and this configuration setting must be set to "false" to stop the embedded web server.
The OAuthWebServerCertStoreType property specifies the type of the certificate store specified by OAuthWebServerCertStore. If the store is password protected, specify the password in OAuthWebServerCertStorePassword.
OAuthWebServerCertStore is used in conjunction with the OAuthWebServerCertSubject property in order to specify the certificate to be used during SSL.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |
When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
Note: This is required when OAuthWebServerSSLEnabled is set to .
Note: This is only applicable when OAuthWebServerSSLEnabled is set to .
| 0 | User - This is the default for Windows. This specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java. |
| 1 | Machine - For Windows, this specifies that the certificate store is a machine store. Note: This store type is not available in Java. |
| 2 | PFXFile - The certificate store is the name of a PFX (PKCS12) file containing certificates. |
| 3 | PFXBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS12) format. |
| 4 | JKSFile - The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: This store type is available only in Java. |
| 5 | JKSBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: This store type is available only in Java. |
| 6 | PEMKeyFile - The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 | PEMKeyBlob - The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 14 | PPKFile - The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 | PPKBlob - The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 | XMLFile - The certificate store is the name of a file that contains a certificate in XML format. |
| 17 | XMLBlob - The certificate store is a string that contains a certificate in XML format. |
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
| Field | Meaning |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma, it must be quoted.
Note: This is required when OAuthWebServerSSLEnabled is set to .
The default value is localhost.
HTTP Config Settings
When True, the class adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".
The default value is True.
If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class if the server does not support HTTP/2.
The default value is True.
This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.
The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".
The default value is False.
If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the class .
Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.
Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.
A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).
The default value is 0 (Never). In this case, redirects are never followed, and the class instead.
Following are the valid options:
- 0 - Never
- 1 - Always
- 2 - Same Scheme
- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"
When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.
HTTP/2 Notes
When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.
If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.
HTTP/3 Notes
HTTP/3 is supported only in .NET and Java.
When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
Sat, 29 Oct 2017 19:43:31 GMT.
The default value for KeepAlive is .
| 0 (None) | No events are logged. |
| 1 (Info - default) | Informational events are logged. |
| 2 (Verbose) | Detailed data are logged. |
| 3 (Debug) | Debug data are logged. |
The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.
The value 2 (Verbose) logs additional information about the request and response.
The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).
The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by .
Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.
This configuration setting is useful for extending the functionality of the class beyond what is provided.
.NET
Http http = new Http();
http.Config("TransferredRequest=on");
http.PostData = "body";
http.Post("http://someserver.com");
Console.WriteLine(http.Config("TransferredRequest"));
C++
HTTP http;
http.Config("TransferredRequest=on");
http.SetPostData("body", 5);
http.Post("http://someserver.com");
printf("%s\r\n", http.Config("TransferredRequest"));
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.
The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001.
When True (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.
Override the default with the name and version of your software.
TCPClient Config Settings
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.
| 0 | No firewall (default setting). |
| 1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
| 2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
| 3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
| 10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.
In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.
In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.
LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.
This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.
If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.
If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.
The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this configuration setting is set to False.
| 0 | IPv4 only |
| 1 | IPv6 only |
| 2 | IPv6 with IPv4 fallback |
SSL Config Settings
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.
Enabling this configuration setting has no effect if SSLProvider is set to Platform.
The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences:
-----BEGIN CERTIFICATE-----
... (CA certificate in base64 encoding) ...
-----END CERTIFICATE-----
Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".
By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.
If set to True, the class will reuse the context if and only if the following criteria are met:
- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the class is the same.
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When set to 0 (default), the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
When set to 0 (default), the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
Note: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.
Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.
Multiple cipher suites are separated by semicolons.
Example values when SSLProvider is set to Platform include the following:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when SSLProvider is set to Platform include the following:
- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");
Possible values when SSLProvider is set to Internal include the following:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA
When TLS 1.3 is negotiated (see SSLEnabledProtocols), only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:
| TLS1.3 | 12288 (Hex 3000) |
| TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
| TLS1.1 | 768 (Hex 300) (Default - Client) |
| TLS1 | 192 (Hex C0) (Default - Client) |
| SSL3 | 48 (Hex 30) |
| SSL2 | 12 (Hex 0C) |
Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.
SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:
By default when TLS 1.3 is enabled, the class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions that are designed to run on Windows, SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.
If set to 1 (Platform provider), please be aware of the following notes:
- The platform provider is available only on Windows 11/Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.
This configuration setting is applicable only when SSLProvider is set to Internal.
If set to True, all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values.
Note: This configuration setting is applicable only when SSLProvider is set to Internal.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
| 0x00000001 | Ignore time validity status of certificate. |
| 0x00000002 | Ignore time validity status of CTL. |
| 0x00000004 | Ignore non-nested certificate times. |
| 0x00000010 | Allow unknown certificate authority. |
| 0x00000020 | Ignore wrong certificate usage. |
| 0x00000100 | Ignore unknown certificate revocation status. |
| 0x00000200 | Ignore unknown CTL signer revocation status. |
| 0x00000400 | Ignore unknown certificate authority revocation status. |
| 0x00000800 | Ignore unknown root revocation status. |
| 0x00008000 | Allow test root certificate. |
| 0x00004000 | Trust test root certificate. |
| 0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). |
This functionality is currently not available when the provider is OpenSSL.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class .
The format of this value is a comma-separated list of hash-signature combinations. For instance:
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
The default value for this configuration setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.
To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.
In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"
- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
Socket Config Settings
Note: This option is not valid for User Datagram Protocol (UDP) ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Base Config Settings
The following is a list of valid code page identifiers:
| Identifier | Name |
| 037 | IBM EBCDIC - U.S./Canada |
| 437 | OEM - United States |
| 500 | IBM EBCDIC - International |
| 708 | Arabic - ASMO 708 |
| 709 | Arabic - ASMO 449+, BCON V4 |
| 710 | Arabic - Transparent Arabic |
| 720 | Arabic - Transparent ASMO |
| 737 | OEM - Greek (formerly 437G) |
| 775 | OEM - Baltic |
| 850 | OEM - Multilingual Latin I |
| 852 | OEM - Latin II |
| 855 | OEM - Cyrillic (primarily Russian) |
| 857 | OEM - Turkish |
| 858 | OEM - Multilingual Latin I + Euro symbol |
| 860 | OEM - Portuguese |
| 861 | OEM - Icelandic |
| 862 | OEM - Hebrew |
| 863 | OEM - Canadian-French |
| 864 | OEM - Arabic |
| 865 | OEM - Nordic |
| 866 | OEM - Russian |
| 869 | OEM - Modern Greek |
| 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
| 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
| 875 | IBM EBCDIC - Modern Greek |
| 932 | ANSI/OEM - Japanese, Shift-JIS |
| 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
| 949 | ANSI/OEM - Korean (Unified Hangul Code) |
| 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
| 1026 | IBM EBCDIC - Turkish (Latin-5) |
| 1047 | IBM EBCDIC - Latin 1/Open System |
| 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
| 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
| 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
| 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
| 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
| 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
| 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
| 1147 | IBM EBCDIC - France (20297 + Euro symbol) |
| 1148 | IBM EBCDIC - International (500 + Euro symbol) |
| 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
| 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
| 1201 | Unicode UCS-2 Big-Endian |
| 1250 | ANSI - Central European |
| 1251 | ANSI - Cyrillic |
| 1252 | ANSI - Latin I |
| 1253 | ANSI - Greek |
| 1254 | ANSI - Turkish |
| 1255 | ANSI - Hebrew |
| 1256 | ANSI - Arabic |
| 1257 | ANSI - Baltic |
| 1258 | ANSI/OEM - Vietnamese |
| 1361 | Korean (Johab) |
| 10000 | MAC - Roman |
| 10001 | MAC - Japanese |
| 10002 | MAC - Traditional Chinese (Big5) |
| 10003 | MAC - Korean |
| 10004 | MAC - Arabic |
| 10005 | MAC - Hebrew |
| 10006 | MAC - Greek I |
| 10007 | MAC - Cyrillic |
| 10008 | MAC - Simplified Chinese (GB 2312) |
| 10010 | MAC - Romania |
| 10017 | MAC - Ukraine |
| 10021 | MAC - Thai |
| 10029 | MAC - Latin II |
| 10079 | MAC - Icelandic |
| 10081 | MAC - Turkish |
| 10082 | MAC - Croatia |
| 12000 | Unicode UCS-4 Little-Endian |
| 12001 | Unicode UCS-4 Big-Endian |
| 20000 | CNS - Taiwan |
| 20001 | TCA - Taiwan |
| 20002 | Eten - Taiwan |
| 20003 | IBM5550 - Taiwan |
| 20004 | TeleText - Taiwan |
| 20005 | Wang - Taiwan |
| 20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
| 20106 | IA5 German (7-bit) |
| 20107 | IA5 Swedish (7-bit) |
| 20108 | IA5 Norwegian (7-bit) |
| 20127 | US-ASCII (7-bit) |
| 20261 | T.61 |
| 20269 | ISO 6937 Non-Spacing Accent |
| 20273 | IBM EBCDIC - Germany |
| 20277 | IBM EBCDIC - Denmark/Norway |
| 20278 | IBM EBCDIC - Finland/Sweden |
| 20280 | IBM EBCDIC - Italy |
| 20284 | IBM EBCDIC - Latin America/Spain |
| 20285 | IBM EBCDIC - United Kingdom |
| 20290 | IBM EBCDIC - Japanese Katakana Extended |
| 20297 | IBM EBCDIC - France |
| 20420 | IBM EBCDIC - Arabic |
| 20423 | IBM EBCDIC - Greek |
| 20424 | IBM EBCDIC - Hebrew |
| 20833 | IBM EBCDIC - Korean Extended |
| 20838 | IBM EBCDIC - Thai |
| 20866 | Russian - KOI8-R |
| 20871 | IBM EBCDIC - Icelandic |
| 20880 | IBM EBCDIC - Cyrillic (Russian) |
| 20905 | IBM EBCDIC - Turkish |
| 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
| 20932 | JIS X 0208-1990 & 0121-1990 |
| 20936 | Simplified Chinese (GB2312) |
| 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
| 21027 | Extended Alpha Lowercase |
| 21866 | Ukrainian (KOI8-U) |
| 28591 | ISO 8859-1 Latin I |
| 28592 | ISO 8859-2 Central Europe |
| 28593 | ISO 8859-3 Latin 3 |
| 28594 | ISO 8859-4 Baltic |
| 28595 | ISO 8859-5 Cyrillic |
| 28596 | ISO 8859-6 Arabic |
| 28597 | ISO 8859-7 Greek |
| 28598 | ISO 8859-8 Hebrew |
| 28599 | ISO 8859-9 Latin 5 |
| 28605 | ISO 8859-15 Latin 9 |
| 29001 | Europa 3 |
| 38598 | ISO 8859-8 Hebrew |
| 50220 | ISO 2022 Japanese with no halfwidth Katakana |
| 50221 | ISO 2022 Japanese with halfwidth Katakana |
| 50222 | ISO 2022 Japanese JIS X 0201-1989 |
| 50225 | ISO 2022 Korean |
| 50227 | ISO 2022 Simplified Chinese |
| 50229 | ISO 2022 Traditional Chinese |
| 50930 | Japanese (Katakana) Extended |
| 50931 | US/Canada and Japanese |
| 50933 | Korean Extended and Korean |
| 50935 | Simplified Chinese Extended and Simplified Chinese |
| 50936 | Simplified Chinese |
| 50937 | US/Canada and Traditional Chinese |
| 50939 | Japanese (Latin) Extended and Japanese |
| 51932 | EUC - Japanese |
| 51936 | EUC - Simplified Chinese |
| 51949 | EUC - Korean |
| 51950 | EUC - Traditional Chinese |
| 52936 | HZ-GB2312 Simplified Chinese |
| 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
| 57002 | ISCII Devanagari |
| 57003 | ISCII Bengali |
| 57004 | ISCII Tamil |
| 57005 | ISCII Telugu |
| 57006 | ISCII Assamese |
| 57007 | ISCII Oriya |
| 57008 | ISCII Kannada |
| 57009 | ISCII Malayalam |
| 57010 | ISCII Gujarati |
| 57011 | ISCII Punjabi |
| 65000 | Unicode UTF-7 |
| 65001 | Unicode UTF-8 |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Setting this configuration setting to tells the class to use the internal implementation instead of using the system security libraries.
This setting is set to by default on all platforms.
Trappable Errors (Gmail Module)
Gmail Errors
| 1301 | Invalid Input Error. |