googleMailSearch
Search the specified mailbox using searchcriteria.
Required Parameters
| The user's Gmail account. | ||
| password | The user's Gmail password. | |
| mailbox | The mailbox where the message is located. | |
| searchcriteria | The search criteria to use for the search operation (ie, SENTSINCE dd-MMM-yyyy). The exact format of the search criteria is specified by the IMAP RFCs. The string consists of one or more search keys and their corresponding values (if any) separated by spaces, for example: 'SINCE 1-Feb-1994 NOT FROM Smith'. |
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. | |
| uidmode | If true, permanent message id-s are used instead of the default temporary ids. The allowed values are: FALSE, TRUE. | |
| maxitems | The maximum number of messages to list. The default lists all messages matching the search. | |
| showlabels | Whether to return the Gmail labels. The allowed values are: TRUE, FALSE. | |
| showthreadid | Whether to return the Gmail thread ID. 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:date | The date of the current message that matches the search criteria. | |
| ggl:fromemail | The from email of the current message that matches the search criteria. | |
| ggl:fromname | The from name of the current message that matches the search criteria. | |
| ggl:id | The id of the current message that matches the search criteria. | |
| ggl:location | The mailbox where the message is located. | |
| ggl:size | The size of the current message that matches the search criteria. | |
| ggl:subject | The subject of the current message that matches the search criteria. | |
| ggl:toname | The To names of the message. | |
| ggl:toemail | The To email addresses of the current message. | |
| ggl:ccname | The CC names of the message. | |
| ggl:ccemail | The CC email addresses of the message. | |
| ggl:attachments | The attachment file names included in the message. | |
| ggl:labels | The labels of the message. They are separate by space. Gmail treats labels as mailboxs. | |
| ggl:threadid | The thread id of the message. Gmail provides a thread ID to associate groups of messages in the same manner as in the Gmail web interface. | |
| part:contenttype# | The content type of the message part. | |
| part:filename# | The filename of the message part. | |
| part:id# | The ID of the message part. | |
| part:size# | The size of the message part. | |
| ssl:issuer | The issuer of the SSL certificate. | |
| ssl:subject | The subject of the SSL certificate. |