Send a Single Email to a Single Recipient

[thinkingserious]

Acceptance Criteria:

• A email object that represents the response body payload
• A mail object that handles sending email objects, data validation and error handling

Reference:

• https://github.com/sendgrid/sendgrid-python/tree/master/sendgrid/helpers/mail
• https://github.com/sendgrid/sendgrid-python/blob/master/CONTRIBUTING.md
• https://sendgrid.com/docs/API_Reference/Web_API_v3/Mail/index.html

[dibyadas]

@thinkingserious I would like to work on this issue. Can you give me some pointers , on how to proceed?

[thinkingserious]

@dibyadas,

Awesome!

The first step will be to create a proposal similar to this so that the community can review and provide feedback.

Thanks!

Elmer

[dibyadas]

@thinkingserious So, I just went through links for reference given in the issue description. But I still have some doubts.
Can you help me with, what issue is this ticket addressing? And , whose response payload we are referring to and the kind of data validation we are talking about?

Thanks!

Dibya

[thinkingserious]

Hi @dibyadas,

Thank you for the follow up!

1. For the Response object, I'm referring to something like this. It's a wrapper around HTTPResponse. The idea is that we can then customize the return object for specific SendGrid functionality. For now, it should have a status_code, body and headers. Right now, we return the original object directly.

2. The data validation portion does not have to be included in this iteration. But we should plan for it. The idea is that the helper should surface API errors where possible before the message is sent.

3. For error handling please see: Improved error handling #193

At a high level, we want a request object builder that we can pass to a function that will send the email.

For the use case described in the example, I'm thinking of something along the lines of this (both cases should be possible):

import sendgrid

sg = sendgrid.SendGridClient('SENDGRID_API_KEY')

from_email = Email('Test User', 'test@example.com')
to_email = Email('Test User', 'test@example.com')
subject = 'Hello World from the SendGrid Python Library!'
plain_text_content = 'Hello, Email!'
html_content = '<strong>Hello, Email!</strong>'
msg = create_single_email(from_email, to_email, subject, plain_text_content, html_content)

response = sg.send(msg)

or

import sendgrid
from sendgrid import SendGridMessage

sg = sendgrid.SendGridClient('SENDGRID_API_KEY')

msg = SendGridMessage()
msg.from_email = Email('Test User', 'test@example.com')
msg.to_email = Email('Test User', 'test@example.com')
msg.subject = 'Hello World from the SendGrid Python Library!'
msg.plain_text_content = 'Hello, Email!'
msg.html_content = '<strong>Hello, Email!</strong>'

response = sg.send(msg)

The first case demonstrates the use of the SendGridMessage builder create_single_email which this issue addresses.

The second case demonstrates the custom building of the SendGridMessage builder to allow for more advanced usage.

[dibyadas]

@thinkingserious Thanks a lot for your informative explanation!
So what I have gathered from this is the following :-
We can define a class which will act as a wrapper around the HTTPResponse Object, as you mentioned. So instead of returning the object directly, We can have :-

......
    except timeout as e:
            raise SendGridClientError(408, 'Request timeout')
    response_obj = SendGridResponse(response.read() response.getcode(), response.getheaders())
    return response_obj
......

Here the SendGridResponse is the class that we going to add.

And for the exception handling, we can also define SendGrid custom exceptions which can more be informative than standard python exceptions.

Does this look good?

Thanks!

Regards, Dibya

[thinkingserious]

Looks good :)

Thanks @dibyadas!

[dibyadas]

@thinkingserious Once I am ready with proposed modifications, I will make a PR. 😄

Thanks!

[thinkingserious]

Awesome, thanks!

[dibyadas]

@thinkingserious I was having some problems registering an account in SendGrid. It said that my profile has been flagged as high risk. 😕 Am I doing something wrong there?
Can you help me with this?

Thanks,

Regards, Dibya

[thinkingserious]

What's your SendGrid username?