google.appengine.api.mail_stub.MailServiceStub

Python only mail service stub.

Inherits From: APIProxyStub, expected_type

google.appengine.api.mail_stub.MailServiceStub(
    host=None,
    port=25,
    user='',
    password='',
    enable_sendmail=False,
    show_mail_body=False,
    service_name='mail',
    allow_tls=True
)

host Host of SMTP server to use. Blank disables sending SMTP.
port Port of SMTP server to use.
user User to log in to SMTP server as.
password Password for SMTP server user.

Methods

Clear

View source

Clear(
    *args, **kwargs
)

CreateRPC

View source

CreateRPC()

Creates RPC object instance.

Returns
An instance of RPC.

MakeSyncCall

View source

MakeSyncCall(
    service, call, request, response, request_id=None
)

The main RPC entry point.

Args
service Must be name as provided to service_name of constructor.
call A string representing the rpc to make. Must be part of the underlying services methods and impemented by _Dynamic_<call>.
request A protocol buffer of the type corresponding to call.
response A protocol buffer of the type corresponding to call.
request_id A unique string identifying the request associated with the API call.

SetError

View source

SetError(
    error, method=None, error_rate=1
)

Set an error condition that may be raised when calls made to stub.

If a method is specified, the error will only apply to that call. The error rate is applied to the method specified or all calls if method is not set.

Args
error An instance of apiproxy_errors.Error or None for no error.
method A string representing the method that the error will affect.
error_rate a number from [0, 1] that sets the chance of the error, defaults to 1.

get_sent_messages

View source

get_sent_messages(
    *args, **kwargs
)

THREADSAFE True