[UDF] Gmail API - Emails automation with AutoIt!

[Ascer]

1. Description.

• Automate communication with Gmail API using oAuth 2.0 security.

2. Requirements.

• Google Gmail account.
• Finished Authorization process. Look here

3. Possibilities.

;========================================================================================================================
; Date:             2018-02-12, 11:46
;
; Bug Fixs:         2018-02-17, 7:31                    -> Fixed problems with adding items to array and minor bugs.
;
; Description:      UDF for using Gmail API interface. This UDF requires oAuth.au3 and Gmail account.
;
; Function(s):
;                   gmailUsersGetProfile()              -> Information about your account.
;                   gmailUsersLabelsList()              -> Get all available labels ids. ex. "INBOX", "UNREAD"
;                   gmailUsersLabelsGet()               -> Get information about specific label id.
;                   gmailUsersMessagesBatchDelete()     -> Delete many messages emails by id.
;                   gmailUsersMessagesBatchModify()     -> Set status for many messages ex. "INBOX", "UNREAD"
;                   gmailUsersMessagesDelete()          -> Totaly delete email from ur account.
;                   gmailUsersMessagesGet()             -> Get all information about specific email.
;                   gmailUsersMessagesList()            -> Get list of last ~100 emails.
;                   gmailUsersMessagesModify()          -> Modify single message.
;                   gmailUsersMessagesTrash()           -> Put email in trash.
;                   gmailUsersMessagesUntrash()         -> Restore email from trash.
;                   gmailUsersMessagesSend()            -> Send email to single or group recipients.
;                   gmailUsersMessagesAttachmentsGet()  -> Download attachment by id.
;
; Author(s):        Ascer
;========================================================================================================================

4. Downloads.

• oAuth.au3
• Gmail API.au3

5. Examples.

• Sending emails

Edited February 17, 2018 by Ascer

[Ascer]

• Gmail API send email

expandcollapse popup

;=======================================================================================================================
; Date:             2018-02-12, 17:52
;
; Description:      Send email using API to single or group of receipients.
;
; Function(s):      gmailUsersMessagesSend() -> example usage
;
; Param(s):         $sClientId          Your client_id from *json file
;                   $sClientSecret      Your client_secret from *json file
;                   $sRefreshToken      Refresh token received from oAuth2GetAccessToken()[2]
;                   $sYourGmailAdress   You gmail email adress
;                   $aRecipient         Receipients: can be single without array or sepatared by comma "email1,email2"
;                   $sSubject           Message Subject.
;                   $sBody              Message body in text
;                   $sBodyHtml          Message body in Html
;                   $sAttachment        Attachment: string or array | Put path to file ex. [@ScriptDir & "\test.png"]   
;=======================================================================================================================

#Include <Gmail API.au3>

Local $sClientId = "167204758184-vpeues0uk6b0g4jrnv0ipq5fapoig2v8.apps.googleusercontent.com" 
Local $sClientSecret = "cWalvFr3WxiE6cjUkdmKEPo8"
Local $sRefreshToken = "34wSsq5sdfcoH-Rl-dfldfLffqxq2fhdPL1K-sf"
Local $sYourGmailAdress = "youremail@gmail.com"
Local $aRecipient = ["friend1@gmail.com", "friend2@yahoo.com"]
Local $sSubject = "Testing Gmail API with Autoit"
Local $sBody = "Hello there. Just testing..." & @CRLF
Local $sBodyHtml = '<meta charset="utf-8"><h2>AutoIt v3<br></h2>'
Local $sAttachment = Default

Local $aToken = oAuth2RefreshAccessToken($sRefreshToken, $sClientId, $sClientSecret)

If Not IsArray($aToken) Then
    except("<none>", "Failed to get access token. Exiting..", 1)
    Exit
EndIf

$aToken = $aToken[0]

Local $aRet = gmailUsersMessagesSend($aRecipient, $sSubject, $sBody & $sBodyHtml, $sYourGmailAdress, $aToken, "Bearer", Default, $sAttachment)

If Not IsArray($aRet) Then
    except("<none>", "Failed to send an email.", 2)
EndIf

ConsoleWrite("Message Sent Sucessfully!" & @CRLF)
ConsoleWrite("MessageId: " & $aRet[0] & @CRLF)
ConsoleWrite("ThreadId: " & $aRet[0] & @CRLF)

Local $aLabelsIds = $aRet[2]
ConsoleWrite("Sent message labels_ids: " & @CRLF)

For $sLabel = 0 To UBound($aLabelsIds) - 1
    ConsoleWrite("Label: " & $aLabelsIds[$sLabel] & @CRLF)
Next

 

Edited February 17, 2018 by Ascer

[mLipok]

please add this lines to each of your file:
 

#AutoIt3Wrapper_Run_AU3Check=Y
#AutoIt3Wrapper_Au3Check_Parameters=-d -w 1 -w 2 -w 3 -w 4 -w 5 -w 6 -w 7

