Interface: ApiEmailUserResponse
Defined in: core/emailuser.ts:19
Response of action=emailuser.
Extends
Properties
batchcomplete?
optionalbatchcomplete?:true
Defined in: envelope/index.ts:178
Present and true when all data for the current batch of pages has been
returned. Continuation may still be ongoing: the generator runs again for
the next batch of pages, and list/meta modules may continue independently.
Serialized as a real boolean under formatversion=2.
Inherited from
curtimestamp?
optionalcurtimestamp?:string
Defined in: envelope/index.ts:187
Current server time (ISO 8601), present when the request set curtimestamp.
Inherited from
emailuser
emailuser:
object
Defined in: core/emailuser.ts:21
Result of action=emailuser.
errors?
optionalerrors?:ApiMessage[] |ApiSpecMessage[]
In-band delivery errors (present when result is Failure), shaped per the request's errorformat.
result
result:
string&object|"Success"|"Failure"|"Warnings"
Whether the message was accepted, or accepted with warnings, or failed.
warnings?
optionalwarnings?:ApiMessage[] |ApiSpecMessage[]
Non-fatal messages (e.g. subject/text transformations), shaped per the request's errorformat.
errorlang?
optionalerrorlang?:string
Defined in: envelope/index.ts:199
Language error messages are rendered in (responselanginfo=1).
Inherited from
requestid?
optionalrequestid?:string
Defined in: envelope/index.ts:190
Opaque value echoed back from the request's requestid parameter.
Inherited from
servedby?
optionalservedby?:string
Defined in: envelope/index.ts:184
Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested.
Inherited from
uselang?
optionaluselang?:string
Defined in: envelope/index.ts:196
Language of the interface strings in the response (responselanginfo=1).
Inherited from
warnings?
optionalwarnings?:ApiWarnings
Defined in: envelope/index.ts:193
Non-fatal warnings; shape depends on errorformat (see ApiWarnings).