googleMailListMailboxes
Lists all mailboxes matching the search criteria.
Required Parameters
| |
| email | The user's Gmail account. | |
| password | The user's Gmail password. | |
| searchcriteria | The search criteria for the mailboxes to list (ex: *, Inbox.*, Inbox). | |
Optional Parameters
| |
| keepalive | Indicates whether the underlying IMAP connection should be reused. The allowed values are: FALSE, TRUE. | |
| timeout | Timeout, in seconds, for the operation to complete. Zero (0) means no timeout. | |
| firewall_server | IP Address or host name of the firewall. | |
| firewall_port | Port number of the firewall. | |
| firewall_user | User ID used to authenticate with the firewall. | |
| firewall_password | Password used to authenticate with the firewall. | |
| firewall_type | The type of the firewall. The allowed values are: TUNNEL, SOCKS4, SOCKS5. | |
| showlog | Whether to return the list of log messages generated during the operation. The allowed values are: FALSE, TRUE. | |
| logfile | The connector will log the exchange/transferred data to this file. | |
| sslcert | The SSL certificate to be accepted from the server. Any other certificate will be rejected. This can take the form of a full PEM certificate, the path to a file containing the certificate, the public key, the MD5 thunbprint or the SHA1 thumbprint. If not specified any valid certificate will be accepted. | |
| showsslstatus | Whether to return the list of SSL status messages. The allowed values are: FALSE, TRUE. | |
| subscribedonly | Whether or not to only list subscribed mailboxes. The allowed values are: true, false. | |
Output Attributes
| |
| ggl:log# | The log for all the communication between the client and the server. Only returned if 'showlog' is TRUE. | |
| ssl:issuer | The issuer of the SSL certificate. | |
| ssl:subject | The subject of the SSL certificate. | |
| ssl:effectivedate | A date before which the certificate is not valid. | |
| ssl:expirationdate | A date after which the certificate is not valid. | |
| ssl:issuer | The issuer of the SSL certificate. | |
| ssl:publickey | The public key of the certificate. | |
| ssl:serialnum | The serial number of the certificate encoded as a String. | |
| ssl:status# | Shows the progress of the secure connection. Only returned if 'showsslstatus' is TRUE. | |
| ssl:subject | The subject of the SSL certificate. | |
| ggl:error# | List of any non-fatal errors encountered during the operation. | |
| ggl:flags | The mailbox flags in the current listing that matches the search criteria. | |
| ggl:mailbox | The mailbox name in the current listing that matches the search criteria. | |
| ggl:messages | The number of messages in the mailbox. | |
| ggl:recent | The number of recent messages in the mailbox. | |
| ssl:issuer | The issuer of the SSL certificate. | |
| ssl:subject | The subject of the SSL certificate. | |