and check what will happen when you try to use Au3Check by pressing CTRL+F5 in SciTe4AutoIt .

ps.
Currently there are still few bugs.... and warnings.

Edited February 16, 2018 by mLipok

[Ascer]

@mLipok

Thanks for verify this. It's my first time when i hear about #AutoitWrapper. 

This tool help me so much in next UDF. 

Bugs fixed, UDF updated. (CTRL + F5 show me nothing)

[mLipok]

On 17.02.2018 at 7:55 AM, Ascer said:

Bugs fixed, UDF updated. (CTRL + F5 show me nothing)

But I get this:
 

Spoiler

Quote

>"C:\Program Files (x86)\AutoIt3\SciTE\..\AutoIt3.exe" "C:\Program Files (x86)\AutoIt3\SciTE\AutoIt3Wrapper\AutoIt3Wrapper.au3" /Prod /AU3check /in "C:\Users\user\Downloads\Gmail API.au3"
+>23:41:53 Starting AutoIt3Wrapper v.17.224.935.0 SciTE v.3.7.3.0   Keyboard:00000415  OS:WIN_10/  CPU:X64 OS:X64  Environment(Language:0415)  CodePage:65001  utf8.auto.check:4
+>         SciTEDir => C:\Program Files (x86)\AutoIt3\SciTE   UserDir => C:\Users\user\AppData\Local\AutoIt v3\SciTE\AutoIt3Wrapper   SCITE_USERHOME => C:\Users\user\AppData\Local\AutoIt v3\SciTE 
>Running AU3Check (3.3.15.4)  params:-d -w 1 -w 2 -w 3 -w 4 -w 5 -w 6 -w 7  from:C:\Program Files (x86)\AutoIt3  input:C:\Users\user\Downloads\Gmail API.au3
"C:\Users\user\Downloads\oAuth.au3"(14,7) : warning: 'Local' specifier in global scope.
Local $AUTHORIZATION_CODE
~~~~~~^
"C:\Users\user\Downloads\Gmail API.au3"(80,18) : warning: $bQuestion: declared, but not used in func.
    Local $bQuestion
    ~~~~~~~~~~~~~~~~^
"C:\Users\user\Downloads\Gmail API.au3"(214,18) : warning: $bQuestion: declared, but not used in func.
    Local $bQuestion,
    ~~~~~~~~~~~~~~~~^
"C:\Users\user\Downloads\Gmail API.au3"(339,41) : warning: $iUbound already declared/assigned
        Local $iUbound = UBound($sAddLabelIds)
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^
"C:\Users\user\Downloads\Gmail API.au3"(355,44) : warning: $iUbound already declared/assigned
        Local $iUbound = UBound($sRemoveLabelIds)
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^
"C:\Users\user\Downloads\Gmail API.au3"(487,17) : warning: 'Dim' deprecated as declaration. Prefer to use Local or Global.
    Dim $aLabels[0]
    ~~~~~~~~~~~~~~~^
"C:\Users\user\Downloads\Gmail API.au3"(503,27) : warning: $fQuestion: declared, but not used in func.
    Local $aTable, $fQuestion
    ~~~~~~~~~~~~~~~~~~~~~~~~~^
"C:\Users\user\Downloads\Gmail API.au3"(575,16) : warning: 'Dim' deprecated as declaration. Prefer to use Local or Global.
    Dim $aInbox[0]
    ~~~~~~~~~~~~~~^
"C:\Users\user\Downloads\Gmail API.au3"(582,32) : warning: 'Dim' deprecated as declaration. Prefer to use Local or Global.
                Dim $aSingleMessageArray[0]
                ~~~~~~~~~~~~~~~~~~~~~~~~~~~^
"C:\Users\user\Downloads\Gmail API.au3"(576,18) : warning: $bQuestion: declared, but not used in func.
    Local $bQuestion
    ~~~~~~~~~~~~~~~~^
"C:\Users\user\Downloads\Gmail API.au3"(652,44) : warning: $iUbound already declared/assigned
        Local $iUbound = UBound($sRemoveLabelIds)
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^
"C:\Users\user\Downloads\Gmail API.au3"(713,17) : warning: 'Dim' deprecated as declaration. Prefer to use Local or Global.
    Dim $aLabels[0]
    ~~~~~~~~~~~~~~~^
"C:\Users\user\Downloads\Gmail API.au3"(763,17) : warning: 'Dim' deprecated as declaration. Prefer to use Local or Global.
    Dim $aLabels[0]
    ~~~~~~~~~~~~~~~^
"C:\Users\user\Downloads\Gmail API.au3"(880,17) : warning: 'Dim' deprecated as declaration. Prefer to use Local or Global.
    Dim $aLabels[0]
    ~~~~~~~~~~~~~~~^
"C:\Users\user\Downloads\Gmail API.au3"(890,27) : warning: $fQuestion: declared, but not used in func.
    Local $aTable, $fQuestion
    ~~~~~~~~~~~~~~~~~~~~~~~~~^
