Use the add-member operation to add a new subscriber to a mailing list specified by name or ID.
A request XML packet adding a subscriber includes the add-member operation node:
<packet>
<maillist>
<add-member>
...
</add-member>
</maillist>
</packet>
The add-member node is presented by the MaillistAddMemberInputType type (maillist.xsd
), and its graphical representation is as follows:
maillist.xsd
).common.xsd
).Remarks
You can add multiple subscribers to a mailing list using different filtering rules in a single packet. Add as many add-member operations as the number of different filtering rules to be applied.
<add-member>
...
</add-member>
...
<add-member>
...
</add-member>
Important: When creating request packets, put nodes and elements in the order they follow in the packet structure.
The add-member node of the output XML packet is presented by type MaillistAddMemberOutputType (maillist.xsd
) and structured as follows:
maillist.xsd
).common.xsd
).
This request packet adds the subscriber with e-mail address mymail@mysite.com to mailing list MyMailer.
<packet>
<maillist>
<add-member>
<filter>
<list-name>MyMailer</list-name>
</filter>
<id>mymail@mysite.com</id>
</add-member>
</maillist>
</packet>
Response:
<packet>
<maillist>
<add-member>
<result>
<status>ok</status>
<filter-id>MyMailer</filter-id>
<id>mymail@mysite.com</id>
</result>
</add-member>
</maillist>
</packet>
If the mailing list was not found on the server, the response looks as follows:
<packet>
<maillist>
<add-member>
<result>
<status>error</status>
<errcode>1015</errcode>
<errtext>Mailing list does not exist</errtext>
<filter-id>MyMailer</filter-id>
</result>
</add-member>
</maillist>
</packet>
This request packet adds the subscriber with e-mail address mymail@mysite.com to mailing lists MyMailer and SubscribeMe.
<packet>
<maillist>
<add-member>
<filter>
<list-name>MyMailer</list-name>
<list-name>SubscribeMe</list-name>
</filter>
<id>mymail@mysite.com</id>
</add-member>
</maillist>
</packet>
Response:
<packet>
<maillist>
<add-member>
<result>
<status>ok</status>
<filter-id>MyMailer</filter-id>
<id>mymail@mysite.com</id>
</result>
<result>
<status>ok</status>
<filter-id>SubscribeMe</filter-id>
<id>mymail@mysite.com</id>
</result>
</add-member>
</maillist>
</packet>