"C:\Users\user\Downloads\Gmail API.au3"(940,27) : warning: $fQuestion: declared, but not used in func.
    Local $aTable, $fQuestion
    ~~~~~~~~~~~~~~~~~~~~~~~~~^
C:\Users\user\Downloads\Gmail API.au3 - 0 error(s), 16 warning(s)
->23:41:53 AU3Check ended. Press F4 to jump to next error.rc:1
+>23:41:53 AutoIt3Wrapper Finished.
>Exit code: 0    Time: 1.045
 

 

 

Edited February 18, 2018 by mLipok

[Ascer]

Its' because you use a new Scite. I don't see this warrings on version 3.5.4

[mLipok]

On 19.02.2018 at 8:06 AM, Ascer said:

Its' because you use a new Scite. I don't see this warrings on version 3.5.4

No, no, it means that you still have bad habits and you do things in the wrong way.
Try a little more to fight with this.

[argumentum]

On 2/18/2018 at 5:42 PM, mLipok said:

"C:\Users\user\Downloads\Gmail API.au3"(80,18) : warning: $bQuestion: declared, but not used in func.
    Local $bQuestion

I looked at the code and the variable is used. How can I fix this ? Thanks @mLipok.

[argumentum]

On 2/12/2018 at 12:01 PM, Ascer said:

Gmail API send email

Could you show how to use CC and BCC ?. Also attachment. Thanks @Ascer.

Edited October 11, 2018 by argumentum
saw the attachment help

[BrewManNH]

42 minutes ago, argumentum said:

I looked at the code and the variable is used. How can I fix this ?

It's not used correctly, the Ternary operator doesn't return a value, so assigning it to one is pointless. Remove all variable references used with the Ternary operator anywhere you see something like this:

$bQuestion = IsArray($aEmailAdress)     ?   _TableInsert($aTable, $aEmailAdress[0])         :   _TableInsert($aTable, "")

Also remove the variable declaration because $bQuestion isn't used anywhere that it is needed.

 

Second, don't declare variables conditionally like this:

If IsArray($sRemoveLabelIds) Then
        Local $iUbound = UBound($sRemoveLabelIds)

Declare the variable, then assign something to it inside the If statements. Don't declare it twice depending on whether the If statement is valid

[argumentum]

52 minutes ago, argumentum said:

Could you show how to use CC and BCC ?.

ok, got it. Use a string, like: Local $sRecipient = "personTo@some.com" & @LF & "Bcc: personBcc@another.com" and that is it =) 

[argumentum]

19 minutes ago, BrewManNH said:

Also remove the variable declaration because $bQuestion isn't used anywhere that it is needed.

error: Statement cannot be just an expression.

I have no idea why the ternary is needed or how to go about it  =/
Would you recode that line ?, thanks @BrewManNH.

Use if/then/else

Edited October 11, 2018 by argumentum
answered my silly question

[mBild]

Great work... However, all line breaks are missing in the text body... What am I doing wrong?

[Jos]

32 minutes ago, mBild said:

Great work... However, all line breaks are missing in the text body... What am I doing wrong?

Welcome and nice to see you think we are clairvoyant.

Seriously, post what you are trying so we can see what you are doing. Might have something to do with an HTMLbody but that is guessing.

Jos 

[mBild]

21 minutes ago, Jos said:

Welcome and nice to see you think we are clairvoyant.

Seriously, post what you are trying so we can see what you are doing. Might have something to do with an HTMLbody but that is guessing.

Jos 

Many thanks for your quick reply and sorry, for being unclear.

I am using FileRead to get text (with linebreaks) from a .txt file (ANSI) to a variable. The text should then be automatically emailed using your UDF. When I output the variable in the console all works fine. If I add it as text body ($sBody) and email it, the text is all correct, however all line and paragraph breaks are missing? Am I missing something?               

Many thanks for your support... 

[Jos]

Still don't see any script so post what you have that isn't working.

[mBild]

$hFile = Fileopen($a_FileList[1][0], $FO_ANSI)
$FileContent = FileRead($hFile)
FileClose($hFile)

 

ConsoleWrite($FileContent)

--> All correct with line and paragraph breaks

 

 

; Function(s):      gmailUsersMessagesSend() -> example usage

Local $sBody = $FileContent & @CRLF 

Local $sBodyHtml = Default
Local $sAttachment = Default

---> Email is send without line and paragraph breaks

 

 

Many thanks for your help!!!

 

[mLipok]

just guessing...

Do you send $sBody or $sBodyHtml ?

 

[mBild]

Thanks for the reply.

I send $sBody, but also with $sBodyHtml there are no line and paragraph breaks in the email body?

 

Maybe I am missing something?

[Jos]

Well, I am still not seeing any runable script so have no idea as I can't test unless I am going to spend time to code it myself.

Jos

Edited October 12, 2018 by Jos